Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.32 KB

README.md

File metadata and controls

69 lines (48 loc) · 2.32 KB

AIPY (Astronomical Interferometry in PYthon)

Build Status Coverage Status

Description

This package collects together tools for radio astronomical interferometry. In addition to pure-python phasing, calibration, imaging, and deconvolution code, this package includes interfaces to MIRIAD (a Fortran interferometry package) and HEALPix (a package for representing spherical data sets).

Instructions, documentation, and a FAQ may be found at the aipy GitHub page.

Installation

We strongly recommend installing AIPY with the conda packaging tool using the public conda-forge package repository:

$ conda install -c conda-forge aipy

Python 3 and AIPY 3

The 2.x release series of AIPY supports only Python 2. However, there is now a prototype version of AIPY 3.0 which adds support for Python 3 (while still supporting Python 2). You can install it using the following pip command:

pip install git+https://github.com/HERA-Team/aipy.git@v3

There is not presently a Conda package of this version. Development of the 3.x series happens on the v3 branch of this repository.

Documentation

If you want to build HTML documentation, you'll need to have Sphinx installed. Then, change to the doc/ directory and run:

$ make html

The results will appear in doc/build/html. There are plenty of other build options, too. Many thanks to Jayce Dowell for his work on this.

Enjoy, Aaron Parsons


Package Info for Developers

The miriad source code (aipy/miriad/mirsrc) was included from MIRIAD-4.0.5. To update, download miriad source and copy $MIR/src/subs/* and $MIR/src/inc/* into aipy/miriad/mirsrc. Not all files are used, but include them all anyway.

Healpix source code (aipy/healpix/cxx) was included from Healpix-2.01. To update, download healpix source and copy src/cxx into aipy/healpix.