Welcome to the CHERAB project.
Please see our documentation for guidance on using the code.
CHERAB is a large code framework consisting of a core package and feature packages. Users will generally install the core package and the specific feature packages they need for their work. For example, users working on the JET tokamak will require the cherab-core package, the cherab-jet package and an atomic data source such as cherab-openadas.
Unless developing new code for a cherab package, most users should clone the master branch. When developing new features for cherab, the development branch should be used as the base.
All cherab packages are standard python packages and basic installation is achieved with:
python setup.py install
This will compile the CHERAB cython extensions and install the package. If you don't have administrator access to install the package, add the --user flag to the above line to install the package under your own user account.
When developing cherab it is usually preferred that the packages be installed in "develop" mode:
python setup.py develop
This will cause the original installation folder to be added to the site-package path. Modifications to the code will therefore be visible to python next time the code is imported. The --user flag should be used if you do not have administrative permission for your python installation.
As all the CHERAB packages are dependent on the cherab-core package, this package must be installed first. Note that other packages may have their own inter-dependencies, see the specific package documentation for more information.
- Dr Carine Giroud, Dr Alex Meakins, Dr Matthew Carr, Dr Alfonso Baciero, & Mr Corentin Bertrand. (2018, March 23). CHERAB Spectroscopy Modelling Framework (Version v0.1.0). Zenodo. http://doi.org/10.5281/zenodo.1206142