1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
.. _install:
************
Installation
************
Stable version
==============
Installing the latest stable version is possible either using pip or conda.
Using pip
---------
To install pyregion with `pip <http://www.pip-installer.org/en/latest/>`_
from `PyPI <https://pypi.python.org/pypi/pyregion>`_
simply run::
pip install pyregion
Using conda
-----------
To install regions with `Anaconda <https://www.continuum.io/downloads>`_
from the `conda-forge channel on anaconda.org <https://anaconda.org/conda-forge/pyregion>`__
simply run::
conda install -c conda-forge pyregion
Testing installation
--------------------
To check if your install is OK, install the test dependencies and run the tests:
.. code-block:: bash
pip install "pyregion[test]"
pytest --pyargs pyregion
Development version
===================
Install the latest development version from https://github.com/astropy/pyregion :
.. code-block:: bash
git clone https://github.com/astropy/pyregion
cd pyregion
pip install -e .[test]
pytest
cd docs
make html
Dependencies
============
Python 3.7+ is supported.
``pyregion`` has the following required dependencies:
* `Astropy <http://www.astropy.org/>`__ version 4.0 or later (which requires Numpy)
* ``pyparsing`` version 2.0 or later for parsing the DS9 region files
* `Homepage <http://pyparsing.wikispaces.com/>`__
* `PyPI page <https://pypi.python.org/pypi/pyparsing>`__
``pyregion`` has the following optional dependencies for plotting:
* `matplotlib <http://matplotlib.org/>`__
To work with the development version, you'll need a C compiler,
because the code to generate masks from regions is written in Cython.
|
