🚀 Get Started¶

This page gives a quick overview of how to get started with cherab-inversion, including installation instructions and a simple example script.

Installation¶

cherab-inversion can be installed by many package managers. Explore the various methods below to install cherab-inversion using your preferred package manager.

pip conda uv pixi

pip install cherab-inversion

conda install -c conda-forge cherab-inversion

uv add cherab-inversion

pixi add cherab-inversion

Quick Start¶

Here’s a minimal example to get you started:

from cherab.inversion import SVD, Lcurve

# Your example code here

For more detailed examples, check the Examples section.

Notebooks¶

We also have a collection of Jupyter notebooks that demonstrate various features of cherab-inversion, which are same as the ones in the Examples section. You can explore these notebooks to see how to use cherab-inversion in practice. To get started with the notebooks locally, you can clone the repository and launch JupyterLab. pixi makes it easy to set up the environment and launch JupyterLab with all dependencies installed.

git clone https://github.com/munechika-koyo/cherab_inversion
cd cherab_inversion
pixi run lab

Citations¶

If you use cherab-inversion in your research, please cite the doi:10.5281/zenodo.10118752.