Installation

This software can be installed on Linux systems. Native Windows and macOS are not currently supported, but Chiltepin can be used on these platforms via the Docker container (see Docker Container).

Prerequisites

  • Python 3.10 or higher

  • Linux operating system (or Docker for Mac/Windows)

Installing from PyPI

The recommended method for users is to install Chiltepin from PyPI:

$ pip install chiltepin

You can also install in a virtual environment (recommended):

Using venv:

$ python -m venv .chiltepin
$ source .chiltepin/bin/activate
$ pip install chiltepin

Using conda:

$ conda create -n "chiltepin" python=3.10
$ conda activate chiltepin
$ pip install chiltepin

Development Installation

For development or testing, install from a git clone in editable mode:

$ git clone https://github.com/NOAA-GSL/chiltepin.git
$ cd chiltepin
$ python -m venv .chiltepin
$ source .chiltepin/bin/activate
$ pip install -e ".[test]"

Note

The [test] option installs additional dependencies required for running the test suite.

Activating the Environment

Once installed, Chiltepin can be used simply by activating the environment using the command appropriate for your environment type:

For venv:

$ source .chiltepin/bin/activate

For conda:

$ conda activate chiltepin

Dependencies

Chiltepin has the following core dependencies:

  • globus-compute-sdk (>=4.5.0,<4.7.0)

  • globus-compute-endpoint (>=4.5.0,<4.7.0)

  • parsl (>=2026.1.5)

These will be automatically installed when you install Chiltepin.