Skip to main content

The Aegean source finding program, and associated tools.

Project description

Aegean software tools
======

Programs included:
* aegean - The Aegean source finding program. All your^ radio astronomy source finding needs in one spiffy program.
* BANE - The Background and Noise Estimation tool. For providing high quality background and noise images for use with Aegean, at a small fraction of the cost of a full box-car smooth.
* MIMAS - The Multi-resolution Image Masking tool for Aegean Software. For creating image regions which can be used to restrict the source finding of Aegean, to mask fits files, and to create ds9 region files.
* SR6 - A tool for shrinking and growing fits files, such as those created with BANE.py --compress. Shrinking is done by decimation, growing is done by linear interpolation.
* AeRes - A tool for adding or subtracting sources from an image - "Aegean Residual". Catalogues must be in Aegean readable format (eg, written by Aegean, modified by user). This can be used to look for missed sources, mis-characterised sources, or for simulating new images.

^ - by "your" I mean "my"

Installing
=====
AegeanTools is built and tested on python 2.7, and 3.6.

You can install via pip using
`pip install git+https://github.com/PaulHancock/Aegean.git` (latest)
`pip install AegeanTools` (stable)

Or you can clone or download the repository and then use `python setup.py install` or `pip install .`

**Notes for installing on python 3**:
pprocess has not (yet) been updated for python 3. The 2to3 conversion tool does what you need:
```
wget http://www.boddie.org.uk/python/downloads/pprocess-0.5.3.tar.gz
gunzip pprocess-0.5.3.tar.gz
tar -xvf pprocess-0.5.3.tar
cd pprocess-0.5.3
2to3 -w .
pip install .
```


Help
=====
Please see the [wiki pages](https://github.com/PaulHancock/Aegean/wiki) for some help and examples. If you have questions that are not answerd in the wiki please feel free to email me. If you have found a bug or some inconsistency in the code please [submit a ticket](https://github.com/PaulHancock/Aegean/issues) (which will trigger an email to me) and I'll get right on it.

Credit
=====
If you use Aegean or any of the AegeanTools for your research please give credit by citing:
- Paper 1, [Hancock et al 2012, MNRAS, 422, 1812](http://adsabs.harvard.edu/abs/2012MNRAS.422.1812H)
- Paper 2, [Hancock et al 2018, PASA, 35, 11H](http://adsabs.harvard.edu/abs/2018PASA...35...11H)

Until there is a more appropriate method for crediting software development and maintainance, please also consider including me as a co-author on publications which rely on Aegean or AegeanTools.


Status
=====
[![Build Status](https://travis-ci.org/PaulHancock/Aegean.svg?branch=master)](https://travis-ci.org/PaulHancock/Aegean)

[![Coverage Status](https://coveralls.io/repos/github/PaulHancock/Aegean/badge.svg?branch=master)](https://coveralls.io/github/PaulHancock/Aegean?branch=master)

[![Documentation Status](https://readthedocs.org/projects/aegeantools/badge/?version=latest)](http://aegeantools.readthedocs.io/en/latest/?badge=latest)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/014fb9c86b3f42b49ad94cd4384cfa78)](https://www.codacy.com/app/mr.paul.hancock/Aegean?utm_source=github.com&utm_medium=referral&utm_content=PaulHancock/Aegean&utm_campaign=Badge_Grade)

[![DOI](https://zenodo.org/badge/22051760.svg)](https://zenodo.org/badge/latestdoi/22051760) - latest release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

AegeanTools-2.0.1.tar.gz (513.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page