DM-33254: Remove Gen 2 support from ap_pipe #119
Conversation
doc/lsst.ap.pipe/apdb.rst
Outdated
| .. |pipetask| replace:: :command:`pipetask` | ||
|
|
||
|
|
||
| In its default configuration, the Alert Production Pipeline, as represented by :lsst-task:`lsst.ap.pipe.ApPipeTask` (Gen 2) or :file:`pipelines/ApPipe.yaml` (Gen 3), relies on a database to save and load DIASources and DIAObjects. | ||
| In its default configuration, the Alert Production Pipeline, as represented by :file:`pipelines/ApPipe.yaml` (Gen 3), relies on a database to save and load DIASources and DIAObjects. |
There was a problem hiding this comment.
You should remove the parenthetical (Gen 3) as well... especially since some new people may get confused and not realize that it's the name of what they're using.
doc/lsst.ap.pipe/apdb.rst
Outdated
| Databases can also be set up using :ref:`config files <command-line-task-config-howto-configfile>`: | ||
|
|
||
| .. code-block:: py | ||
| :caption: myApdbConfig.py | ||
|
|
||
| config.db_url = "sqlite:///databases/apdb.db" | ||
|
|
||
| .. prompt:: bash | ||
|
|
||
| make_apdb.py -C myApdbConfig.py | ||
| ap_pipe.py repo --calib repo/calibs --rerun myrun -C myApPipeConfig.py --id [optional ID to process] | ||
|
|
There was a problem hiding this comment.
This block is still relevant; I would keep everything the same except replacing the ap_pipe.py line with a pipetask run line.
There was a problem hiding this comment.
Okay, I was a bit confused because of the command-line-task reference, but this isn't actually a command-line task. So this link may break in the future.
There was a problem hiding this comment.
True, but right now those are the only docs at https://pipelines.lsst.io/v/daily/modules/lsst.pipe.base/ that explain how task configs work.
| At present, the alert production pipeline is implemented using two separate frameworks that store and retrieve data from "Butler" repositories in incompatible ways: | ||
| At present, the alert production pipeline is implemented using the Gen 3 framework: | ||
|
|
||
| - `ApPipeTask` is an `lsst.pipe.base.CmdLineTask` that reads and writes data using the :ref:`lsst.daf.persistence` package. | ||
| This is the established "Gen 2" framework. | ||
| - ``ApPipe`` is an `lsst.pipe.base.Pipeline` that reads and writes data using the :ref:`lsst.daf.butler` package. | ||
| This "Gen 3" framework is expected to be the only implementation in the future. |
There was a problem hiding this comment.
This whole intro ought to be rewritten to be less Gen 2-centric, but I'm fine with deferring that.
| getting-started-gen2 | ||
| pipeline-tutorial-gen2 | ||
| apdb | ||
|
|
||
| .. _lsst.ap.pipe-using: | ||
|
|
||
| .. _lsst.ap.pipe-using-gen3: |
There was a problem hiding this comment.
I'd suggest also removing the "Command Line Task Reference" section starting on new line 64. If this package is now Gen 3 only, then it will never be needed.
erykoff
force-pushed
the
tickets/DM-33254
branch
from
30dc20b
to
26de890
Compare
| from lsst.ap.pipe import ApPipeTask | ||
|
|
||
| if __name__ == '__main__': | ||
| ApPipeTask.parseAndRun() |
There was a problem hiding this comment.
Oops! Overlooked this one. 🙂
|
Thanks for the doc review! Yes, I had run |
doc/lsst.ap.pipe/apdb.rst
Outdated
| config.db_url = "sqlite:///databases/apdb.db" | ||
|
|
||
| .. prompt:: bash | ||
|
|
||
| make_apdb.py -C myApdbConfig.py | ||
| ap_pipe.py repo --calib repo/calibs --rerun myrun -C myApPipeConfig.py --id [optional ID to process] | ||
| pipetask run -p ApPipe.yaml -C myApPipeConfig.py |
There was a problem hiding this comment.
| pipetask run -p ApPipe.yaml -C myApPipeConfig.py | |
| pipetask run -p ApPipe.yaml -C myApPipeConfig.py -b repo -o myrun |
erykoff
force-pushed
the
tickets/DM-33254
branch
from
e7bdd02
to
4f3ed1b
Compare
No description provided.