-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation to reflect the new ap_pipe name and functionality
- Loading branch information
Showing
2 changed files
with
14 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters