MIMIC constructs constrained initial conditions and Wiener filter reconstruction from a given set of peculiar velocity constraints and user defined expansion history, power spectra and growth functions. The code is written in python, with MPI enabled through mpi4py, and written with numba JIT compiled code for speed.
The software is dependent on the following libraries that will be installed automatically when installed with pip:
To enable MPI you must install, note you can still run MIMIC without this:
Clone the git repository and install mimic by running inside the cloned repository:
pip install .
You should now be able to import the module:
import mimicMIMIC will be installed as a module, which can be called from any python script or notebook. The MIMIC script file, mimic-run.py is located in the scripts/ folder. This file can (and should) be copied to the directory in which you will be running analyses, which you want to compute MIMIC data products. This can be run
mpirun -n 4 python mimic-run.py params.yamlwhere 4 is the number of processors and params.yaml is the parameter file.
If you have any issues with the code or want to suggest ways to improve it please open a new issue (here) or (if you don't have a github account) email krishna.naidoo.11@ucl.ac.uk.