Package prompt :: Module dasha :: Class Dasha
[hide private]
[frames] | no frames]

Class Dasha

source code

Instance Methods [hide private]
 
__init__(self, relax) source code
 
create(self, run=None, algor='LM', dir=None, force=0)
Function for creating the Dasha script.
source code
 
execute(self, run=None, dir=None, force=0)
Function for executing Dasha.
source code
 
extract(self, run=None, dir=None)
Function for extracting data from the Dasha results file.
source code
Method Details [hide private]

create(self, run=None, algor='LM', dir=None, force=0)

source code 
Function for creating the Dasha script.

Keyword Arguments
~~~~~~~~~~~~~~~~~

run:  The name of the run.

algor:  The minimisation algorithm.

dir:  The directory to place the files.  The default is the value of 'run'.

force:  A flag which if set to 1 will cause the results file to be overwritten if it already
exists.


Description
~~~~~~~~~~~

The script file created is called 'dir/dasha_script'.


Optimisation algorithms
~~~~~~~~~~~~~~~~~~~~~~~

The two minimisation algorithms within Dasha are accessible through the algor argument which
can be set to:

    'LM' - The Levenberg-Marquardt algorithm.
    'NR' - Newton-Raphson algorithm.

For Levenberg-Marquardt minisation, the function 'lmin' will be called, while for Newton
-Raphson, the function 'min' will be executed.

execute(self, run=None, dir=None, force=0)

source code 
Function for executing Dasha.

Keyword Arguments
~~~~~~~~~~~~~~~~~

run:  The name of the run.

dir:  The directory to place the files.  The default is the value of 'run'.

force:  A flag which if set to 1 will cause the results file to be overwritten if it already
exists.


Execution
~~~~~~~~~

Dasha will be executed as

$ dasha < dasha_script | tee dasha_results

extract(self, run=None, dir=None)

source code 
Function for extracting data from the Dasha results file.

Keyword Arguments
~~~~~~~~~~~~~~~~~

run:  The name of the run.

dir:  The directory where the file 'dasha_results' is found.  The default is the value of 'run'.