Skip to content
Projects

Installation

Create and activate a Python environment:

Terminal window
python -m venv env
source env/bin/activate
pip install --upgrade pip

Install the package and its requirements with pip:

Terminal window
pip install -e .

Check it with:

Terminal window
python -c "import mhd_sandbox; print(mhd_sandbox.__version__)"

The tutorials also need Matplotlib and Jupyter, which the docs extra installs.

ExtraInstalls
testpytest and coverage
docsMatplotlib, the notebook runner and griffe for the API reference
devformatters and linters, plus the test and docs extras
Terminal window
pip install -e ".[dev]"