API Documentation¶

The API documentation of bout_runners follows.

Note

The filenames below are clickable

BOUT Runners¶

`bout_runners`	Package managing your BOUT++ runs through python.
`bout_runners.config`	Package containing configuration files.
`bout_runners.database`	Package containing the database modules.
`bout_runners.database.database_connector`	Module containing the DatabaseBase class.
`bout_runners.database.database_creator`	Module containing the DatabaseCreator class.
`bout_runners.database.database_reader`	Module containing the DatabaseReader class.
`bout_runners.database.database_utils`	Module containing database utils.
`bout_runners.database.database_writer`	Module containing the DatabaseWriter class.
`bout_runners.executor`	Package containing executor modules.
`bout_runners.executor.bout_paths`	Contains the class setting the BOUT++ paths.
`bout_runners.executor.executor`	Contains the executor class.
`bout_runners.log`	Package containing the read log modules.
`bout_runners.log.log_reader`	Module containing the LogReader class.
`bout_runners.make`	Package containing make modules.
`bout_runners.make.make`	Module containing the MakeProject class.
`bout_runners.make.read_makefile`	Module containing the classes to read the makefile.
`bout_runners.metadata`	Package containing the metadata modules.
`bout_runners.metadata.metadata_reader`	Module containing the MetadataReader class.
`bout_runners.metadata.metadata_recorder`	Module containing the MetadataRecorder class.
`bout_runners.metadata.metadata_updater`	Module containing the MetadataUpdater class.
`bout_runners.metadata.status_checker`	Module containing the StatusChecker class.
`bout_runners.parameters`	Package containing the parameter modules.
`bout_runners.parameters.default_parameters`	Contains the class dealing with the default parameters.
`bout_runners.parameters.final_parameters`	Contains the class dealing with the final parameters.
`bout_runners.parameters.run_parameters`	Contains the class dealing with the run parameters.
`bout_runners.runner`	Package containing runner modules.
`bout_runners.runner.bout_runner`	Contains the BOUT runner class.
`bout_runners.submitter`	Package containing the submitter modules.
`bout_runners.submitter.abstract_submitter`	Contains the abstract submitter class.
`bout_runners.submitter.local_submitter`	Contains the local submitter class.
`bout_runners.submitter.processor_split`	Contains the processor split class.
`bout_runners.submitter.submitter_factory`	Contains the submitter factory.
`bout_runners.utils`	Package containing utils modules.
`bout_runners.utils.file_operations`	Module containing file operation functions.
`bout_runners.utils.logs`	Contains methods which deals with logging.
`bout_runners.utils.names`	Module containing functions to extract names.
`bout_runners.utils.paths`	Contains methods which return common paths.