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-12851: Determine whether dataset framework can be made generic #16

Merged
merged 1 commit into from
Jan 3, 2018
Merged

DM-12851: Determine whether dataset framework can be made generic #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions doc/lsst.ap.verify/datasets-butler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ This is by design:
:ref:`ingestion of observatory files into a repository<ingest>` is considered part of the pipeline system being tested by ``ap_verify``, so ``ap_verify`` must be fed uningested data as its input.
The ingestion step creates a valid repository that is then used by the rest of the pipeline.

.. TODO: depends on whether subdirectories need a particular structure (DM-12851)

A secondary benefit of this approach is that dataset maintainers do not need to manually ensure that the Git repository associated with a dataset remains a valid Butler repository despite changes to the dataset.
The dataset format merely requires that files be segregated into appropriate directories, a much looser integrity constraint.
The dataset format merely requires that files be segregated into science and calibration directories, a much looser integrity constraint.

While datasets are not Butler repositories themselves, the dataset format includes a directory, :file:`repo`, that serves as a template for the post-ingestion repository.
This template helps ensure that all repositories based on the dataset will be properly set up, in particular that any observatory-specific settings will be applied.
Expand Down
12 changes: 4 additions & 8 deletions doc/lsst.ap.verify/datasets-creation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,11 @@ This will create empty directories for all data and will add placeholder files f
Organizing the Data
-------------------

.. TODO: talk to David/Meredith to confirm details of how this works, and how flexible the system is (DM-12851)

* The :file:`raw` and :file:`calib` directories contain science and calibration data, respectively.
The directories must be organized in the same way as the observatory's normal data products, for compatibility with the appropriate ``obs`` package.
* The :file:`templates` directory contains a :ref:`LSST Butler repository<butler>` containing processed images useable as templates. Template files must be ``TemplateCoadd`` files produced by a compatible version of the LSST science pipeline.

.. TODO: are these more standardized? are they available from somewhere? (DM-12851)

* The :file:`refcats` directory contains one or more tar'd HTM files containing astrometric and photometric reference catalogs.
The directories may have any internal structure.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please clarify whether this point applies only to raw and calib or to all the directories mentioned in this section.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it confusing only because of the diff? This is how it looks in HTML:

  • The raw and calib directories contain science and calibration data, respectively. The directories may have any internal organization.
  • The templates directory contains a LSST Butler repository containing processed images useable as templates. Template files must be TemplateCoadd files produced by a compatible version of the LSST science pipeline.
  • The refcats directory contains one or more tar files, each containing containing one or more astrometric or photometric reference catalogs in HTM shard format.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, yes, the diff made it look like its own bullet point at a glance. All good!

* The :file:`templates` directory contains an :ref:`LSST Butler repository<butler>` containing processed images useable as templates.
Template files must be ``TemplateCoadd`` files produced by a compatible version of the LSST science pipeline.
* The :file:`refcats` directory contains one or more tar files, each containing containing one or more astrometric or photometric reference catalogs in HTM shard format.

The templates and reference catalogs need not be all-sky, but should cover the combined footprint of all the raw images.

Expand Down