search

astropy / regions

Astropy package for region handling
https://astropy-regions.readthedocs.io
BSD 3-Clause "New" or "Revised" License
61 stars 55 forks source link
astronomy astropy astropy-affiliated region

readme

======= Regions

|PyPI Version| |Conda Version| |Astropy|

|CI Status| |Codecov Status| |Latest RTD Status|

Regions is an Astropy_ package for region handling.

Please see the online documentation <https://astropy-regions.readthedocs.io> for installation instructions <https://astropy-regions.readthedocs.io/en/stable/install.html> and usage information.

Citing Regions

|Zenodo|

If you use Regions for a project that leads to a publication, whether directly or as a dependency of another package, please include the following acknowledgment::

This research made use of Regions, an Astropy package for region
handling (Bradley et al. 202X).

where (Bradley et al. 202X) is a citation to the Zenodo record <https://doi.org/10.5281/zenodo.5826358> of the Regions version that was used. We also encourage citations in the main text wherever appropriate. Please see the CITATION <https://github.com/astropy/regions/blob/main/regions/CITATION.rst> file for details and an example BibTeX entry.

License

Regions is licensed under a BSD 3-clause license. Please see the LICENSE <https://github.com/astropy/regions/blob/main/LICENSE.rst>_ file for details.

.. |PyPI Version| image:: https://img.shields.io/pypi/v/regions.svg?logo=pypi&logoColor=white&label=PyPI :target: https://pypi.org/project/regions/ :alt: PyPI Latest Release

.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/regions?label=conda%20package :target: https://anaconda.org/conda-forge/regions :alt: Conda Latest Release

.. |Astropy| image:: https://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat :target: https://www.astropy.org/ :alt: Powered by Astropy

.. |Zenodo| image:: https://zenodo.org/badge/35690635.svg :target: https://zenodo.org/badge/latestdoi/35690635

.. |CI Status| image:: https://github.com/astropy/regions/workflows/CI%20Tests/badge.svg# :target: https://github.com/astropy/regions/actions :alt: CI Status

.. |Codecov Status| image:: https://img.shields.io/codecov/c/github/astropy/regions?logo=codecov :target: https://codecov.io/gh/astropy/regions :alt: Coverage Status

.. |Stable RTD Status| image:: https://img.shields.io/readthedocs/astropy-regions/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=stable :target: https://astropy-regions.readthedocs.io/en/stable/ :alt: Stable Documentation Status

.. |Latest RTD Status| image:: https://img.shields.io/readthedocs/astropy-regions/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=latest :target: https://astropy-regions.readthedocs.io/en/latest/ :alt: Latest Documentation Status

.. _Astropy: https://www.astropy.org/