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¶
2. Install the package in editable mode¶
From the repository root:
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
pairvelPython wrapper at/cosma8/data/dp203/dc-ruan1/pairvel/python(auto-prepended tosys.pathbyhalocat.velocity). - pycorr — installed inside
cosemualready.
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:
Then, from the repository root:
mkdocs serve # live-reloading dev server on http://127.0.0.1:8000
mkdocs build # static site under ./site