Installation¶

To install the latest release from PyPI, use pip:

pip install ufig

Features¶

• Ultra fast speed

• Modular structure that can be easily integrated and expanded

• User interacts with the program through Python scripts

• Structured unit tests for continuous robust development

Note: For not supported features, see the plugins (including the deprecated ones) in the archive branch (https://gitlab.com/cosmology-ethz/ufig/-/tree/old_master_before_11_2024).

Introduction¶

The Ultra Fast Image Generator (UFig) is an image simulation tool that generates simulated astronomical images for scientific usage.

The code is implemented in pure Python and highly optimized in terms of speed.

The output images are useful for developing analysis algorithms and data processing pipelines in the field of astronomy/cosmology.

Conceptually, a typical UFig program involves two things:

1. Config file: sets up the workflow by calling a series of plugins.

   The content in each config file includes importing or setting the relevant input parameters and arranging the list of plugins that are being called. The main set of common parameters are listed in the “common” module at ufig.config.common. Examples of config files can be found also be found in the documentation.

2. Plugin: implement specific jobs.

   The nature of the plugins ranges from mundane data handling (e.g., I/O of data files), PSF estimation and background addition to rendering and processing the images. The plugins are stored in ufig.plugins and can be easily extended by the user.

Credits¶

This package was developped by the Cosmology group at ETH Zurich and is currently maintained by Silvan Fischbacher: silvanf@phys.ethz.ch

Contributions¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.