Warning

This regions package is in a very early stage of development. It is neither feature complete nor API stable! That said, please have a look and try to use it for your applications. Feedback and contributions are welcome!

Astropy Regions Documentation

This is an in-development affiliated package of Astropy for region handling.

To get an overview of available features, see Getting started.

The goal is to merge the functionality from pyregion and photutils apertures and then after some time propose this package for inclusion in the Astropy core.

Reporting Issues

If you have found a bug in Regions please report it by creating a new issue on the Regions GitHub issue tracker.

Please include an example that demonstrates the issue that will allow the developers to reproduce and fix the problem. You may also be asked to provide information about your operating system and a full Python stack trace. The developers will walk you through obtaining a stack trace if it is necessary.

Astropy Regions uses a package of utilities called astropy-helpers during building and installation. If you have any build or installation issue mentioning the astropy_helpers or ah_bootstrap modules please send a report to the astropy-helpers issue tracker. If you are unsure, then it’s fine to report to the main Regions issue tracker.

Contributing

Like the Astropy project, Regions is made both by and for its users. We accept contributions at all levels, spanning the gamut from fixing a typo in the documentation to developing a major new feature. We welcome contributors who will abide by the Python Software Foundation Code of Conduct. If you have a feature request or would like to contribute to regions, please go here: https://github.com/astropy/regions/

Regions follows the same workflow and coding guidelines as Astropy. The following pages will help you get started with contributing fixes, code, or documentation (no git or GitHub experience necessary):

Get Help

Besides github, you can get help from the community in a number of ways. There is also a slack channel for regions hosted under the main astropy slack.