Installation

Note

CTLearn Optimizer supports Linux and MacOS, this is subject to the Ray package compability.

1. Install CTLearn by following the Readme.md hosted on the project’s Github repository. This will create a new conda environment named ctlearn (by default).

Warning

Currently, only CTLearn v0.3.0. is supported. Newer versions support is planned for the future.

  1. Clone this repository with Git:

cd </installation/path>
git clone https://github.com/ctlearn-project/ctlearn_optimizer.git

Now, activate the conda environment created in the first step:

conda activate ctlearn

  1. Install the dependencies for CTLearn Optimizer inside the environment:

conda env update --file </installation/path>/environment.yml

Note

Optional: install the dependencies for building the CTLearn Optimizer’s documentation from the source.

conda env update --file </installation/path>/docs_environment.yml

  1. Finally, install CTLearn Optimizer into the conda environment with pip:

cd </installation/path>/ctlearn_optimizer
pip install --upgrade .