{"author":"The PyERFA Developers","author_email":null,"bugtrack_url":null,"classifiers":["Intended Audience :: Science/Research","License :: OSI Approved :: BSD License","Operating System :: OS Independent","Programming Language :: C","Programming Language :: Python :: 3","Programming Language :: Python :: Implementation :: CPython","Topic :: Scientific/Engineering :: Astronomy","Topic :: Scientific/Engineering :: Physics"],"description":"======\nPyERFA\n======\n\n|PyPI Status| |Zenodo| |CI Status| |Documentation Status|\n\nPyERFA is the Python_ wrapper for the ERFA_ library (Essential Routines for\nFundamental Astronomy), a C library containing key algorithms for astronomy,\nwhich is based on the SOFA library published by the International Astronomical\nUnion (IAU). All C routines are wrapped as Numpy_ `universal functions\n`_, so that they can be\ncalled with scalar or array inputs.\n\nThe project is a split of ``astropy._erfa`` module, developed in the\ncontext of Astropy_ project, into a standalone package. It contains\nthe ERFA_ C source code as a git submodule. The wrapping is done\nwith help of the Jinja2_ template engine.\n\nIf you use this package in your research, please cita it via DOI\n`10.5281/zenodo.3940699 `_.\n\n.. Installation\n\nInstallation instructions\n-------------------------\n\nThe package can be installed from the package directory using a simple::\n\n $ pip install .\n\nand similarly a wheel_ can be created with::\n\n $ pip wheel .\n\n.. note:: If you already have the C library ``liberfa`` on your\n system, you can use that by setting environment variable\n ``PYERFA_USE_SYSTEM_LIBERFA=1``.\n\n\n.. _wheel: https://github.com/pypa/wheel\n\nThe package can be obtained from PyPI_ or directly from the git repository::\n\n $ git clone --recursive https://github.com/liberfa/pyerfa/\n\nThe package also has nightly wheel that can be obtained as follows::\n\n $ pip install --upgrade --index-url https://pypi.anaconda.org/liberfa/simple pyerfa --pre\n\nTesting\n-------\n\nFor testing, one can install the packages together with its testing\ndependencies and then test it with::\n\n $ pip install .[test]\n $ pytest\n\nAlternatively, one can use ``tox``, which will set up a separate testing\nenvironment for you, with::\n\n $ tox -e test\n\n\nUsage\n-----\n\nThe package can be imported as ``erfa`` which has all ERFA_ ufuncs wrapped with\npython code that tallies errors and warnings. Also exposed are the constants\ndefined by ERFA_ in `erfam.h\n`_, as well\nas `numpy.dtype` corresponding to structures used by ERFA_. Examples::\n\n >>> import erfa\n >>> erfa.jd2cal(2460000., [0, 1, 2, 3])\n (array([2023, 2023, 2023, 2023], dtype=int32),\n array([2, 2, 2, 2], dtype=int32),\n array([24, 25, 26, 27], dtype=int32),\n array([0.5, 0.5, 0.5, 0.5]))\n >>> erfa.plan94(2460000., [0, 1, 2, 3], 1)\n array([([ 0.09083713, -0.39041392, -0.21797389], [0.02192341, 0.00705449, 0.00149618]),\n ([ 0.11260694, -0.38275202, -0.21613731], [0.02160375, 0.00826891, 0.00217806]),\n ([ 0.13401992, -0.37387798, -0.21361622], [0.0212094 , 0.00947838, 0.00286503]),\n ([ 0.15500031, -0.36379788, -0.21040601], [0.02073822, 0.01068061, 0.0035561 ])],\n dtype={'names': ['p', 'v'], 'formats': [('>> erfa.dt_pv\n dtype([('p', '>> erfa.dt_eraLDBODY\n dtype([('bm', '>> erfa.DAYSEC\n 86400.0\n\nIt is also possible to use the ufuncs directly, though then one has to\ndeal with the warning and error states explicitly. For instance, compare::\n\n >>> erfa.jd2cal(-600000., [0, 1, 2, 3])\n Traceback (most recent call last):\n ...\n ErfaError: ERFA function \"jd2cal\" yielded 4 of \"unacceptable date (Note 1)\"\n >>> erfa.ufunc.jd2cal(-600000., [0, 1, 2, 3])\n (array([-1, -1, -1, -1], dtype=int32),\n ...,\n array([-1, -1, -1, -1], dtype=int32))\n\n\nLicense\n-------\n\nPyERFA is licensed under a 3-clause BSD style license - see the\n`LICENSE.rst `_ file.\n\n\n.. References\n.. _Python: https://www.python.org/\n.. _ERFA: https://github.com/liberfa/erfa\n.. _Numpy: https://numpy.org/\n.. _Astropy: https://www.astropy.org\n.. _PyPI: https://pypi.org/project/pyerfa/\n.. _Jinja2: https://palletsprojects.com/p/jinja/\n.. |PyPI Status| image:: https://img.shields.io/pypi/v/pyerfa.svg\n :target: https://pypi.python.org/pypi/pyerfa\n :alt: PyPI Status\n.. |Zenodo| image:: https://zenodo.org/badge/261332899.svg\n :target: https://zenodo.org/badge/latestdoi/261332899\n :alt: DOI 10.5281/zenodo.3940699\n.. |CI Status| image:: https://github.com/liberfa/pyerfa/workflows/CI/badge.svg\n :target: https://github.com/liberfa/pyerfa/actions\n :alt: GitHub Actions CI Status\n.. |Documentation Status| image:: https://img.shields.io/readthedocs/pyerfa/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=stable\n :target: https://pyerfa.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"astronomy, astrophysics, cosmology, space, science, coordinate","license":"BSD 3-Clause License","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"pyerfa","package_url":"https://pypi.org/project/pyerfa/","platform":null,"project_url":"https://pypi.org/project/pyerfa/","project_urls":{"Homepage":"https://github.com/liberfa/pyerfa"},"provides_extra":["docs","test"],"release_url":"https://pypi.org/project/pyerfa/2.0.1.5/","requires_dist":["numpy>=1.19.3","sphinx-astropy>=1.3; extra == \"docs\"","pytest; extra == \"test\"","pytest-doctestplus>=0.7; extra == \"test\""],"requires_python":">=3.9","summary":"Python bindings for ERFA","version":"2.0.1.5","yanked":false,"yanked_reason":null}

Dependency	Optional
numpy	false
pytest	true
pytest-doctestplus	true
sphinx-astropy	true

Package search

pyerfa

project_urls

Dependencies

All package metadata

Releases