diff --git a/README.md b/README.md index 69e076d8..3065b391 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,12 @@ to the above line to install the package under your own user account. Alternatively, consider creating a [virtual environment](https://docs.python.org/3/tutorial/venv.html) and installing `cherab` in the environment. +Cherab can also be installed with conda from the conda-forge channel: + +```sh +conda install --channel conda-forge cherab +``` + 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: diff --git a/docs/source/installation_and_structure.rst b/docs/source/installation_and_structure.rst index e9c051bf..94838d8e 100644 --- a/docs/source/installation_and_structure.rst +++ b/docs/source/installation_and_structure.rst @@ -61,7 +61,7 @@ Installation Users will generally just 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 `_ package and the `cherab-jet `_ -package. The core ``cherab`` package is available through pip. The additional fusion specific +package. The core ``cherab`` package is available through pip and conda. The additional fusion specific packages, offering extra functionality, should be cloned from their respective repositories. @@ -89,6 +89,20 @@ default, using all available processors, but can be overridden by setting the en ``CHERAB_NCPU`` to the number of processors to use. +Installing through conda +^^^^^^^^^^^^^^^^^^^^^^^^ + +Pre-built Cherab packages are available from the +`conda-forge channel `_ for Linux and macOS. +To install Cherab with conda, run:: + + conda install --channel conda-forge cherab + +This installs Cherab and its dependencies, including Raysect, without requiring +a local compiler. The OpenADAS module is included, but its atomic data files must +be downloaded separately as described in `Configuring Atomic Data`_ below. + + Installing from source ^^^^^^^^^^^^^^^^^^^^^^