Skip to content

Installation

halocat is a standard PEP 621 Python package. It is intended to run inside the cosemu micromamba environment on COSMA, where the heavy upstream dependencies (pycorr, Corrfunc, julia, PairVel.jl) are already provided.

1. Activate the environment

micromamba activate cosemu

2. Install the package in editable mode

From the repository root:

pip install -e .

This installs halocat and the halocat console-script entry point.

3. External dependencies (not on PyPI)

Two upstream pieces are not pulled in by pip install -e .:

  • PairVel.jl — Julia package consumed via the pairvel Python wrapper at /cosma8/data/dp203/dc-ruan1/pairvel/python (auto-prepended to sys.path by halocat.velocity).
  • pycorr — installed inside cosemu already.

Both are required by the velocity-moments and xi_hh stages respectively.

4. Optional: building the docs

The site you are reading is built with mkdocs-material and mkdocstrings (Python handler). Install them once:

pip install --user mkdocs-material 'mkdocstrings[python]'

Then, from the repository root:

mkdocs serve   # live-reloading dev server on http://127.0.0.1:8000
mkdocs build   # static site under ./site

5. Verify the install

python3 -c "import halocat; print(halocat.__version__)"
halocat --help