Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 3.07 KB

README.rst

File metadata and controls

64 lines (40 loc) · 3.07 KB
Raw

cell_coadds

build coverage

cell_coadds is a package in the LSST Science Pipelines.

It includes the data structures for defining coadds of astronomical images in small (few arcsecond) cells, in which only input images that fully contain a cell are included. This helps mitigate problems with PSF discontinuities that are present in traditional coadds.

To import this package, setup the package in your environment and then run:

>>> import lsst.cell_coadds

Development workflow

This package currently relies extensively on GitHub Actions for CI, which test it against the stackvana conda-forge distribution of the latest weekly release of the LSST Science Pipelines.

Development uses a number of tools that are not in broad use in the LSST codebase (and enforces their use in CI); in some respects this package can be considered a pilot program for using them more broadly, but in the meantime the CI checks that utilize these tools require some special care for developers unfamiliar with them. They include:

  • Python formatting via black and isort.

    LSST developers should install these into their conda environment (using the conda-forge channel, as usual) and run

    $ isort python/ tests/
$ black python/ tests/

    prior to each commit.

  • Python static type-checking via MyPy.

    MyPy is also available from conda-forge. Run it here with:

    $ mypy python/ tests/

The best way to use all of these tools is via editor integrations, which should be possible for all major editors (refer to our developer guide for editor configurations). All necessary configuration files for these tools are included in the repository (pyproject.toml, mypy.ini etc.), and these configurations should be allowed to take precedence over any others to ensure the CI checks that use those configurations are satisfied. Additionally, you may install a pre-commit hook to ensure that the staged changes are in accordance with these conventions.

$ pip install pre-commit
$ pre-commit install

Because the CI on Github Actions can take a long time, auto-merge is enabled for this repository. As an extra safeguard, an approval is required before merging unlike other LSST repositories. since it is common for reviewers to approve PRs after suggesting minor changes, the auto-merge option must be used only after the reviewer's comments are addressed.