User Reference Guide

Welcome to the Cluster Generator reference guide. On this page, you’ll find links to a variety of different articles which provide an indepth look at Cluster Generator under the hood.

Basic Components of CG

Radial Profiles

Radial profiles are the basis on which all of the models in cluster generator are built.

Read Time: 10 minutes

Cluster Models

Learn more about the central model.ClusterModel class and all it can provide for your workflow.

Read Time: 30 minutes

Codes

Learn about the available simulation codes that Cluster Generator can generate ICs for!

Read Time: 10 minutes

Collections

Read about the clusters that are pre-built in the Cluster Generator package.

Read Time: 10 minutes

Particles

Learn more about the particle initial conditions available in CG.

Read Time: 10 minutes

Initial Conditions

Interested in learning more about how the ics.ClusterICs class operates? Here’s your guide!

Read Time: 10 minutes

In Depth Articles

Correcting Non-Physical Regions

Learn about what goes on behind the hood when you use the correction module.

Read Time: 10 minutes

NPRs - Numerical Analysis

Go all in on the correction algorithms and learn about the underlying mathematical algorithms that are used to correct non-physical regions.

Read Time: 30 minutes

Fields

Learn to use magnetic fields in your simulations!

Read Time: 10 minutes