zoom-setup

Welcome to the zoom-setup tools. This repository contains a collection of python scripts to set up zoom simulations through the ic_gen IC generator, in particular in a format suitable for use with the public SWIFT code.

Scripts are provided to

• Generate a mask for the zoom region from an existing simulation
• Create the unperturbed, multi-resolution "particle load" for ic_gen
• Convert the ic_gen output into a SWIFT-compatible single hdf5 file
• Configure a SWIFT parameter file with appropriate values for the ICs

A concise overview of how to use these scripts is provided in QUICKSTART.rst. For a more detailed description of features and available options, please refer to the documentation in the docs subdirectory. This can be built with

cd docs
make html

and then be viewed at docs/build/html/index.html.

Parent simulation type

Only SWIFT simulations with VELOCIraptor halo catalogues are supported as input for generating masks. Support for GADGET/SUBFIND input has been dropped in favour of better support for SWIFT.

Installation

This repository provides top-level scripts, rather than an importable package. Simply clone the repository to your local system with

git clone https://github.com/ymbahe/zoom-setup.git

The following external libraries are required:

• numpy
• pyyaml
• h5py
• scipy
• astropy
• cython

You can ensure that they are installed by running

python3 -m pip install -r requirements.txt

Optionally, the following libraries are used:

• mpi4py, to enable parallel processing
• matplotlib, to generate diagnostic plots

These can be installed by running

python3 -m pip install -r requirements-opt.txt

Note: The particle load generator (sub-directory particle_load) contains a module written in Cython for efficiency (auxiliary_tools.pyx). This should compile automatically through pyximport. If that fails for some reason, please compile auxiliary_tools.pyx manually with

python3 setup.py build_ext --inplace

(The shorter cythonize -i auxiliary_tools.pyx tends to get stuck finding the numpy headers, especially when running in virtual environments).

Specify local system parameters

To make the automatic generation of ic_gen input files easier, a number of parameters of your system can be specified in the local.py file. To prevent git from accidentally overriding these during updates (or from pushing these system-specific values to the central repository), it is best to tell git to ignore these changes once they are made:

.. code-block:: bash

$ git update-index --assume-unchanged local.py