Installation

pycrires is compatible with Python versions 3.9/3.10/3.11 and is available from PyPI and Github.

Installation from PyPI

The Python package can be installed from PyPI with the pip package manager:

$ pip install pycrires

Or, to update to the most recent version:

$ pip install --upgrade pycrires

Installation from Github

Using pip

Installation from Github is also possible with pip:

$ pip install git+https://github.com/tomasstolker/pycrires.git

The Github version is most up to date since it contains the latest implementations that may not yet have been included in the official release.

Cloning the repository

Alternatively, in case you want to look into the code, it is best to clone the repository:

$ git clone https://github.com/tomasstolker/pycrires.git

Then, the package is installed by running pip in the local repository folder:

$ pip install -e .

New commits can be pulled from Github once a local copy of the repository exists:

$ git pull origin main

Do you want to make changes to the code? Please fork the pycrires repository on the Github page and clone your own fork instead of the main repository. Contributions in the form of pull requests are welcome (see About section).

EsoRex

In addition to pycrires, it is required to manually install EsoRex, the CRIRES+ recipes, and the Molecfit recipes. There are recipes available for both the old and upgraded CRIRES instrument so it is important to follow the instructions for CR2RES instead of CRIRES. On macOS, it is most convenient to use MacPorts for installing both EsoRex and the recipes.

Testing pycrires

The installation can now be tested, for example by starting Python in interactive mode and creating an instance of the Pipeline:

>>> import pycrires
>>> pipeline = pycrires.Pipeline()