This page coordinates the migration of our Science Pipelines packages to integrate with the https://pipelines.lsst.io build. There are two parts to this migration:
- Upgrade the doc/ directory to include Sphinx boilerplate. Put a check mark in the "doc/ status" column once your package is sphinx buildable and pushed to master.
- (Note: most of the green checks below as of the end of the day 3/9/18 seem to indicate the package is sphinx buildable and pushed to a `u/user/sphinx-docs` branch but not yet pushed to master)
- Upgrade the Python docstrings of packages to the Numpydoc style. Put a check mark in the "numpydoc status" column once all of your package's python is converted to numpydoc.
Instructions for the JTM 2018 hack day are here. Be aware they are obsolete for future work.
Use the label NUMPYDOC in Jira to identify tickets for this work. Here are the currently outstanding tickets:
Packages in lsst_apps
This is the contents of lsst_apps as of w_2018_37, minus externals. These are the highest priority: work on these first.
Package | doc/ status | numpdoc status | Tickets | Notes |
---|---|---|---|---|
afw | Partial | - DM-16855Getting issue details... STATUS - DM-16856Getting issue details... STATUS - DM-16857Getting issue details... STATUS - DM-16858Getting issue details... STATUS - DM-16859Getting issue details... STATUS - DM-16860Getting issue details... STATUS - DM-14135Getting issue details... STATUS - DM-16861Getting issue details... STATUS - DM-16862Getting issue details... STATUS - DM-16863Getting issue details... STATUS | ||
astshim | No Python code — conversion unnecessary | |||
base | ||||
coadd_chisquared | ||||
coadd_utils | Initial conversion by David Staker. | |||
daf_base | Initial conversion by David Staker. | |||
daf_butler | ||||
daf_persistence | To be removed; ignore this package. | |||
display_ds9 | Initial conversion by David Staker | |||
geom | No Python code — conversion unnecessary aside from setting up Sphinx | |||
ip_diffim | Initial conversion by David Staker. | |||
ip_isr | ||||
log | ||||
meas_algorithms | Taken by Nate Lust | |||
meas_astrom | Initial conversion by David Staker. | |||
meas_base | ||||
meas_deblender | Scons fail (DM-16901 to fix) | |||
meas_extensions_astrometryNet | Initial conversion by David Staker. | |||
meas_extensions_psfex | Taken by Dan Taranu | |||
meas_extensions_simpleShape | No Python code — conversion unnecessary | |||
meas_modelfit | No Python code — conversion unnecessary | |||
obs_base | ||||
obs_lsstSim | Likely to be deprecated; ignore for now. | |||
obs_sdss | Initial conversion by David Staker. | |||
obs_test | Initial conversion by David Staker. | |||
pex_config | Ready for review. | |||
pex_exceptions | No Python code — conversion unnecessary? (check!) | |||
pex_policy | To be removed; ignore this package. | |||
pipe_base | ||||
pipe_tasks | ||||
sconsUtils | ||||
shapelet | Starter project for Unknown User (gkovacs) . | |||
skymap | ||||
sphgeom | No Python code — conversion unnecessary? | |||
utils |
Other Packages
Package | doc/ status | numpydoc status | Tickets | Notes / Current Worker |
---|---|---|---|---|
ap_assoc | DM-13916 | |||
pex_logging | SKIP: DEPRECATED! | |||
db | ||||
cat | ||||
cp_pipe | ||||
ctrl_events | ||||
ctrl_pool | ||||
ctrl_orca | ||||
ctrl_provenance | ||||
ctrl_stats | ||||
ctrl_execute | ||||
ctrl_platform_lsst | ||||
ctrl_platform_gordon | ||||
meas_extensions_photometryKron | DM-13996 | |||
meas_extensions_shapeHSM | DM-13996 | Ian Sullivan | ||
meas_extensions_ngmix | ||||
pipe_supertask | ||||
jointcal | u/parejkoj/sphinx-docs | |||
obs_subaru | ||||
obs_decam | ||||
obs_cfht | DM-13941 | |||
obs_comCam | ||||
ci_hsc | ||||
validate_drp | u/parejkoj/sphinx-docs | |||
obs_monocam | ||||
pipe_drivers | DM-13941 | 1: John Parejko | ||
daf_ingest | Ported to Python3. | |||
verify |