Installation Guide¶
This version of TransitionListener should be run inside the dedicated conda environment, which bundles the required dependencies (including the PTArcade toolkit). Follow the instructions below to create and activate the environment on your system.
Installation Instructions¶
Create the environment using conda-forge. The command installs Python 3.10 together with the packages TransitionListener depends on on a Linux machine:
conda create -n TL -c conda-forge python=3.10 ptarcade ultranest tqdm corner getdist mpi4py
If you are working on macOS, use instead
conda create -n TL --platform osx-64 -c conda-forge python=3.10 ptarcade ultranest tqdm corner getdist mpi4py
Once the environment is created, activate it before installing TransitionListener:
conda activate TL
Now, clone the TransitionListener repository from GitHub if you haven’t already:
git clone https://github.com/tasicarl/TransitionListener.git
Now, install TransitionListener using pip. Navigate to the root folder of TransitionListener and run:
pip install .
Alternatively, you can install TransitionListener directly from the GitHub repository using:
pip install git+https://github.com/carlotasillo/TransitionListener.git
Verifying the Installation¶
To verify that TransitionListener is installed correctly, you can run the following command in your terminal:
python -c "import transitionlistener; print(transitionlistener.__version__)"
You can also check that the command line interface is working by running:
tl --help
This should display the help message for the tl command line tool, confirming that TransitionListener is installed and ready to use.
If you encounter any issues during installation, please feel free to reach out via the GitHub issues page at https://github.com/tasicarl/TransitionListener/issues!