Skip to main content

Cherab spectroscopy framework

Project description

DOI Build Status

Cherab

Welcome to the Cherab project.

Please see our documentation for guidance on using the code.

Installation

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, and the cherab-jet package.

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:

pip install cherab

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. Alternatively, consider creating a virtual environment and installing cherab in the environment.

When developing cherab it is usually preferred that the packages be installed in "editable" mode. Clone this repository and change directory to the root of the repository, then run:

pip install -e .

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. A virtual environment or the --user flag should be used if you do not have administrative permission for your python installation. If you make any changes to Cython files you will need to run ./dev/build.sh to rebuild the relevant files.

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.

Cherab is organised as a namespace package, where each of the submodules is installed in the same location as the core package. Any submodules using Cython with a build-time dependency on Cherab need to use a Cython version newer than 3.0a5, due to a bug in how earlier versions of Cython handle namespaces.

By default, pip will install from wheel archives on PyPI. If a binary wheel is not available for your version of Python, or if you are installing in editable mode for development, the package will be compiled locally on your machine. Compilation is done in parallel by default, using all available processors, but can be overridden by setting the environment variable CHERAB_NCPU to the number of processors to use.

Governance

The management of the project is divided into Scientific and Technical Project Management. The Scientific management happens through the normal community routes such as JET and MST1 task force meetings, ITPA meetings, etc.

The Technical Management Committee (TMC) is a smaller subset of the community, being responsible for ensuring the integrity and high code quality of Cherab is maintained. These TMC members would have in-depth knowledge of the code base through a demonstrated history of contributing to the project. The TMC would primarily be responsible for accepting / rejecting merge requests on the basis of code / physics algorithm quality standards.

TMC Members

  • Alys Brett (chairwoman, master account holder, responsible for delegation, UKAEA, UK)
  • Matt Carr (External consultant, diagnostic physics models)
  • Jack Lovell (Oak Ridge, USA)
  • Alex Meakins (External consultant, Architecture, software integrity)
  • Vlad Neverov (NRC Kurchatov Institute, Moscow)
  • Matej Tomes (Compass, IPP, Prague)

Citing The Code

  • 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cherab-1.5.0.tar.gz (22.8 MB view details)

Uploaded Source

Built Distributions

cherab-1.5.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (51.6 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

cherab-1.5.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (52.4 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

cherab-1.5.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (49.0 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.17+ x86-64

cherab-1.5.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (45.8 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.12+ x86-64manylinux: glibc 2.5+ x86-64

cherab-1.5.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (51.9 MB view details)

Uploaded CPython 3.8manylinux: glibc 2.12+ x86-64manylinux: glibc 2.5+ x86-64

cherab-1.5.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (43.0 MB view details)

Uploaded CPython 3.7mmanylinux: glibc 2.12+ x86-64manylinux: glibc 2.5+ x86-64

File details

Details for the file cherab-1.5.0.tar.gz.

File metadata

  • Download URL: cherab-1.5.0.tar.gz
  • Upload date:
  • Size: 22.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.21.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for cherab-1.5.0.tar.gz
Algorithm Hash digest
SHA256 e6b8928f6911b607851d946abf2f1e71628269504cf028e50fb74c8a94c86600
MD5 dd8e504d05ed8a7ef07314af2e7234c9
BLAKE2b-256 379bac3baa8ae6d310979f8817fdb6d38b101523601854f59a7b8614f550b1c9

See more details on using hashes here.

File details

Details for the file cherab-1.5.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for cherab-1.5.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 63623e631a1255cf676df4d4a0cf4af20bbb06ba9097b991a0cf48d6caf98d20
MD5 5cf4e261da7a0d75b99266a480e417fd
BLAKE2b-256 e6bd5b917fe5acf46e9c38b892ca5c35f3c3946abe81375606b5fe2b00d2af0a

See more details on using hashes here.

File details

Details for the file cherab-1.5.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for cherab-1.5.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 10cd9332040c606c9b54ebee1ee84c5d76da7bc5f468c23b8d99af656a082269
MD5 a5ca6311d211f208217e9116fecca564
BLAKE2b-256 0da891a7bf234eb0580b4b76dbddf9efd666193d732448ac5604380abde8f874

See more details on using hashes here.

File details

Details for the file cherab-1.5.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for cherab-1.5.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 426e47b6afb711c409447e1ba8578e9d255c3a7d59fa9de8c7a039d7ccb12580
MD5 c195fe1ea7a71a51b9f940fe31819740
BLAKE2b-256 77a36b56e7a50ce62a9e8ed04eba63fda9244ed1ec67c89658e5c8ed05d03618

See more details on using hashes here.

File details

Details for the file cherab-1.5.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl.

File metadata

File hashes

Hashes for cherab-1.5.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 c9aa0f7012ecab6a03ef4a13328abc8a2fb0a556a17c1c3d3891325f7917c84b
MD5 83ce307f53ebebb7a06429fa791bd260
BLAKE2b-256 853a37bf7d06000bee36f8b53bbd5a7a9f06d4edcad0aefc0b92e6d555cd23bc

See more details on using hashes here.

File details

Details for the file cherab-1.5.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl.

File metadata

File hashes

Hashes for cherab-1.5.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 37a68d288ee14264163733429cbe62db9ad77be0342a5e74ed2d583ccebf49ac
MD5 89009c3891b425c02b79344f3325f580
BLAKE2b-256 871e45d1339fc160e74fd5191f6fd4e549f6fb6548fa6493a256bc01a36c2eab

See more details on using hashes here.

File details

Details for the file cherab-1.5.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl.

File metadata

File hashes

Hashes for cherab-1.5.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 46769e1ff0dae490edc350c7a9ea64a7fd0100ea9ca610aadb2df6017f4bed1b
MD5 ba49ac28d828fe4b616b14fe365e53d8
BLAKE2b-256 f3f9d0e3fe6d82b1bb69f743467847999479ce8484e750df10d41e8a48231fc2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page