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 .
ExtraInstalls
neutralizerwellbalanced, for beamtracer.neutralizer
examplesmatplotlib, plotly and plasma-plots, for the examples’ figures
testpytest, coverage, pyccel and the neutralizer extra
docsthe notebook runner and griffe for the API reference
devformatters and linters, plus the docs, examples and test extras
Terminal window
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.