Wiki is work in progress. If you feel that important information is missing, please get in touch or consider contributing (see CONTRIBUTING.md).

Before using monofonIC, ensure you have:

• Operating System: Linux or macOS
• Compiler: C++14 compatible (GCC 7+, Clang 5+, or Intel C++)
• Build System: CMake 3.9 or newer
• Libraries: FFTW3, GSL (required); HDF5 (strongly recommended)
• Parallelization: OpenMP (for threading); MPI (optional, for distributed runs)

If you're new to cosmological initial conditions or Lagrangian perturbation theory:

• See our Introduction for motivation and features
• Check the Glossary for technical terminology
• Review Michaux et al. 2020 and Hahn et al. 2020 for scientific background

To clone the repository using git including submodules (currently only CLASS is used as a submodule in order to perform the linear Einstein-Boltzmann evolution), type:

$ git clone [email protected]:cosmo-sims/monofonIC.git

You find instructions for building, configuring, and running monofonIC below.

The following diagram shows the typical workflow for generating initial conditions with monofonIC:

graph TB
    A[Build with CMake<br/>configure compile options]
    A --> B[Edit Configuration File<br/>cosmology, resolution, output]
    B --> C[Run monofonIC<br/>./monofonIC config.conf]
    C --> D[Run Simulation<br/>SWIFT/Gadget/RAMSES/etc.]

Start here if you're new to monofonIC:

• Quick Start Guide -- get up and running in 30 minutes with a working example
• Introduction -- features, motivation, and scientific background
• Installing Third-Party Libraries -- how to install FFTW3, GSL, HDF5 if not already available
• Building the code -- CMake configuration, compile-time options, building the code
• Running the code -- how to execute monofonIC and use MPI parallelization

Essential documentation for generating initial conditions:

• The Configuration File -- complete reference of all configuration options and parameters
• Output Plugins -- details of output formats for different simulation codes

Detailed reference material:

• Sample Configuration File -- annotated example configuration
• Glossary -- technical terms and concepts explained
• Extending MUSIC2 -- how to add new plugins and modules

See file CONTRIBUTING.md on how to contribute to the development.

The software is licensed under GPL v3 (see file LICENSE).

Please note the separate licensing for Panphasia (see external/panphasia/LICENSE).

If you use MUSIC2-monofonIC in your scientific work, you are required to acknowledge this by linking to this repository and citing the relevant papers:

• For total matter sims, or 3LPT/PLT related aspects: Michaux et al. 2020 arXiv:2008.09588

• For baryon+CDM sims, or PPT numerics related aspects: Hahn et al. 2020 arXiv:2008.09124