MPCDAnalysis.Run.Run Class Reference

Classes
class	RunState

Public Member Functions
def	__init__ (self, rundir, pathTranslatorsServerToLocal=[])
def	getPath (self)
def	getIdentifier (self)
def	getState (self)
def	hasParentRun (self)
def	getJobBatchSize (self)
def	getConfiguration (self)
def	getNumberOfCompletedSweeps (self)

Public Attributes
	rundir
	pathTranslatorsServerToLocal
	config

Detailed Description

Represents a run of OpenMPCD, and its results.

Definition at line 10 of file Run.py.

Constructor & Destructor Documentation

__init__()

def MPCDAnalysis.Run.Run.__init__	(		self,
			rundir,
			pathTranslatorsServerToLocal = []
	)

    The constructor.

    @param[in] rundir
               The directory the run is saved in.
    @param[in] pathTranslatorsServerToLocal
               A list of functions that translate server paths to local
               ones.

Definition at line 46 of file Run.py.

Member Function Documentation

getConfiguration()

def MPCDAnalysis.Run.Run.getConfiguration

(

self

)

    Returns the configuration instance for this run.

Definition at line 151 of file Run.py.

getIdentifier()

def MPCDAnalysis.Run.Run.getIdentifier

(

self

)

    Returns a string that can be used to identify this particular run.

    @throw Exception Throws if `self.getState() != self.RunState.Completed`.

Definition at line 70 of file Run.py.

getJobBatchSize()

def MPCDAnalysis.Run.Run.getJobBatchSize

(

self

)

    Returns the number of runs that run in parallel on this job.

Definition at line 132 of file Run.py.

getNumberOfCompletedSweeps()

def MPCDAnalysis.Run.Run.getNumberOfCompletedSweeps

(

self

)

    Returns the number of sweeps that have been performed after the warmup
    phase, as configured in `mpc.warmupSteps`, or `0` if the run has not
    yet completed.

Definition at line 165 of file Run.py.

getPath()

def MPCDAnalysis.Run.Run.getPath

(

self

)

    Returns the rundir path.

Definition at line 59 of file Run.py.

getState()

def MPCDAnalysis.Run.Run.getState

(

self

)

    Returns the run state as an instance of `RunState`.

Definition at line 90 of file Run.py.

hasParentRun()

def MPCDAnalysis.Run.Run.hasParentRun

(

self

)

    Returns whether this run has been executed by a job script in another
    run.

Definition at line 121 of file Run.py.

---

The documentation for this class was generated from the following file:

• Run.py