Installation
Create and activate a Python environment:
python -m venv envsource env/bin/activatepip install --upgrade pipInstall the package and its requirements with pip:
pip install -e .Optional extras
Section titled “Optional extras”| Extra | Installs |
|---|---|
neutralizer | wellbalanced, for beamtracer.neutralizer |
examples | matplotlib, plotly and plasma-plots, for the examples’ figures |
test | pytest, coverage, pyccel and the neutralizer extra |
docs | the notebook runner and griffe for the API reference |
dev | formatters and linters, plus the docs, examples and test extras |
pip install -e ".[dev]"The kernels are compiled with Pyccel on first use and cached in ~/.cache/beamtracer/kernels
(or BEAMTRACER_KERNEL_CACHE); without Pyccel the NumPy versions run.