https://github.com/lsst/cell_coadds

LSST Data Management: Data Structures defining the cell-based coadds
https://github.com/lsst/cell_coadds

astronomy data-structures python

Last synced: about 2 months ago
JSON representation

LSST Data Management: Data Structures defining the cell-based coadds

• Host: GitHub
• URL: https://github.com/lsst/cell_coadds
• Owner: lsst
• License: gpl-3.0
• Created: 2021-10-26T15:57:23.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-11T19:09:27.000Z (4 months ago)
• Last Synced: 2024-09-12T05:00:20.843Z (4 months ago)
• Topics: astronomy, data-structures, python
• Language: Python
• Homepage:
• Size: 427 KB
• Stars: 2
• Watchers: 11
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
###########

cell_coadds

###########

|build|

|coverage|

.. |build| image:: https://github.com/lsst/cell_coadds/actions/workflows/test.yaml/badge.svg?branch=main

   :target: https://github.com/lsst/cell_coadds/actions/workflows/test.yaml

.. |coverage| image:: https://codecov.io/github/lsst/cell_coadds/branch/main/graph/badge.svg

   :target: https://codecov.io/github/lsst/cell_coadds

``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:

.. code-block:: python

    >>> 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

    .. code-block:: sh

        $ 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:

    .. code-block:: sh

        $ 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.

.. code-block:: sh

    $ 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**.