ClusterMonteCarlo / CMC-COSMIC

14 stars 19 forks source link

The Cluster Monte Carlo Code, CMC-COSMIC

A Henon style orbit-averaging code for collisional stellar dynamics, with all the necessary physics for modeling the long-term evolution of dense star clusters.

See the documentation here

Installation Instructions (See here for more details)

Checkout the code with (be sure to add the --recurse-submodules flag to download COSMIC as well!)

git clone https://github.com/ClusterMonteCarlo/CMC-COSMIC.git --recurse-submodules

You'll need MPI, HDF5, GSL, and cmake (version 3.12 or higher) to compile the code. These should be available on any HPC system (or easily installed with your favorite package manager on Linux). Once downloaded, compile the code with

cd CMC-COSMIC
mkdir build
cd build
FC=mpifort CC=mpicc cmake .. -DCMAKE_INSTALL_PREFIX=../CMC
make install

This will create a build and bin folder in the top level of the CMC-COSMIC package with the relevant executables.

Citing the code

If you use CMC-COSMIC in your research, please cite Joshi et al., 2000, Pattabiraman et al., 2013, Rodriguez et al., 2022, the Zenodo assocaited with the version of the code, and the COSMIC paper Breivik et al., 2020. In a pinch, you can just cite Rodriguez et al., 2022, but please cite all 5 if possible.

Badges

Unit Test CMC Docker

Use CMC in a container

Docker

docker pull clustermontecarlo/cmc

Singularity

singularity pull docker://clustermontecarlo/cmc