Introduction

These pages contain the software documentation for MockSZ, a Python package for simulating Sunyaev-Zeldovich (SZ) maps. The program is an implementation of the analytical equations found in [1]. In contrast to the other widely accepted SZ simulator, SZpack [2] [3], MockSZ provides a Python interface for running simulations. The actual calculations are off-loaded through a set of bindings to libraries written in C++.

MockSZ was designed as an easy interface, capable of quickly generating SZ spectra for forecasting simulations and fitting of measured signals.

Installation

The prerequisites for installing MockSZ on any operating system are:

A working Python installation of version 3.8 or higher.
A pip installation.
A C++ compiler.
The GNU scientific library.

All Python package prerequisites are fetched and installed upon installing MockSZ.

The program has been tested with the g++ compiler, which can be downloaded easily from the apt repository:

apt install g++

Additionally, MockSZ needs the GNU Scientific Library, or GSL for short, for correct functioning. Please refer to the GSL webpage for installation instructions.

Note that MockSZ has only been tested on Linux distros, so a correct functioning with Apple or Windows operating systems is not guaranteed.

Install From PyPi

MockSZ is on PyPi! Just pip install:

pip install MockSZ

and it should be good to go. Note that this does not install the latest version. However, it is guaranteed to be stable.

Install From Source

Wheel is required if building from source::

pip install wheel

Then, clone into the git repo and pip install:

git clone https://github.com/arendMoerman/MockSZ

pip install .

This way of installing ensures that the newest version is installed.

Optional Dependencies

The automated tests are run using the nose2 framework:

pip install nose2

Documentation in MockSZ is generated using Doxygen. Please see their installation page for instructions regarding installation.

Resources

MockSZ comes with a couple of resources for users and developers. These are divided into tutorials, where MockSZ usage is explained, validations, and detailed deep dives, where the inner workings of MockSZ are investigated. They can be found on the resources page.

License

This project is released under the MIT License.

Contact

For questions/support/remarks/coffee, please contact: A.Moerman-1(at)tudelft.nl