1
0
Fork 0
mirror of https://github.com/cosmo-sims/monofonIC.git synced 2024-09-19 17:03:45 +02:00

README.md edited online with Bitbucket

This commit is contained in:
Oliver Hahn 2020-08-21 14:30:59 +00:00
parent bbcea2ac28
commit 398104e015

View file

@ -7,6 +7,10 @@ Currently supported features (list is growing, so check back):
- Support for up to 3rd order Lagrangian perturbation theory (i.e. 1,2, and 3LPT) - Support for up to 3rd order Lagrangian perturbation theory (i.e. 1,2, and 3LPT)
- Support for PPT (Semiclassical PT for Eulerian grids) up to 2nd order
- Support for mixed CDM+baryon sims
- Multiple Einstein-Boltzmann modules: direct interface with [CLASS](https://lesgourg.github.io/class_public/class.html), file input from CAMB, and fitting formulae (Eisenstein&Hu). - Multiple Einstein-Boltzmann modules: direct interface with [CLASS](https://lesgourg.github.io/class_public/class.html), file input from CAMB, and fitting formulae (Eisenstein&Hu).
- Multiple output modules for RAMSES, Arepo and Gadget-2/3 via plugins (Swift and Nyx are next). New codes can be added (see how to contribute in CONTRIBUTING.md file) - Multiple output modules for RAMSES, Arepo and Gadget-2/3 via plugins (Swift and Nyx are next). New codes can be added (see how to contribute in CONTRIBUTING.md file)
@ -15,10 +19,12 @@ Currently supported features (list is growing, so check back):
- Requires FFTW v3, GSL (and HDF5 for output for some codes), as well as a CMake build system. - Requires FFTW v3, GSL (and HDF5 for output for some codes), as well as a CMake build system.
See file CONTRIBUTING.md on how to contribute to the development. The software is licensed under GPL v3. See file CONTRIBUTING.md on how to contribute to the development. The software is licensed under GPL v3 (see file LICENSE).
If you use MUSIC, or MUSIC2-monofonIC in scientific work, you are required to acknowledge this by linking to 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:
this repository and citing the relevant papers.
For total matter sims, or 3LPT/PLT related aspects: Michaux et al. 2020 (arXiv:TBD)
For baryon+CDM sims, or PPT numerics related aspects: Hahn et al. 2020 (arXiv:TBD)
## Build Instructions ## Build Instructions
@ -55,11 +61,11 @@ This is necessary since Apple's compilers haven't supported OpenMP for years.
There is an example parameter file 'example.conf' in the main directory. Possible options are explained in it, it can be run 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: as a simple argument, e.g. from within the build directory:
./monofonic ../example.conf ./monofonIC ../example.conf
If you want to run with MPI, you need to enable MPI support via ccmake. Then you can launch in hybrid MPI+threads mode by If you want to run with MPI, you need to enable MPI support via ccmake. Then you can launch in hybrid MPI+threads mode by
specifying the desired number of threads per task in the config file, and the number of tasks to be launched via specifying the desired number of threads per task in the config file, and the number of tasks to be launched via
mpirun -np 16 ./monofonic <path to config file> mpirun -np 16 ./monofonIC <path to config file>
It will then run with 16 tasks times the number of threads per task specified in the config file. It will then run with 16 tasks times the number of threads per task specified in the config file.