Cygrid is a cython-powered convolution-based gridding module for astronomy
Jupyter Notebook Python
Latest commit c241e32 Jan 23, 2017 @DanielLenz DanielLenz Cast indices to ints.

README.md

Introduction

  • Version: 0.9
  • Authors: Benjamin Winkel, Lars Flöer, Daniel Lenz

PyPI version PyPI downloads Build Status Publication License

Purpose

cygrid allows to resample a number of spectra (or data points) to a regular grid - a data cube - using any valid astronomical FITS/WCS projection (see http://docs.astropy.org/en/stable/wcs/).

The method is a based on serialized convolution with finite gridding kernels. Currently, only Gaussian (radial-symmetric or elliptical) kernels are provided (which has the drawback of slight degradation of the effective resolution). The algorithm has very small memory footprint, allows easy parallelization, and is very fast.

A detailed description of the algorithm is given in Winkel, Lenz & Flöer (2016), which we kindly ask to be used as reference if you found cygrid useful for your research.

Features

  • Supports any WCS projection system as target.
  • Conserves flux.
  • Low memory footprint.
  • Scales very well on multi-processor/core platforms.

Usage

Installation

The easiest way to install cygrid is via pip:

pip install cygrid

The installation is also possible from source. Download the tar.gz-file, extract (or clone from GitHub) and simply execute

python setup.py install

Dependencies

We kept the dependencies as minimal as possible. The following packages are required:

  • numpy 1.10 or later
  • cython 0.23.4 or later
  • astropy 1.0 or later (Older versions of these libraries may work, but we didn't test this!)

If you want to run the notebooks yourself, you will also need the Jupyter server, matplotlib and wcsaxes packages. To run the tests, you'll need HealPy.

Note, for compiling the C-extension, openmp is used for parallelization and some C++11 language features are necessary. If you use gcc, for example, you need at least version 4.7 otherwise the setup-script will fail. (If you have absolutely no possibility to upgrade gcc, older version may work if you replace -std=c++11 with -std=c++0x in setup.py. Thanks to bs538 for pointing this out.)

Examples

Check out the ipython notebooks in the repository for some examples of how to use cygrid. Note that you only view them on the nbviewer service, and will have to clone the repository to run them on your machine.

Who do I talk to?

If you encounter any problems or have questions, do not hesitate to raise an issue or make a pull request. Moreover, you can contact the devs directly: