Skip to content

Commit

Permalink
Merge branch 'master' into docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulHancock committed Dec 27, 2017
2 parents 12f2db1 + 3982d9a commit 518cb4e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 6 deletions.
4 changes: 2 additions & 2 deletions AegeanTools/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
""" """

__author__ = 'Paul Hancock'
__version__ = '2.0b191'
__date__ = '2017-08-22'
__version__ = '2.0b345'
__date__ = '2017-12-12'
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,39 @@ Programs included:
* 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 guaranteed to work on python 2.7. Earlier versions will often work, but 3.0 is not (yet) supported.
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 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 credit me by citing [Hancock et al 2012, MNRAS, 422, 1812](http://adsabs.harvard.edu/abs/2012MNRAS.422.1812H), Hancock et al 2017 (submitted).
If you use Aegean or any of the AegeanTools for your research please credit me by citing [Hancock et al 2012, MNRAS, 422, 1812](http://adsabs.harvard.edu/abs/2012MNRAS.422.1812H), Hancock et al 2018 (PASA, submitted).

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.

Expand Down
3 changes: 2 additions & 1 deletion scripts/AeRes
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@ if __name__ == "__main__":
usage = "usage: %prog -c input.vot -f image.fits -r residual.fits [-m model.fits]"
parser = OptionParser(usage=usage)
parser.add_option("-c", "--catalog", dest='catalog', default=None,
help="Catalog in a format that Aegean understands.")
help="Catalog in a format that Aegean understands."+
"\nRA/DEC should be in degrees, a/b/pa should be in arcsec/arcsec/degrees.")
parser.add_option("-f", "--fitsimage", dest='fitsfile', default=None,
help="Input fits file.")
parser.add_option("-r", "--residual", dest='rfile', default=None,
Expand Down

0 comments on commit 518cb4e

Please sign in to comment.