========
pyregion
========

:Release: |version|
:Date: |today|

pyregion is a python module to parse ds9 region files.
It also supports ciao region files.

.. note::

    See also the in-development ``regions`` package
    at https://github.com/astropy/regions
    a new astronomy package for regions based on Astropy.


+----------------------------------------+----------------------------------------+
| ds9                                    | pyregion + matplotlib                  |
+========================================+========================================+
| .. image::    _static/region_ds9.jpg   | .. image::    _static/region_mpl.png   |
|   :width: 300px                        |   :width: 300px                        |
|   :target:    static/region_ds9.jpg    |   :target:    static/region_mpl.png    |
+----------------------------------------+----------------------------------------+


Documentation
=============

.. toctree::
   :maxdepth: 1

   installation
   getting_started
   examples
   api
   changelog
