Skip to content

Commit

Permalink
Merge pull request #58 from pkgw/readme
Browse files Browse the repository at this point in the history
Tweak the README
  • Loading branch information
pkgw committed Aug 21, 2019
2 parents ca7920e + 7018576 commit 63110c8
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 305 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
@@ -1,6 +1,7 @@
# Next version (not yet released)

- Log changes here.
- Remove `ez_setup` installation infrastructure; it has been deprecated for a
long time.

# 3.0.1 (2019 Aug 21)

Expand Down
3 changes: 0 additions & 3 deletions MANIFEST.in
Expand Up @@ -4,9 +4,6 @@ include LICENSE-GPL
include MANIFEST.in
include README.md
include VERSION
include ez_setup.py
include install_required.sh
include install_recommended.sh

recursive-include aipy *.h

Expand Down
29 changes: 14 additions & 15 deletions README.md
Expand Up @@ -24,21 +24,20 @@ package repository:
$ conda install -c conda-forge aipy
```

## Python 3 and AIPY 3
As of the 3.0.x version series, AIPY supports both Python 3 and Python 2.

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](https://pip.pypa.io/en/stable/) command:
You can also install with `pip` if you wish:

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

There is not presently a Conda package of this version. Development of the 3.x
series happens on the [v3](https://github.com/HERA-Team/aipy/commits/v3)
branch of this repository.
To install the source code in development mode, use:

```
$ pip install -e .
$ python setup.py build_ext --inplace
```

## Documentation

Expand All @@ -60,10 +59,10 @@ 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.
The miriad source code (`aipy/miriad/mirsrc`) was included from MIRIAD 4.0.5.
To update, download a MIRIAD distribution and copy `$MIR/src/subs/*` and
`$MIR/src/inc/*` into `aipy/miriad/mirsrc`.

Healpix source code (aipy/healpix/cxx) was included from Healpix-2.01.
To update, download healpix source and copy src/cxx into aipy/healpix.
Healpix source code (`aipy/healpix/cxx`) was included from Healpix 2.01. To
update, download a HEALPix distribution and copy `src/cxx` into
`aipy/healpix`.
277 changes: 0 additions & 277 deletions ez_setup.py

This file was deleted.

4 changes: 0 additions & 4 deletions install_recommended.sh

This file was deleted.

5 changes: 0 additions & 5 deletions install_required.sh

This file was deleted.

0 comments on commit 63110c8

Please sign in to comment.