DM-39500: Populate Instrument metadata when an APDB instance is created #227
Conversation
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
kfindeisen
approved these changes
Apr 3, 2025
There was a problem hiding this comment.
Please follow commit organization best practices, otherwise looks about as good as this solution can.
doc/lsst.ap.pipe/apdb.rst
Outdated
| pipetask run -p ApPipe.yaml -c parameters:apdb_config=apdb_config.py differencer:coaddName=dcr -b repo -o myrun | ||
|
|
||
| The ``apdb_config.py`` argument to |apdb-cli| specifies the name of the created configuration file that will contain a serialized `~lsst.dax.apdb.ApdbConfig` for the new database. | ||
|
|
||
| A Postgres database can be set up and used with the following: | ||
| A Postgres database can be set up and used with the following. | ||
| Note that ``MY_INSTRUMENT`` should be the fully-qualified name of the instrument whose data will populate this APDB instance (e.g. ``lsst.obs.lsst.LsstCam`` or ``lsst.obs.subaru.HyperSuprimeCam``). |
There was a problem hiding this comment.
If this information is outright wrong, I recommend dropping or squashing this commit instead of patching it over later (imagine what would happen if the "part 2" commit got reverted, or this one got cherry-picked).
doc/lsst.ap.pipe/apdb.rst
Outdated
Comment on lines
49
to
52
| The ``apdb_config.py`` argument to |apdb-cli| specifies the name of the created configuration file that will contain a serialized `~lsst.dax.apdb.ApdbConfig` for the new database. Note that ``MY_INSTRUMENT`` should be the short name of the instrument whose data will populate this APDB instance (e.g. ``DECam`` or ``HSC``). | ||
|
|
||
| A Postgres database can be set up and used with the following. | ||
| Note that ``MY_INSTRUMENT`` should be the fully-qualified name of the instrument whose data will populate this APDB instance (e.g. ``lsst.obs.lsst.LsstCam`` or ``lsst.obs.subaru.HyperSuprimeCam``). |
There was a problem hiding this comment.
I suggest moving this change into the first commit, or even merging the two commits together (if you have to say "part 2", then clearly it's not atomic).
doc/lsst.ap.pipe/apdb.rst
Outdated
| @@ -46,10 +46,9 @@ To create an SQLite database from scratch, run the following (see the :ref:`dax_ | |||
| apdb-cli metadata set apdb_config.py instrument MY_INSTRUMENT | |||
| pipetask run -p ApPipe.yaml -c parameters:apdb_config=apdb_config.py differencer:coaddName=dcr -b repo -o myrun | |||
|
|
|||
| The ``apdb_config.py`` argument to |apdb-cli| specifies the name of the created configuration file that will contain a serialized `~lsst.dax.apdb.ApdbConfig` for the new database. | |||
| The ``apdb_config.py`` argument to |apdb-cli| specifies the name of the created configuration file that will contain a serialized `~lsst.dax.apdb.ApdbConfig` for the new database. Note that ``MY_INSTRUMENT`` should be the short name of the instrument whose data will populate this APDB instance (e.g. ``DECam`` or ``HSC``). | |||
There was a problem hiding this comment.
Please write one sentence per line, it makes future diffs much clearer.
This was leftover from some old refactoring.
erinleighh
force-pushed
the
tickets/DM-39500
branch
from
f7ebcda to
39b7fb5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.