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-39298: Clarify reference catalog naming convention #347

Merged
merged 1 commit into from
Aug 11, 2023
Merged

DM-39298: Clarify reference catalog naming convention #347

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions doc/lsst.meas.algorithms/creating-a-reference-catalog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,19 +136,20 @@ Check the log output after several hours: ``ConvertReferenceCatalogTask`` report
===================================

When ``convertReferenceCatalog`` has finished, a new directory (named ``gaia-refcat/`` in the example above) will now exist containing the HTM-indexed files for the input catalog in the LSST format.
Our convention for reference catalogs is described in `DMTN-167 <https://dmtn-167.lsst.io/#reference-catalogs>`_ and is used in the commands listed below.
Our convention for reference catalogs is described in `DMTN-167 <https://dmtn-167.lsst.io/#reference-catalogs>`_ and is used in the commands listed below.

Three final steps are now required to register the new refcat dataset type, ingest your converted output into a RUN collection, and CHAIN that collection to the primary ``refcats`` collection.
If using ``convertReferenceCatalog``, these commands will have been printed on the command line when it finished.
For the example we are using here, these commands would be:

.. prompt:: bash

butler register-dataset-type REPO gaia_dr2 SimpleCatalog htm7
butler ingest-files -t direct REPO gaia_dr2 refcats/DM-NNNNN gaia/filename_to_htm.ecsv
butler register-dataset-type REPO gaia_dr2_20200414 SimpleCatalog htm7
butler ingest-files -t direct REPO gaia_dr2_20200414 refcats/DM-NNNNN gaia/filename_to_htm.ecsv
butler collection-chain REPO --mode extend refcats refcats/DM-NNNNN

where ``REPO`` is the path to the butler repository that you are ingesting the data into, and ``DM-NNNNN`` is the ticket you are tracking this refcat ingest on.
The name of the reference catalog is used as the dataset type and should include a date string (``_2020041411`` in this example) to distinguish between different versions of the same reference catalog.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for adding this, and sorry I missed it when I originally wrote it!

We use the ``direct`` transfer mode here to leave the files in the directory they were converted into: ``gaia_dr2/``.
See ``butler ingest-files -h`` for other options, including ``copy``, ``move`` and ``link`` transfer modes.

Expand Down