Skip to content

Latest commit

 

History

History
87 lines (71 loc) · 4.17 KB

README.rst

File metadata and controls

87 lines (71 loc) · 4.17 KB

ctapipe Test Status codacy coverage conda doilatest

Low-level data processing pipeline software for CTA (the Cherenkov Telescope Array)

This is code is a prototype data processing framework and is under rapid development. It is not recommended for production use unless you are an expert or developer!

Citing this software

If you use this software for a publication, please cite the proper version using the following DOIs:

  • v0.14.0 : doiv014
  • v0.13.0 : doiv013
  • v0.12.0 : doiv012
  • v0.11.0 : doiv011
  • v0.10.5 : doiv010
  • v0.9.1 : doiv09
  • v0.8.0 : doiv08
  • v0.7.0 : doiv07

Installation for Users

ctapipe and its dependencies may be installed using the Anaconda or Miniconda package system. We recommend creating a conda virtual environment first, to isolate the installed version and dependencies from your master environment (this is optional).

The following command will set up a conda virtual environment, add the necessary package channels, and install ctapipe specified version and its dependencies:

CTAPIPE_VER=0.14.0
wget https://raw.githubusercontent.com/cta-observatory/ctapipe/v$CTAPIPE_VER/environment.yml
conda env create -n cta -f environment.yml
conda activate cta
conda install -c conda-forge ctapipe=$CTAPIPE_VER

Note: this environment contains many useful packages that are not strictly requirements of ctapipe. To get only ctapipe and its direct dependencies, just do conda install -c conda-forge ctapipe[=<version>] in an environment of your choice.

Note: If you encounter long Solving environment times with conda, try using mamba (https://github.com/mamba-org/mamba) instead.

The file environment.yml can be found in this repo. Note this is pre-alpha software and is not yet stable enough for end-users (expect large API changes until the first stable 1.0 release).

Developers should follow the development install instructions found in the documentation.