Dependencies

Dependencies#

The acm package builds upon many excellent open-source projects. Below is a list of the key dependencies:

Core Dependencies#

Required Packages#

  • NumPy: Numerical computing library

  • SciPy: Scientific computing library

  • pandas: Data analysis and manipulation

  • PyYAML: YAML file parsing

  • matplotlib: Plotting and visualization

  • getdist: MCMC chain analysis and plotting

Scientific Computing#

  • sunbird: Neural network emulation and simulation-based inference (GitHub)

  • PyTorch: Deep learning framework (required by sunbird)

Estimator Dependencies#

Clustering Measurements#

  • pycorr: Two-point correlation function measurements (GitHub)

    • Mesh routines for particle assignment and FFT calculations are based on pyrecon

  • pypower: Power spectrum estimation (GitHub)

  • PolyBin3D: Bispectrum estimation (GitHub)

    • Developed by Oliver Philcox & Thomas Flöss

  • Corrfunc: Fast correlation function estimation (optional, via pycorr)

Specialized Estimators#

  • mistreeplus: Minimum spanning tree statistics (optional, for MST estimator)

  • kymatio: Wavelet scattering transforms (optional, for wavelet estimator)

  • pyfnntw: Fast nearest neighbor searches (optional, for kNN estimator)

  • fast-histogram: Efficient histogram computation (optional, for kNN estimator)

  • numba: JIT compilation (optional, for kNN estimator)

Void Finding#

  • Revolver: Voxel void finder (GitHub)

    • Developed by Seshadri Nadathur

Galaxy-Halo Connection#

  • abacusutils: Utilities for working with AbacusSummit simulations

  • cosmoprimo: Cosmological calculations (GitHub)

  • mockfactory: Mock catalog generation (GitHub)

Documentation#

  • Sphinx: Documentation generation

  • sphinx-book-theme: Documentation theme

  • myst-nb: Markdown and Jupyter notebook support

  • sphinx-design: Design elements for Sphinx

Installation#

Different sets of dependencies can be installed using optional extras:

pip install acm[nersc]         # NERSC environment packages
pip install acm[cosmodesi]     # COSMODESI collaboration packages
pip install acm[docs]          # Documentation building
pip install acm[knn]           # k-NN estimator
pip install acm[mst]           # MST estimator
pip install acm[minkowski]     # Minkowski functionals
pip install acm[sunbird]       # Neural network emulation

See also

For installation instructions, see the Installation page.

Acknowledgments#

We are grateful to the developers and maintainers of all these packages, without which the acm pipeline would not be possible.

See also

For citation information, see the Citations page.

Contents