1. Installation Guide

1.1. Prerequisites

  • Python (recommended: 3.10+)

  • PyTorch

  • NumPy / SciPy

  • Matplotlib

Notes:

  • Some project dependencies are scientific packages that may install faster via Conda.

  • The repository root requirements.txt uses a Conda-style format (e.g. python=3.12). If you use pip, prefer installing the package itself (pip install -e .) and let pyproject.toml / your environment resolve dependencies.

1.2. Install from PyPI

The easiest way to install AI4Plasma is via pip:

pip install ai4plasma

Or upgrade to the latest version:

pip install --upgrade ai4plasma

1.3. Install from Source

git clone https://github.com/ai4plasma/ai4plasma.git
cd ai4plasma
pip install -e .

1.4. Install by Conda

If you use Conda/Mamba:

conda create -n ai4plasma python=3.12
conda activate ai4plasma
pip install -e .

1.5. Build documentation locally

The documentation is built with Sphinx + MyST.

pip install -r docs/requirements.txt
cd docs
make html

On Windows you can also use:

cd docs
make.bat html