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
73
74
75
76
77
78
79
80
81
82
83
|
Multi-Order Coverage map module for Python
==========================================
Introduction
------------
.. startpymocintro
PyMOC is a module for manipulating Multi-Order Coverage (MOC)
maps. It includes support for reading and writing the three
encodings mentioned in the IVOA recommendation: FITS, JSON
and ASCII.
PyMOC also includes a utility program ``pymoctool`` to allow
MOC files to be manipulated from the command line.
.. endpymocintro
.. startpymocinstall
Installation
------------
The module can be installed using the ``setup.py`` script::
python setup.py install
Unit Tests
~~~~~~~~~~
Prior to installation, the unit tests can be run using::
PYTHONPATH=lib python3 -m unittest
or::
PYTHONPATH=lib python2 -m unittest discover
The `test-extra` directory contains additional tests which may take
longer to perform. You can exclude these by specifying just the
plain `test` directory, for example with::
PYTHONPATH=lib python -m unittest discover -s test
The routines included in the doctests should also be covered by
the unit tests. However to ensure the documentation is correct,
they can be checked with::
sphinx-build -b doctest doc doc/_build/doctest
Requirements
~~~~~~~~~~~~
For reading and writing data in FITS format, the ``astropy``
library is required.
``Healpy`` is needed for some of the utility functions such as
``plot_moc`` and ``catalog_to_moc``.
.. endpymocinstall
License
-------
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Additional Links
----------------
* `Documentation at Read the Docs <http://pymoc.readthedocs.io/en/latest/>`_
* `Repository at GitHub <https://github.com/grahambell/pymoc>`_
* `Entry on PyPI <https://pypi.python.org/pypi/pymoc>`_
|
