Getting Started for Users#
Warning
The following guide is for users. If you want to contribute to ctapipe as a developer, see Getting Started for Developers.
Installation#
How To Get the Latest Version#
We recommend using the mamba
package manager, which is a C++ reimplementation of conda
.
It can be found here.
To install ctapipe
into an existing conda environment, use:
$ mamba install -c conda-forge ctapipe
You can also directly create a new environment like this (add more packages as you like):
$ mamba create -n ctapipe -c conda-forge python ctapipe
or with pip:
$ pip install ctapipe
ctapipe
has a number of optional dependencies that are not automatically installed
when just installing ctapipe
.
These are:
matplotlib for visualization, used in
visualization
and several other places.eventio used for reading
sim_telarray
files inSimTelEventSource
.
You can install them individually, or if you just want to get ctapipe
with all optional dependencies, use:
$ pip install 'ctapipe[all]'
The conda
package ctapipe
includes all optional dependencies, if you want to install
a minimal version of ctapipe
only including required dependencies, you can use the
ctapipe-base
package:
$ mamba install -c conda-forge ctapipe-base
How To Get a Specific Version#
To install a specific version of ctapipe
you can use the following command:
$ mamba install -c conda-forge ctapipe=0.17.0
or with pip:
$ pip install ctapipe==0.17.0