Skip to content

Installation

Environment

liulu is developed against the cosemu micromamba environment, where it is installed editable. Always prefix Python/pip with micromamba run -n cosemu:

micromamba run -n cosemu python -m pytest liulu/tests/ -v

Editable install

From the repository root:

micromamba run -n cosemu pip install -e .

The package depends on NumPy, SciPy, and (for the Hankel-transform xi(r) providers and Cosmology) Astropy.

Running the tests

# full suite
micromamba run -n cosemu python -m pytest liulu/tests/ -v

# a single file
micromamba run -n cosemu python -m pytest liulu/tests/test_los_projection.py -v

Tests live under liulu/tests/ (configured in pyproject.toml). Projection correctness is checked at \(\mu_r \in \{0, 1, 1/\sqrt2\}\) against hand-computed expectations; the integrator is checked against the linear/Kaiser limit.

Building this documentation

micromamba run -n cosemu mkdocs serve     # live preview at http://127.0.0.1:8000
micromamba run -n cosemu mkdocs build     # static site into ./site

The API reference is generated from the in-code docstrings by mkdocstrings, so it tracks the source automatically — keep docstrings current and the reference follows.

The scientific report

A companion LaTeX report (docs/streaming_model_report.tex) documents the halo-catalogue validation and the velocity-PDF study in full. Build it with:

cd docs && pdflatex streaming_model_report.tex && pdflatex streaming_model_report.tex

The figures it references live in docs/figs/ (tracked); the compiled PDF is git-ignored. A summary with figures is on the Validation page.