mirror/MUSIC
1
0
Fork 0
mirror of https://github.com/cosmo-sims/MUSIC.git synced 2024-09-19 17:03:46 +02:00
Code Releases Activity

Update README.md

Browse source
This commit is contained in:
Oliver Hahn 2024-04-19 17:54:39 +02:00 committed by GitHub
parent f3d516437a
commit 64d521d138
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -1,71 +1,49 @@
MUSIC - multi-scale cosmological initial conditions MUSIC v2 - multi-scale cosmological initial conditions
=================================================== ======================================================
MUSIC is a computer program to generate nested grid initial conditions for MUSIC is a computer program to generate nested grid initial conditions for high-resolution "zoom" cosmological simulations. A detailed description of some of the algorithms can be found in [Hahn & Abel (2011)](http://arxiv.org/abs/1103.6031), but version 2.0 is much improved and has a much lower memory footprint. To learn how to use MUSIC, please [read the Wiki](https://github.com/cosmo-sims/music/wiki).
high-resolution "zoom" cosmological simulations. A detailed description
of the algorithms can be found in [Hahn & Abel (2011)][1]. You can
download the user's guide [here][3], or [read the Wiki](https://bitbucket.org/ohahn/music/wiki/Home) instead. Please consider joining the
[user mailing list][2].
Current MUSIC key features are: Current MUSIC key features are:
- Supports output for RAMSES, ENZO, Arepo, Gadget-2/3, ART, Pkdgrav/Gasoline - Supports output for RAMSES, ENZO, Arepo, Gadget-2/3, ART, Pkdgrav/Gasoline and NyX via plugins. New codes can be added.
and NyX via plugins. New codes can be added.
- Support for first (1LPT) and second order (2LPT) Lagrangian perturbation - Support for first (1LPT) and second order (2LPT) Lagrangian perturbation theory.
theory, local Lagrangian approximation (LLA) for baryons with grid codes.
- Pluggable transfer functions, currently CAMB, Eisenstein&Hu, BBKS, Warm - Pluggable transfer functions, currently CAMB, Eisenstein&Hu, BBKS, Warm Dark Matter variants. Distinct baryon+CDM fields.
Dark Matter variants. Distinct baryon+CDM fields.
- Minimum bounding ellipsoid and convex hull shaped high-res regions supported - Minimum bounding ellipsoid and convex hull shaped high-res regions supported with most codes, supports refinement mask generation for RAMSES.
with most codes, supports refinement mask generation for RAMSES.
- Parallelized with OpenMP - Parallelized with OpenMP
- Requires FFTW (v2 or v3), GSL (and HDF5 for output for some codes) - Requires FFTW3, GSL (and HDF5 for output for some codes)
## Building MUSIC ## Building MUSIC
While we still supply the old Makefile, using CMake is now the preferred way of building. While we still supply the old Makefile, using CMake is now the preferred way of building. CMake use out-of-source build, i.e. you create a build directory, and then configure the code using CMake. Inside the `music` directory, do
CMake use out-of-source build, i.e. you create a build directory, and then configure the code using CMake. Inside the `music` directory, do
``` ```
mkdir build mkdir build
cd build cd build
ccmake .. ccmake ..
make -j make -j
``` ```
to configure the code (you will se a menu), and then start a parallel compilation. If CMake has trouble finding your FFTW or HDF5 installation, to configure the code (you will se a menu), and then start a parallel compilation. If CMake has trouble finding your FFTW or HDF5 installation, you can add hints as follows
you can add hints as follows
``` ```
FFTW3_ROOT=<path> HDF5_ROOT=<path> ccmake .. FFTW3_ROOT=<path> HDF5_ROOT=<path> ccmake ..
``` ```
If you want to build on macOS, then it is strongly recommended to use GNU (or Intel) compilers instead of Apple's Clang. Install them e.g. via homebrew and then configure cmake to use them instead of the macOS default compiler via If you want to build on macOS, then it is strongly recommended to use GNU (or Intel) compilers instead of Apple's Clang. Install them e.g. via homebrew and then configure cmake to use them instead of the macOS default compiler via
``` ```
CC=gcc-9 CXX=g++-9 ccmake .. CC=gcc-13 CXX=g++-13 ccmake ..
``` ```
This is necessary since Apple's compilers haven't supported OpenMP for years. This is necessary since Apple's compilers haven't supported OpenMP for years.
## Running ## Running
There is an example parameter file 'example.conf' in the main directory. Possible options are explained in it, it can be run as a simple argument, e.g. from within the build directory:
There is an example parameter file 'example.conf' in the main directory. Possible options are explained in it, it can be run
as a simple argument, e.g. from within the build directory:
``` ```
./MUSIC ../ics_example.conf ./MUSIC ../ics_example.conf
``` ```
## Disclaimer ## Disclaimer
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. By downloading and using MUSIC, you agree to the LICENSE, distributed with the source code in a text file of the same name.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. By downloading and using MUSIC, you
agree to the LICENSE, distributed with the source code in a text
file of the same name.
[1]: http://arxiv.org/abs/1103.6031
[2]: https://groups.google.com/forum/#!forum/cosmo_music
[3]: https://bitbucket.org/ohahn/music/downloads/MUSIC_Users_Guide.pdf