Cluster Generator#
![yt-project](https://img.shields.io/static/v1?label="works%20with"&message="yt"&color="blueviolet")
![ncodes](https://img.shields.io/static/v1?label="Implemented%20Sim.%20Codes"&message="7"&color="red")
Cluster Generator (CG) is a cross-platform Python library for generating initial conditions of galaxy clusters for N-body / hydrodynamics codes. CG provides a variety of construction approaches, different physical assumption, profiles, and gravitational theories. Furthermore, CG is intended to interface with a number of N-body / hydrodynamics codes used in studies of galaxy clusters, reducing the headache of converting initial conditions between formats for different simulation software. GC’s goal is to provide comprehensive tools for modeling and implementation of galaxy clusters in astrophysical simulations to promote the study of galaxy cluster dynamics.
This repository contains the core package, which is constructed modularly to facilitate easy development by users to meet particular scientific use cases. All of the necessary tools to get started building initial conditions are provided.
You can access the documentation here, or build it from scratch using the ./docs directory in this source distribution.
Development occurs here on Github, if you encounter any bugs, issues, documentation failures, or want to suggest features, we recommend that you submit an issue on the issues page of the repository.
For installation directions, visit the getting started page.
Features#
Radial Profiles
Each of the following radial profiles is included for use in cluster construction:
NFW Profiles
Hernquist Profiles
cored_hernquist_mass_profile()
Einasto Profiles
General Profiles
Paper Specific Profiles
Vikhlinin et. al. 2006 -
vikhlinin_density_profile()-vikhlinin_temperature_profile()Ascasibar & Markevitch 2006 -
am06_density_profile()-am06_temperature_profile()
Entropy Profiles
Gravitational Theories
cluster_generator not only provides initial condition generation capacity, but also provides a
comprehensive catalog of alternative gravity theories to explore. The following are built-in, but adding more is a relatively simple task:
Newtonian Gravity
MONDian Gravities
AQUAL
QUMOND
Available Datasets
The Cluster Collection module provides an easy interface with profiles derived from observational constraints in the literature. These utilities provide the user with a simple way of initializing realistic galaxy cluster models from literature without any pre-processing. The currently available cluster datasets are
Available Cluster Collections
Collection of 13 low-redshift galaxy clusters using Chandra. |
|
Collection of 13 low-redshift galaxy clusters using Chandra. |
|
Collection of 20 low-redshift galaxy clusters using Chandra. |
Automated Non-Physicality Correction
The CG provides a purpose built algorithm for non-physical corrections in initialized clusters to reduce labor overhead in the generation of the initial conditions. For more information, visit the Correcting Non-Physical Behavior page.
Resources#
Quickstart Guide
New to CG? The quickstart guide is the best place to start learning to use all of the tools that we have to offer!
Examples
Have some basic experience with CG, but want to see a guide on how to execute a particular task? Need to find some code to copy and paste? The examples page contains a wide variety of use case examples and explanations for all of the various parts of the CG library.
User References
The user guide contains comprehensive, text based explanations of the backbone components of the CG library. If you’re looking for information on the underlying code or for more details on particular aspects of the API, this is your best resource.
API Reference
Doing a deep dive into our code? Looking to contribute to development? The API reference is a comprehensive resource complete with source code and type hinting so that you can find every detail you might need.
Related Projects#
PyXSIM
Convert your CG generated systems into synthetic photon event lists for use in simulating observations using X-ray observatories using PyXSIM. CG is designed to easily interface with this library to provide as much ease as possible when building simulated observations of clusters.
SOXS
Coupled with PyXSIM, SOXS is a instrument simulation tool for turning mock photon counts into realistic X-ray observations specific to the behavior of specific instruments like CHANDRA, XMM-Newton, and NuSTAR.