bout_runners.parameters.bout_run_setup¶

Contains the BoutRunSetup class.

Classes

BoutRunSetup(executor, db_connector, …)

Class for setting up the BOUT++ run.

class bout_runners.parameters.bout_run_setup.BoutRunSetup(executor: Optional[bout_runners.runner.bout_run_executor.BoutRunExecutor] = None, db_connector: Optional[bout_runners.database.database_connector.DatabaseConnector] = None, final_parameters: Optional[bout_runners.parameters.final_parameters.FinalParameters] = None)[source]¶

Class for setting up the BOUT++ run.

More specifically this class will connect the executor object with the run parameters and a database to store the results in

Examples

>>> run_setup = BoutRunSetup(executor, db_connector, final_parameters)
>>> run_graph = RunGraph()
>>> run_group = RunGroup(run_graph, run_setup)
>>> runner = BoutRunner(run_graph)
>>> runner.run()

Attributes

__executorBoutRunExecutor: Getter variable for executor
__db_connectorDatabaseConnector: Getter variable for db_connector
__final_parametersFinalParameters: Getter variable for final_parameters
__db_creatorDatabaseCreator: Object used to create the database
__metadata_recorderMetadataRecorder: Object used to record the metadata about a run
executorBoutRunExecutor: Get the properties of self.executor.
bout_pathsBoutPaths: Return the BoutPaths.
db_connectorDatabaseConnector: Get the properties of self.db_connector.
final_parametersFinalParameters: Get the properties of self.final_parameters.
metadata_recorderMetadataRecorder: Get the properties of self.metadata_recorder.
submitterAbstractSubmitter: Return the AbstractSubmitter.

Methods

__create_schema()

Create the schema

Set the member data.

This constructor will also create the schema if it does not exist.

Parameters

executorBoutRunExecutor or None: Object executing the run If None, default parameters will be used
db_connectorDatabaseConnector or None: The connection to the database If None: Default database connector will be used
final_parametersFinalParameters or None: The object containing the parameters which are going to be used in the run If None, default parameters will be used

Attributes

bout_paths: Return the BoutPaths.
db_connector: Get the properties of self.db_connector.
executor: Get the properties of self.executor.
final_parameters: Get the properties of self.final_parameters.
metadata_recorder: Get the properties of self.metadata_recorder.
submitter: Return the AbstractSubmitter.

property bout_paths¶

Return the BoutPaths.

Returns

BoutPaths: The BoutPaths

property db_connector¶

Get the properties of self.db_connector.

Returns

self.__db_connectorDatabaseConnector: The object holding the database connection

property executor¶

Get the properties of self.executor.

Returns

self.__executorBoutRunExecutor: The executor object

property final_parameters¶

Get the properties of self.final_parameters.

Returns

self.__final_parametersFinalParameters: The object containing the parameters used in the run

property metadata_recorder¶

Get the properties of self.metadata_recorder.

Returns

self.__metadata_recorderMetadataRecorder: The object holding the metadata recorder

property submitter¶

Return the AbstractSubmitter.

Returns

AbstractSubmitter: The submitter which will be used for submitting the job