Installation

POTPyRI requires Python 3.11 or later. For full platform notes (conda, Apple Silicon, etc.) and the environment.yml-based workflow, see the main README in the repository root.

From PyPI

pip install potpyri

From source (development)

  1. Clone the repository:

git clone https://github.com/CIERA-Transients/POTPyRI
cd POTPyRI

  1. Create and activate a virtual environment (conda or venv). Python 3.12 is recommended.

 conda create -n potpyri python=3.12
 conda activate potpyri

# Or with venv:
# python3.12 -m venv .venv && source .venv/bin/activate  # Linux/macOS

  1. Install in editable mode with optional dependencies:

pip install -e .              # core package
pip install -e ".[test]"      # add pytest, pytest-cov for testing
pip install -e ".[docs]"      # add Sphinx and theme for building docs

The -e (editable) flag uses the current directory as the live source, so changes are picked up without reinstalling.

Non-Python dependencies

The pipeline uses astrometry.net and Source Extractor (SExtractor). Install them via your system package manager or conda (see the main README for a platform table). Index files for astrometry.net (~59 GB) can be installed with the download_anet_index script after astrometry.net is on your path.

Testing

From the project root with .[test] installed:

  • Unit tests only (no network): pytest tests -m "not integration" — skips the five integration tests that download fixtures. This is what CI runs.

  • All tests: pytest tests — requires network access for fixture downloads.

Building the documentation

With .[docs] installed, from the project root:

cd docs && make html

Output is in docs/build/html/. On Windows use make.bat html. The live API docs are published at https://ciera-transients.github.io/POTPyRI/; see docs/DEPLOY.md for deployment setup.