bin.examplecase_class.examplecase Class Reference

Public Member Functions
def	__init__ (self)
def	prepare_examples (self, parname)
def	copy_scripts (self, parname, rundir)
def	__repr__ (self)

Private Member Functions
def	__link_lit (self, string, link)

Private Attributes
	__ex_script_dir
	__path_examples
	__script_folder
	__example_pars

Detailed Description

Definition at line 22 of file examplecase_class.py.

Constructor & Destructor Documentation

__init__()

def bin.examplecase_class.examplecase.__init__

(

self

)

   Initialize the examplecase class. This class prepares example runs,
   e.g., creates trajectories from other scripts and copies plotting routines
   to the example run folder.

Definition at line 23 of file examplecase_class.py.

Member Function Documentation

__link_lit()

def bin.examplecase_class.examplecase.__link_lit (   self,   string,   link  )

private

  Create a colored hyperlink in the terminal

Definition at line 210 of file examplecase_class.py.

__repr__()

def bin.examplecase_class.examplecase.__repr__

(

self

)

  Representative text for the examples

Definition at line 217 of file examplecase_class.py.

Here is the call graph for this function:

copy_scripts()

def bin.examplecase_class.examplecase.copy_scripts	(		self,
			parname,
			rundir
	)

  Copy plotting routines to the run folders.

Definition at line 185 of file examplecase_class.py.

prepare_examples()

def bin.examplecase_class.examplecase.prepare_examples	(		self,
			parname
	)

  Prepare the simulation before any runfolder exists.

Definition at line 63 of file examplecase_class.py.

Member Data Documentation

__ex_script_dir

bin.examplecase_class.examplecase.__ex_script_dir

private

Definition at line 30 of file examplecase_class.py.

__example_pars

bin.examplecase_class.examplecase.__example_pars

private

Definition at line 34 of file examplecase_class.py.

__path_examples

bin.examplecase_class.examplecase.__path_examples

private

Definition at line 31 of file examplecase_class.py.

__script_folder

bin.examplecase_class.examplecase.__script_folder

private

Definition at line 32 of file examplecase_class.py.