Skip to content

Commit

Permalink
Update documentation to reflect the new ap_pipe name and functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
mrawls committed Aug 11, 2017
1 parent 3505ed4 commit a0e9e40
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# decam_hits
# ap_pipe

This package contains the Prototype AP Pipeline and will eventually be
renamed `ap_pipe`.
This package contains the Prototype AP Pipeline.

At present, the main script is `decam_process.py`, which allows a
user to run a portion of the AP Pipeline on data from the DECam HiTS survey.
The main script is `ap_pipe.py`, which allows a user to run
each step of the Prototype AP Pipeline on data from DECam.

Individual functions in `ap_pipe.py` will be called by
[`ap_verify`](https://github.com/lsst-dm/ap_verify), but the
pipeline can also be run on its own without verification metrics using a dataset
structured like [`ap_verify_hits2015`](https://github.com/lsst/ap_verify_hits2015).

For more detailed documentation, including a tutorial,
please see [DMTN-039](https://dmtn-039.lsst.io).

**Note**: the tutorial portion of the technote is not up-to-date with master.
This will be remedied as part of [DM-11390](https://jira.lsstcorp.org/browse/DM-11390)
and/or [DM-11422](https://jira.lsstcorp.org/browse/DM-11422).
5 changes: 1 addition & 4 deletions python/lsst/ap/pipe/ap_pipe.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@
'''
Process raw decam images with MasterCals from ingestion --> difference imaging
TODO: Rename script and GitHub repo to ap_pipe (not decam_hits or decam_process).
This will be done in DM-11324.
TODO: Update DMTN-039 to reflect the new user interface.
I'm postponing this until DM-11422 and/or DM-11390 are complete.
'''
Expand Down Expand Up @@ -78,7 +75,7 @@ def runPipelineAlone():
Process raw decam images with MasterCals from ingestion --> difference imaging
USAGE:
$ python decam_process.py -d dataset_root -o output_location -i "visit=12345, ccd=5"
$ python ap_pipe.py -d dataset_root -o output_location -i "visit=12345, ccd=5"
'''))
parser.add_argument('-d', '--dataset',
help="Location on disk of dataset_root, which contains subdirectories of raw data, calibs, etc.")
Expand Down

0 comments on commit a0e9e40

Please sign in to comment.