Details
-
Type:
RFC
-
Status: Implemented
-
Resolution: Done
-
Component/s: DM
-
Labels:None
Description
As decided at yesterday DMLT meeting the time-critical part of the PPDB is to be called APDB and we should also rename all related things to be consistent with that name change. Fortunately there is not many packages that have `ppdb` in their name (just one) and there seem to be just few dependencies and they all need to be updated to. Here is what quick github search shows for packages that import dax.ppdb:
- ap_association, ap_pipe – our main customers
- verify
- lsst-dm/ap_pipe-notebooks
- lsst-dm/l1dbproto – this is my own code used for prototyping
- DMTN-113 and DMTN-098
In some instances ppdb appears not only as the reference to the imported dax.ppdb package but also in the names of the applications, modules, or public classes, e.g. lsst/ap/pipe/make_ppdb.py
The proposal for how to rename all these is:
- dax_ppdb is naturally renamed to dax_apdb.
- In dax_apdb all modules/classes with ppdb in the name are renamed.
- In all dependent packages imports of lsst.dax.ppdb renamed to lsst.dax.apdb
- In all dependent packages modules and classes that have ppdb in the name are renamed too.
- I'm going to update lsst-dm/l1dbproto myself but will not touch lsst-dm/ap_pipe-notebooks as I guess it contains notebooks and that needs to be tested in Jupyter.
- DMTNs will not be changed for now.
P.S. I expect the new name (APDB) will cause much confusion, if pronounced "correctly" it will be confused with "a pdb" (with obvious question how Python debugger helps here?) I think less confusing way to say it is like "ape db", so this is what I'm going to practice.
Attachments
Issue Links
Activity
Indeed, sorry, I'm adding more confusion myself, will update it.
This rename sounds reasonable to me, and better now than later!
The notebooks in `lsst-dm/ap_pipe-notebooks` aren't intended to be supported indefinitely, but the small-and-growing collection of python scripts will need to be updated. They include `plotLightcurve.py`, `diaObjectAnalysis.py`, and I was about to call the next one `ppdbPlots.py` but I know better so I will call it `apdbPlots.py`!
As you say, anyone who runs `ap_pipe` will also need to know that the prerequisite command is changing to `make_apdb.py`, so we should make sure to update the docs in tandem with the code.
Yes, agree with the docs and should have mentioned that explicitly. Plan is to change not only Python code but also all docs (rst files) in those packages too.
Notebooks that are intended to run against the public difference imaging data products should continue to refer to the PPDB and use relational mechanisms. Only those referencing the internal time-sensitive production "database" need to change.
I realize that one consequence of changing the name before we have an implementation solidified is that we might end up with (for example) one tool for slowly-changing data and a different tool for intra-night rapidly-changing data. Maybe it's ok to group those together as "the APDB", or maybe we'll want to mostly use more specific names if we end up going down that route? Or maybe we won't end up doing that at all. I'm not strongly opposed to renaming now, but it's definitely possible that even after this change we'll need more renaming in the future too.
Verbally, I expect the "AP Database" to be clearer than the "Ape DB".
Colin Slater
added a comment - I realize that one consequence of changing the name before we have an implementation solidified is that we might end up with (for example) one tool for slowly-changing data and a different tool for intra-night rapidly-changing data. Maybe it's ok to group those together as "the APDB", or maybe we'll want to mostly use more specific names if we end up going down that route? Or maybe we won't end up doing that at all. I'm not strongly opposed to renaming now, but it's definitely possible that even after this change we'll need more renaming in the future too.
Verbally, I expect the "AP Database" to be clearer than the "Ape DB". Adopting with all comments and understanding that more renaming may be needed as things become clearer.
Note also that APDB interface is likely going to change as we move from relational database implementation to something else.
I suggest asking Meredith Rawls about lsst-dm/ap_pipe-notebooks.
I'm confused by the postscript. Did you mean pronunciation rather than spelling?