CosmicWebClassifier - A Python package for classifying cosmic web structures

The package provides a set of tools to compute the density and tidal field from a sample of particles (usually obtained by N-body/hydrodynamical simulations), and classify the cosmic web structures into knots, filaments, sheets and voids based on the fields.

To install, run:

pip install cosmic-web-classifier

Alternatively, you can clone the repository and install the package locally via pip install -e /path/to/the/repo.

Usage

See the Jupyter notebooks under docs/.

• cosmic_web_types.ipynb: demonstrates how to generate a sample of dark matter particles from a particle-mesh code, and perform the classification based on the particle distribution.

Example images

Left: The evaluated density field. Right: The regions classified as voids (shown in white).

Contributors

• Yangyao Chen (USTC, yangyaochen.astro@foxmail.com).

Citation

If you use this package in your research, please cite the following papers:

• Huiyuan Wang et al. 2016, ApJ 831, 164 (https://arxiv.org/abs/1608.01763)
• Yangyao Chen et al. 2020, ApJ, 899, 81 (https://arxiv.org/abs/2003.05137)

Acknowledgements

The examples in this repository are based on the particle-mesh code PMWD (Yin Li, et al.).