ps_eor documentation#
ps_eor provides data containers, quality-control tools, power-spectrum
estimators, observation simulations, and signal-separation methods for
low-frequency interferometric 21-cm analyses.
The documentation is divided into four complementary sections:
- Getting started
Installation instructions for the core package, the optional ML-GPR dependencies, and UltraNest, together with simple import checks.
- User guides
Topic-based explanations and examples for common package usage, including data handling, power spectra, foreground separation, ML-GPR, simulations, and spherical analysis. Each topic can be read independently.
- Command-line tools
Practical help for the
pstoolcommands. These pages describe each command’s purpose, input and output files, important options, and example invocations.- API reference
The complete Python reference organized by module, with the available classes, functions, methods, parameters, and return values.
Each section can be used independently: the user guide explains package
features, the command-line section covers pstool, and the API reference
provides the exact Python interface.
Getting started
User guides
Command-line tools
API reference