Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-15872: Incorporate AP documentation into pipelines.lsst.io #5

Merged
merged 2 commits into from
Oct 9, 2018
Merged

DM-15872: Incorporate AP documentation into pipelines.lsst.io #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f367f73
Modernize doc directory.
kfindeisen Oct 4, 2018
f78b84b
Fix Sphinx build errors.
kfindeisen Oct 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 18 additions & 12 deletions doc/ap_verify_testdata/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,19 @@ ap_verify_testdata
##################

The ``ap_verify_testdata`` package contains several files from `obs_test <https://github.com/lsst/obs_test/>`_.
The package is intended to test dataset support in ``ap_verify`` code.
The package is intended to test dataset support in :doc:`/modules/lsst.ap.verify/index` code.

Project info
============
.. _ap_verify_testdata-using:

Repository
https://github.com/lsst-dm/ap_verify_testdata
Using ap_verify_testdata
========================

.. Datasets do not have their own (or a collective) Jira components; by convention we include them in ap_verify
This package provides a minimal valid dataset for testing dataset handling, particularly ingestion.
Because there are no templates and the reference catalog is not guaranteed to match the data, this dataset is not suitable for full ``ap_verify`` runs.

Jira component
`ap_verify <https://jira.lsstcorp.org/issues/?jql=project %3D DM %20AND%20 component %3D ap_verify %20AND%20 text ~ "testdata">`_
.. _ap_verify_testdata-contents:

Dataset Contents
Dataset contents
================

This package provides a number of demonstration files copied from `obs_test <https://github.com/lsst/obs_test/>`_.
Expand All @@ -28,8 +27,15 @@ The dataset contents include raw images, biases, flats, and defects.
The dataset does not provide any image differencing templates.
It does have a small Gaia DR1 reference catalog, but it is not guaranteed to overlap with the footprint of the raw data.

Intended Use
.. _ap_verify_testdata-contributing:

Contributing
============

This package provides a minimal valid dataset for testing dataset handling, particularly ingestion.
Because there are no templates and the reference catalog is not guaranteed to match the data, this dataset is not suitable for full ``ap_verify`` runs.
``ap_verify_testdata`` is developed at https://github.com/lsst/ap_verify_testdata.
You can find Jira issues for this module under the `ap_verify <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20ap_verify%20AND%20text~"testdata">`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.

.. .. toctree::
.. :maxdepth: 1
7 changes: 1 addition & 6 deletions doc/manifest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@
# Also the name of the package documentation subdirectory.
package: "ap_verify_testdata"

# List of names of Python modules in this package.
# For each module there is a corresponding module doc subdirectory.
# modules:
# - "lsst.ap.verify.testdata"

# Name of the static content directories (subdirectories of `_static`).
# Static content directories are usually named after the package.
# Most packages do not need a static content directory (leave commented out).
# statics:
# - "_static/ap_verify_testdata"