@mainpage

GalSim: The modular galaxy image simulation toolkit

GalSim is open-source software for simulating images of astronomical objects (stars, galaxies) in a variety of ways. The bulk of the calculations are carried out in C++, and the user interface is in python. In addition, the code can operate directly on "config" files, for those users who prefer not to work in python. The impetus for the software package was a weak lensing community data challenge, called GREAT3:

http://great3challenge.info/

However, the code has numerous additional capabilities beyond those needed for the challenge, and has been useful for a number of projects that needed to simulate high-fidelity galaxy images with accurate sizes and shears. At the end of this file, there is a list of the code capabilities and plans for future development.

Distribution

The current released version of GalSim is version 1.1. To get the code, you can grab the tarball (or zip file) from

https://github.com/GalSim-developers/GalSim/releases/tag/v1.1.0

Also, feel free to fork the repository:

https://github.com/GalSim-developers/GalSim/fork

Or clone the master branch with either of the following:

git clone git@github.com:GalSim-developers/GalSim.git
git clone https://github.com/GalSim-developers/GalSim.git

The code is also distributed via Fink, Macports, and Homebrew for Mac users. See INSTALL.md for more information.

The code is licensed under a BSD-style license. See the file LICENSE for more details.

Keeping up-to-date with GalSim

There is a GalSim mailing list, organized through the Google Group galsim-announce. Members of the group will receive news and updates about the GalSim code, including notifications of major version releases, new features and bugfixes.

You do not need a Google Account to subscribe to the group, simply send any email to

galsim-announce+subscribe@googlegroups.com

If you receive a confirmation request (check junk mail filters!) simply reply directly to that email, with anything, to confirm. You may also click the link in the confirmation request, but you may be asked for a Google Account login.

To unsubscribe, simply send any email to

galsim-announce+unsubscribe@googlegroups.com

You should receive notification that your unsubscription was successful.

How to communicate with the GalSim developers

If you have a question about how to use GalSim, a good place to ask it is at StackOverflow:

http://stackoverflow.com/

Some of the GalSim developers have alerts set up to be automatically notified about questions with the 'galsim' tag, so there is a good chance that your question will be answered.

If you find something that you think is a bug, or if you have a suggestion for a new feature, please open up an Issue on our GitHub repository:

https://github.com/GalSim-developers/GalSim/issues?state=open

Installation

For installation instructions, please see the file INSTALL.md in the main repository directory.

There are tagged versions of the code corresponding to specific project releases and development milestones. (For more info, see the "Tagged versions" section below, and devel/git.txt)

Getting started

Install the code as in INSTALL.md.
Optional, but recommended whenever you try a new version of the code: run the unit tests to make sure that there are no errors. You can do this by running scons tests. If there are any issues, please open an Issue on our GitHub page.
Optional: run doxygen to generate documentation, using Doxyfile in the main repository directory to specify all doxygen settings. Alternatively, you can view the documentation online at
```
http://galsim-developers.github.com/GalSim/
```

Reference documentation

For an overview of GalSim workflow and python tools, please see the file doc/GalSim_Quick_Reference.pdf in the GalSim repository. A guide to using the configuration files to generate simulations, a FAQ for installation issues, and other useful references can be found on the GalSim wiki,

https://github.com/GalSim-developers/GalSim/wiki

More thorough documentation for all parts of the code can be found in the doxygen documentation mentioned in the previous section, or in the python docstrings in galsim/*.py.

Repository directory structure

The repository has a number of subdirectories. Below is a guide to their contents:

bin/ : executables (after the compilation procedure is done).
devel/ : an assortment of developer tools.
doc/ : documentation, including a Quick Reference guide and, if the user generates doxygen documentation using Doxyfile, the outputs will also go in this directory.
examples/ : example scripts (see the following section).
galsim/ : the python code for GalSim (which is what most end-users interact with).
include/ : the .h header files for the C++ parts of GalSim.
lib/ : compiled libraries (after the compilation procedure is done).
pysrc/ : the code that makes the purely C++ parts of GalSim accessible to the python layer of GalSim.
src/ : the source code for the purely C++ parts of GalSim.
tests/ : unit tests.

Demonstration scripts

There are a number of scripts in examples/ that demonstrate how the code can be used. These are called demo1.py...demo12.py. You can run them by typing (e.g.) python demo1.py while sitting in examples/, All demo scripts are designed to be run in the examples/ directory. Some of them access files in subdirectories of the examples/ directory, so they would not work correctly from other locations.

A completely parallel sequence of configuration files, called demo1.yaml... demo12.yaml, demonstrates how to make the same set of simulations using config files that are parsed by the executable bin/galsim.

As the project develops through further versions, and adds further capabilities to the software, more demo scripts may be added to examples/ to illustrate what GalSim can do.

Tagged versions

Each GalSim release is tagged in git with the tag name vX.X.X. You can see the available tags using the command

git tag -l

at a terminal from within the repository. In addition to the official releases, we also have tags for various other milestones that were important at one time or another.

The version of the code at any given snapshot can be downloaded from our GitHub webpage, or checked out from the repository using the tag name, e.g.:

git checkout v1.1.0

This will then update your directory tree to the snapshot of the code at the milestone requested. (You will also get a message about being in a "detached" HEAD state. That is normal.)

For a version history and a description of how the current version of the code differs from the last tagged version, see HISTORY.md and CHANGELOG.md (respectively). These files are found in the main GalSim directory, and are also displayed on our wiki which is linked above.

Summary of current capabilities

Currently, GalSim has the following capabilities:

Can generate PSFs from a variety of simple parametric models such as Moffat, Kolmogorov, and Airy, as well as an optical PSF model that includes Zernike aberrations up to spherical, and an optional central obscuration and struts.
Can simulate galaxies from a variety of simple parametric models as well as from real HST data. For information about downloading a suite of COSMOS images, see
```
https://github.com/GalSim-developers/GalSim/wiki/RealGalaxy%20Data
```
Can make the images either via i) Fourier transform, ii) real-space convolution (real-space being occasionally faster than Fourier), or iii) photon-shooting. The exception is that objects that include a deconvolution (such as RealGalaxy objects) must be carried out using Fourier methods only.
Can handle wavelength-dependent profiles and integrate over filter bandpasses appropriately.
Can apply shear, magnification, dilation, or rotation to a galaxy profile including lensing-based models from a power spectrum or NFW halo profile.
Can draw galaxy images into arbitrary locations within a larger image.
Can add noise using a variety of noise models, including correlated noise.
Can whiten existing correlated noise that is already in an image.
Can read in input values from a catalog, a dictionary file (such as a JSON or YAML file), or a fits header.
Can write images in a variety of formats: regular FITS files, FITS data cubes, or multi-extension FITS files. It can also compress the output files using various compressions including gzip, bzip2, and rice.
Can carry out nearly any simulation that a user might want using two parallel methods: directly using python code, or by specifying the simulation properties in an input configuration script. See the demo scripts in the examples/ directory for examples of each.
Supports a variety of possible WCS options from a simple pixel scale factor of arcsec/pixel to affine transforms to arbitrary functions of (x,y), including a variety of common FITS WCS specifications.

Summary of planned future development

We plan to add the following additional capabilities in future versions of GalSim:

PSFs from stochastic atmosphere models. (cf. devel/modules/atmos_factfinding.pdf)
Simulating simple detector defects or image artifacts.
Support for flexion. (cf. Issue #361)

There are many others as well. Please see

https://github.com/GalSim-developers/GalSim/issues

for a list of the current open issues. And feel free to add an issue if there is something useful that you think should be possible, but is not currently implemented.

stargaser/GalSim