CHERAB-ITER

CI/CD
Docs
Package
Meta

---

CHERAB-ITER; the CHERAB subpacakge for the ITER tokamak.

🔧 Get started for Developers

Pre-requisites

• pixi, a tool for project and package management.

If you don't have git installed, you can install it through pixi global installation:

pixi global install git

Download and Run tasks

You can clone the repository and enter the directory with:

git clone https://github.com/cherab/iter
cd iter

Then, you can run tasks with pixi like:

pixi run <task>

For example, to run the tests:

pixi run test

Any other command can be seen with:

pixi task list

🌐 Installation (future release)

You can install the package from PyPI:

pip install cherab-iter

Or from Conda:

mamba install -c conda-forge cherab-iter

📝 Documentation

The documentation will be available at Read the Docs.

📄 License

This project is licensed under the terms of the EUPL-1.1.