bout-runners 2.0.0b0

Overview

BOUT Runners is a package to manage and orchestrate your BOUT++ runs. More specifically it’s a tool:

• That automatically makes your project

• Where you can override default parameters, and parameters found in BOUT.inp

• Where you can submit a single run, or even a chain of runs either locally, or to a cluster

• That automatically stores parameters and other metadata in a database (inspired by sacred)

• Logs the entire process

Read the full documentation at ReadTheDocs

Getting Started

The simplest way to use BOUT Runners is by executing the following script in the root of your project directory (usually where your Makefile resides). In this example we are using BOUT-dev/examples/conduction as the root

from bout_runners.runner.bout_runner import BoutRunner
BoutRunner().run()

The metadata from all the runs from this project can be found by executing

from bout_runners.metadata.status_checker import StatusChecker
status_checker = StatusChecker()
status_checker.check_and_update_status()
from bout_runners.metadata.metadata_reader import MetadataReader
metadata_reader = MetadataReader()
metadata = metadata_reader.get_all_metadata()

The metadata variable is a DataFrame, and contains the following table

Prerequisites

• Python (versions above 3.6 are supported)

• BOUT++, which can installed as stated in the manual, or by using bout_install

Installing

The package can be installed from pip

pip install bout-runners

Or from source

python setup.py install

After installation you can optionally call

bout_runners_config

in order to setup the path to your BOUT++ installation and to configure other parameters like logging.

Running the tests

The test suite can be executed through pytest or through codecov pytest-cov. Installation through

pip install pytest

or

pip install codecov pytest-cov

and run with

pytest

or

pytest --cov=./

respectively

Contributing

Please read CONTRIBUTING.rst for details about how to contribute.

Authors

• Michael Løiten - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU LESSER GENERAL PUBLIC LICENSE - see the LICENSE file for details

Acknowledgments

• The BOUT++ team for fast and accurate response on the BOUT++ issue tracker and slack-channel