API#

API Reference for CG

utils

Utility functions for basic functionality of the py:module:cluster_generator package.

radial_profiles

radial_profiles.RadialProfile objects and associated tools for working with analytically defined profiles.

fields

3D fields for magnetic field initiation and other field based tasks.

ics

User facing initial conditions structures for interfacing with simulation softwares.

model

CG Core module containing classes and method related to the model.ClusterModel class for representing physically self-consistent galaxy cluster models.

particles

CG module for managing particle type initial conditions.

relations

Basic utility functions for relationships between various profile related parameters.

virial

Virialization module for CG

cluster_collections

The cluster_collections module provides user access to pre-existing radial profile models of known systems.

codes

Code-specific utilities for the cluster_generator library.