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>`_
Raw data
{
"_id": null,
"home_page": "http://github.com/grahambell/pymoc",
"name": "pymoc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Graham Bell",
"author_email": "g.bell@eaobservatory.org",
"download_url": "https://files.pythonhosted.org/packages/2e/20/558e0b0e919a62651ea41563466612610c0dd8d0a31e8e84a6664e361b95/pymoc-0.5.2.tar.gz",
"platform": null,
"description": "Multi-Order Coverage map module for Python\n==========================================\n\nIntroduction\n------------\n\n.. startpymocintro\n\nPyMOC is a module for manipulating Multi-Order Coverage (MOC)\nmaps. It includes support for reading and writing the three\nencodings mentioned in the IVOA recommendation: FITS, JSON\nand ASCII.\n\nPyMOC also includes a utility program ``pymoctool`` to allow\nMOC files to be manipulated from the command line.\n\n.. endpymocintro\n\n.. startpymocinstall\n\nInstallation\n------------\n\nThe module can be installed using the ``setup.py`` script::\n\n python setup.py install\n\nUnit Tests\n~~~~~~~~~~\n\nPrior to installation, the unit tests can be run using::\n\n PYTHONPATH=lib python3 -m unittest\n\nor::\n\n PYTHONPATH=lib python2 -m unittest discover\n\nThe `test-extra` directory contains additional tests which may take\nlonger to perform. You can exclude these by specifying just the\nplain `test` directory, for example with::\n\n PYTHONPATH=lib python -m unittest discover -s test\n\nThe routines included in the doctests should also be covered by\nthe unit tests. However to ensure the documentation is correct,\nthey can be checked with::\n\n sphinx-build -b doctest doc doc/_build/doctest\n\nRequirements\n~~~~~~~~~~~~\n\nFor reading and writing data in FITS format, the ``astropy``\nlibrary is required.\n\n``Healpy`` is needed for some of the utility functions such as\n``plot_moc`` and ``catalog_to_moc``.\n\n.. endpymocinstall\n\nLicense\n-------\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n\nAdditional Links\n----------------\n\n* `Documentation at Read the Docs <http://pymoc.readthedocs.io/en/latest/>`_\n* `Repository at GitHub <https://github.com/grahambell/pymoc>`_\n* `Entry on PyPI <https://pypi.python.org/pypi/pymoc>`_",
"bugtrack_url": null,
"license": null,
"summary": "Multi-Order Coverage map module for Python",
"version": "0.5.2",
"project_urls": {
"Homepage": "http://github.com/grahambell/pymoc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e20558e0b0e919a62651ea41563466612610c0dd8d0a31e8e84a6664e361b95",
"md5": "1c7a17bc02f8cff72cad1c30af9696cd",
"sha256": "ce0fbda3cadfbd0899a9aaf7cfaecdcf59438ca8db9349786a1f133d1bc7e632"
},
"downloads": -1,
"filename": "pymoc-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "1c7a17bc02f8cff72cad1c30af9696cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33741,
"upload_time": "2024-08-02T20:05:06",
"upload_time_iso_8601": "2024-08-02T20:05:06.724889Z",
"url": "https://files.pythonhosted.org/packages/2e/20/558e0b0e919a62651ea41563466612610c0dd8d0a31e8e84a6664e361b95/pymoc-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 20:05:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grahambell",
"github_project": "pymoc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pymoc"
}
JSON
