Installation
============

Chiltepin is developed and tested on **Linux**. macOS is supported for task submission and
data transfer, but endpoint management is Linux-only. **Windows is not supported** due to
Chiltepin's and Parsl's reliance on fork-based multiprocessing.

.. tip::
   **macOS users:** You can install and use Chiltepin for task submission and data
   transfer. **Windows users:** Native Windows is not supported; to use Chiltepin, run it
   inside the Docker container or under WSL2 with a Linux distribution (see :doc:`container`).

.. warning::
   **Windows is not supported.** Chiltepin's use of Parsl requires fork-based multiprocessing which
   is not available on Windows. Use the Docker container or WSL2 with a Linux distribution.

Prerequisites
-------------

* Python 3.10 or higher
* Linux (required for endpoint management features)
* macOS (supported for task submission and data transfer only)

Installing from PyPI
--------------------

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

.. code-block:: console

   $ pip install chiltepin

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

**Using venv:**

.. code-block:: console

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

**Using conda:**

.. code-block:: console

   $ 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:

.. code-block:: console

   $ 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:**

.. code-block:: console

   $ source .chiltepin/bin/activate

**For conda:**

.. code-block:: console

   $ conda activate chiltepin

Dependencies
------------

Chiltepin has the following core dependencies:

* ``globus-compute-sdk`` (>=4.3.0,<4.7.0)
* ``globus-compute-endpoint`` (>=4.3.0,<4.7.0) - **Linux only**
* ``globus-sdk``
* ``parsl`` (>=2025.12.1)
* ``psutil``
* ``pyyaml``

These will be automatically installed when you install Chiltepin.

.. note::
   ``globus-compute-endpoint`` is only available on Linux. On macOS, Chiltepin
   will be installed without endpoint management features (task submission and data
   transfer still work). Windows is not supported natively; use Docker or WSL2 with
   a Linux distribution.