The CGM Toolkit is used for analytic modeling observables of the circumgalactic medium in X-ray, Sunyaev-Zeldovich (SZ) effect, and UV absorption lines.
- Jupyter Notebooks:
.ipynbfiles containing code, documentation, and usage examples.example.ipynb: Provides a usage example of the toolkit.
- Python Scripts:
.pyfiles containing the core functionality and utilities for data processing and analysis.
- PyAtomDB: Used for X-ray calculations, utilizing the APEC model. More details can be found in the PyAtomDB documentation.
- Installation: Install the toolkit using
pipwith the following command:pip install --user -e .
- example.ipynb: Demonstrates how to use the toolkit for analyzing CGM data, including data preprocessing, visualization, and analysis.
The CGM Toolkit has been used in the following papers:
- Lau et al 2025: X-raying CAMELS: Constraining Baryonic Feedback in the Circum-Galactic Medium with the CAMELS simulations and eRASS X-ray Observations
- Hernández-Martínez et al 2025: Cosmological and Astrophysical Parameter Inference from Stacked Galaxy Cluster Profiles Using CAMELS-zoomGZ
- Singh et al 2024: Comparison of models for the warm-hot circumgalactic medium around Milky Way-like galaxies
This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.
Contributions are welcome! Please open an issue or submit a pull request for any changes or enhancements.
For any questions or inquiries, please contact ethlau.
Simple code to compute X-ray, SZ, and UV absorption line observables for given temperature and metallicity of the halo gas
Uses the APEC model in PyAtomDB for the X-ray calculations.
Usage example is provided in the ipython notebook example.ipynb.
In the download folder, use pip to install
$ pip install --user -e .