Skip to content

Commit

Permalink
Misc doc fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
saimn committed Feb 8, 2016
1 parent 003d8c2 commit f013346
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
*.egg-info/
build/
dist/
doc/_build/
zap/#zap.py#
zap/.#zap.py
zap/_githash.py
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The method uses PCA to isolate the residual sky subtraction features and remove
them from the observed datacube. Future developments will include modification for
use on a variety of instruments.

the lat stable release of ZAP can be installed simply with:
The last stable release of ZAP can be installed simply with::

pip install zap
pip install zap

or into the user path with
Or into the user path with::

pip install --user zap
pip install --user zap

Documentation : `zap.readthedocs.org <http://zap.readthedocs.org/en/latest/>`_

Expand Down
16 changes: 9 additions & 7 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
===============================
Welcome to ZAP's documentation!
===============================

Expand All @@ -28,7 +29,8 @@ Steps
-----

ZAP can be installed using pip ::
pip install zap

pip install zap


Examples
Expand All @@ -41,7 +43,7 @@ In its most hands-off form, ZAP can take an input fits datacube, operate on it,

Care should be taken, however, since this case assumes a sparse field, and better results can be obtained by applying masks.

The main function is ``zap.process``:
The main function is ``zap.process``.

There are a number of options that can be passed to the code which we describe here:

Expand Down Expand Up @@ -98,16 +100,16 @@ Aside from the main process, two functions are included that can be run outside

.. autofunction:: zap.wmedian


Command Line Interface
======================

ZAP can also be used from the command line::

python -m zap INPUT_CUBE.fits

More information use of the command line interface can be found with the command ::

python -m zap -h


Expand Down Expand Up @@ -143,7 +145,7 @@ eigenspectra per region. A workflow may go as follows:
# plot a spectrum of the cleaned ZAP dataproduct
plt.plot(zobj.cleancube[:,50:100,50:100].sum(axis=(1,2)), 'g')
# choose just the first 3 spectra for all segmments
# choose just the first 3 spectra for all segments
zobj.reprocess(nevals=3)
# plot a spectrum extracted from the original cube
Expand Down Expand Up @@ -178,9 +180,9 @@ eigenspectra per region. A workflow may go as follows:
# or merge the zap datacube into the original input datacube, replacing the data extension
zobj.writefits(outcubefits='DATACUBE_FINAL_ZAP.fits')
======
ZCLASS
======

.. autoclass:: zap.zclass
:members:

Expand Down

0 comments on commit f013346

Please sign in to comment.