.. image:: https://github.com/nanograv/PINT/blob/master/docs/logo/PINT_LOGO_128trans.png
:alt: PINT Logo
:align: right
PINT
====
.. image:: https://github.com/nanograv/pint/workflows/CI%20Tests/badge.svg
:target: https://github.com/nanograv/pint/actions
:alt: Actions Status
.. image:: https://codecov.io/gh/nanograv/PINT/branch/master/graph/badge.svg?token=xIOFqcKKrP
:target: https://codecov.io/gh/nanograv/PINT
:alt: Coverage
.. image:: https://readthedocs.org/projects/nanograv-pint/badge/?version=latest
:target: https://nanograv-pint.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/arXiv-2012.00074-red
:target: https://arxiv.org/abs/2012.00074
:alt: PINT Paper on arXiv
.. image:: https://img.shields.io/badge/ascl-1902.007-blue.svg?colorB=262255
:target: https://www.ascl.net/1902.007
:alt: PINT on ASCL
.. image:: https://img.shields.io/pypi/l/pint-pulsar
:target: https://github.com/nanograv/PINT/blob/master/LICENSE.md
:alt: License:BSD
.. image:: https://img.shields.io/badge/code_of_conduct-Contributor_Covenant-blue.svg
:target: https://github.com/nanograv/PINT/blob/master/CODE_OF_CONDUCT.md
:alt: Code of Conduct
PINT is not TEMPO3
------------------
PINT is a project to develop a pulsar timing solution based on
python and modern libraries. It is still in active development,
but it is in production use by the NANOGrav collaboration and
it has been demonstrated produce residuals from most "normal"
timing models that agree with Tempo and Tempo2 to within ~10
nanoseconds. It can be used within python scripts or notebooks,
and there are several command line tools that come with it.
The primary reasons PINT was developed are:
* To have a robust system to produce high-precision timing results that is
completely independent of TEMPO and Tempo2
* To make a system that is easy to extend and modify due to a good design
and the use of a modern programming language, techniques, and libraries.
IMPORTANT Notes!
----------------
PINT has a naming conflict with the `pint <https://pypi.org/project/Pint/>`_ units package available from PyPI (i.e. using pip) and conda.
Do **NOT** ``pip install pint`` or ``conda install pint``! See below!
PINT requires ``longdouble`` (80- or 128-bit floating point) arithmetic within ``numpy``, which is currently not supported natively on M1/M2/M3 Macs.
However, you can use an x86 version of ``conda`` even on an M1/M2/M3 Mac (which will run under Rosetta emulation):
see `instructions for using Apple Intel packages on Apple
silicon <https://conda-forge.org/docs/user/tipsandtricks.html#installing-apple-intel-packages-on-apple-silicon>`_.
It's possible to have `parallel versions of conda for x86 and
ARM <https://towardsdatascience.com/python-conda-environments-for-both-arm64-and-x86-64-on-m1-apple-silicon-147b943ffa55>`_.
Installing
----------
.. image:: https://anaconda.org/conda-forge/pint-pulsar/badges/version.svg
:target: https://anaconda.org/conda-forge/pint-pulsar
:alt: Conda Version
.. image:: https://img.shields.io/pypi/v/pint-pulsar.svg
:target: https://pypi.python.org/pypi/pint-pulsar
:alt: PyPI
.. image:: https://img.shields.io/pypi/pyversions/pint-pulsar.svg
:target: https://pypi.python.org/pypi/pint-pulsar
:alt: PyVersions
PINT is now available via PyPI as the package `pint-pulsar <https://pypi.org/project/pint-pulsar>`_, so it is now simple to install via pip.
For most users, who don't want to develop the PINT code, installation should just be a matter of::
$ pip install pint-pulsar
By default this will install in your system site-packages. Depending on your system and preferences, you may want to append ``--user``
to install it for just yourself (e.g. if you don't have permission to write in the system site-packages), or you may want to create a
virtualenv to work on PINT (using a virtualenv is highly recommended by the PINT developers).
PINT is also available for Anaconda python under the conda-forge channel::
$ conda install -c conda-forge pint-pulsar
The above two options install the latest *released* version. If you want access to the latest development version,
the source code, example notebooks, and tests, you can install from source, by
cloning the source repository from GitHub, then install
it, ensuring that all dependencies needed to run PINT are available::
$ git clone https://github.com/nanograv/PINT.git
$ cd PINT
$ pip install .
Complete installation instructions are available on `readthedocs <https://nanograv-pint.readthedocs.io/en/latest/installation.html>`_.
Using
-----
See the online documentation_. Specifically:
* `Tutorials <https://nanograv-pint.readthedocs.io/en/latest/tutorials.html>`_
* `API reference <https://nanograv-pint.readthedocs.io/en/latest/reference.html>`_
* `How-Tos for common tasks <https://github.com/nanograv/PINT/wiki/How-To>`_
Are you a NANOGrav member? Then join the #pint channel in the NANOGrav slack.
If you have tasks that aren't covered in the material above, you can
email pint@nanograv.org or one of the people below:
* Scott Ransom (sransom@nrao.edu)
* Paul Ray (paul.s.ray3.civ@us.navy.mil)
* David Kaplan (kaplan@uwm.edu)
Want to do something new? Submit a github `issue <https://github.com/nanograv/PINT/issues>`_.
.. _documentation: http://nanograv-pint.readthedocs.io/en/latest/
And for more details, please read and cite(!) the PINT paper_.
.. _paper: https://ui.adsabs.harvard.edu/abs/2021ApJ...911...45L/abstract
Articles that cite the PINT paper can be found in an ADS `Library <https://ui.adsabs.harvard.edu/search/q=citations(bibcode%3A2021ApJ...911...45L)&sort=date%20desc%2C%20bibcode%20desc&p_=0>`_.
A list of software packages that use PINT can be found `here <https://nanograv-pint.readthedocs.io/en/latest/dependent-packages.html>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/nanograv/PINT",
"name": "pint-pulsar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Luo Jing, Scott Ransom, Paul Demorest, Paul Ray, et al.",
"author_email": "sransom@nrao.edu",
"download_url": "https://files.pythonhosted.org/packages/1d/13/01fe8039aa8025fc0b4c916393d572a4b5044a81fff0feaaefa0c50fb432/pint-pulsar-1.0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/nanograv/PINT/blob/master/docs/logo/PINT_LOGO_128trans.png\n :alt: PINT Logo\n :align: right\n\nPINT\n====\n\n.. image:: https://github.com/nanograv/pint/workflows/CI%20Tests/badge.svg\n :target: https://github.com/nanograv/pint/actions\n :alt: Actions Status\n\n.. image:: https://codecov.io/gh/nanograv/PINT/branch/master/graph/badge.svg?token=xIOFqcKKrP\n :target: https://codecov.io/gh/nanograv/PINT\n :alt: Coverage\n \n.. image:: https://readthedocs.org/projects/nanograv-pint/badge/?version=latest\n :target: https://nanograv-pint.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/arXiv-2012.00074-red\n :target: https://arxiv.org/abs/2012.00074\n :alt: PINT Paper on arXiv\n\n.. image:: https://img.shields.io/badge/ascl-1902.007-blue.svg?colorB=262255\n :target: https://www.ascl.net/1902.007\n :alt: PINT on ASCL\n\n.. image:: https://img.shields.io/pypi/l/pint-pulsar\n :target: https://github.com/nanograv/PINT/blob/master/LICENSE.md\n :alt: License:BSD\n\n.. image:: https://img.shields.io/badge/code_of_conduct-Contributor_Covenant-blue.svg\n :target: https://github.com/nanograv/PINT/blob/master/CODE_OF_CONDUCT.md\n :alt: Code of Conduct\n\nPINT is not TEMPO3\n------------------\n\nPINT is a project to develop a pulsar timing solution based on\npython and modern libraries. It is still in active development,\nbut it is in production use by the NANOGrav collaboration and\nit has been demonstrated produce residuals from most \"normal\"\ntiming models that agree with Tempo and Tempo2 to within ~10\nnanoseconds. It can be used within python scripts or notebooks,\nand there are several command line tools that come with it.\n\nThe primary reasons PINT was developed are:\n\n* To have a robust system to produce high-precision timing results that is\n completely independent of TEMPO and Tempo2\n\n* To make a system that is easy to extend and modify due to a good design\n and the use of a modern programming language, techniques, and libraries.\n\nIMPORTANT Notes!\n----------------\n\nPINT has a naming conflict with the `pint <https://pypi.org/project/Pint/>`_ units package available from PyPI (i.e. using pip) and conda. \nDo **NOT** ``pip install pint`` or ``conda install pint``! See below!\n\nPINT requires ``longdouble`` (80- or 128-bit floating point) arithmetic within ``numpy``, which is currently not supported natively on M1/M2/M3 Macs. \nHowever, you can use an x86 version of ``conda`` even on an M1/M2/M3 Mac (which will run under Rosetta emulation): \nsee `instructions for using Apple Intel packages on Apple \nsilicon <https://conda-forge.org/docs/user/tipsandtricks.html#installing-apple-intel-packages-on-apple-silicon>`_. \nIt's possible to have `parallel versions of conda for x86 and \nARM <https://towardsdatascience.com/python-conda-environments-for-both-arm64-and-x86-64-on-m1-apple-silicon-147b943ffa55>`_.\n\n\nInstalling\n----------\n\n.. image:: https://anaconda.org/conda-forge/pint-pulsar/badges/version.svg\n :target: https://anaconda.org/conda-forge/pint-pulsar\n :alt: Conda Version\n\n.. image:: https://img.shields.io/pypi/v/pint-pulsar.svg\n :target: https://pypi.python.org/pypi/pint-pulsar\n :alt: PyPI\n\n.. image:: https://img.shields.io/pypi/pyversions/pint-pulsar.svg\n :target: https://pypi.python.org/pypi/pint-pulsar\n :alt: PyVersions\n\nPINT is now available via PyPI as the package `pint-pulsar <https://pypi.org/project/pint-pulsar>`_, so it is now simple to install via pip.\nFor most users, who don't want to develop the PINT code, installation should just be a matter of::\n\n $ pip install pint-pulsar\n\nBy default this will install in your system site-packages. Depending on your system and preferences, you may want to append ``--user`` \nto install it for just yourself (e.g. if you don't have permission to write in the system site-packages), or you may want to create a \nvirtualenv to work on PINT (using a virtualenv is highly recommended by the PINT developers).\n\nPINT is also available for Anaconda python under the conda-forge channel::\n\n $ conda install -c conda-forge pint-pulsar\n\nThe above two options install the latest *released* version. If you want access to the latest development version, \nthe source code, example notebooks, and tests, you can install from source, by \ncloning the source repository from GitHub, then install\nit, ensuring that all dependencies needed to run PINT are available::\n\n $ git clone https://github.com/nanograv/PINT.git\n $ cd PINT\n $ pip install .\n\nComplete installation instructions are available on `readthedocs <https://nanograv-pint.readthedocs.io/en/latest/installation.html>`_.\n\n\nUsing\n-----\n\nSee the online documentation_. Specifically:\n\n* `Tutorials <https://nanograv-pint.readthedocs.io/en/latest/tutorials.html>`_\n* `API reference <https://nanograv-pint.readthedocs.io/en/latest/reference.html>`_\n* `How-Tos for common tasks <https://github.com/nanograv/PINT/wiki/How-To>`_\n\nAre you a NANOGrav member? Then join the #pint channel in the NANOGrav slack.\n \nIf you have tasks that aren't covered in the material above, you can\nemail pint@nanograv.org or one of the people below:\n\n* Scott Ransom (sransom@nrao.edu)\n* Paul Ray (paul.s.ray3.civ@us.navy.mil)\n* David Kaplan (kaplan@uwm.edu) \n\nWant to do something new? Submit a github `issue <https://github.com/nanograv/PINT/issues>`_.\n \n.. _documentation: http://nanograv-pint.readthedocs.io/en/latest/\n\nAnd for more details, please read and cite(!) the PINT paper_.\n\n.. _paper: https://ui.adsabs.harvard.edu/abs/2021ApJ...911...45L/abstract\n\nArticles that cite the PINT paper can be found in an ADS `Library <https://ui.adsabs.harvard.edu/search/q=citations(bibcode%3A2021ApJ...911...45L)&sort=date%20desc%2C%20bibcode%20desc&p_=0>`_.\nA list of software packages that use PINT can be found `here <https://nanograv-pint.readthedocs.io/en/latest/dependent-packages.html>`_.\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: BSD License",
"summary": "A Pulsar Timing Package, written in Python from scratch",
"version": "1.0",
"project_urls": {
"Documentation": "https://nanograv-pint.readthedocs.io/",
"Homepage": "https://github.com/nanograv/PINT"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80fdd4ed923c57b9936ac61d42a755af463053b6c0d4d91e0e988c6dc4b1adf7",
"md5": "b5037a38ca376277673291ed76d28d0d",
"sha256": "8162b3d64bd674c8ac76ff3a9e3e32d418fa9a37eb75e0a9f9ac0dd39d941afd"
},
"downloads": -1,
"filename": "pint_pulsar-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5037a38ca376277673291ed76d28d0d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11740580,
"upload_time": "2024-04-26T18:07:41",
"upload_time_iso_8601": "2024-04-26T18:07:41.922326Z",
"url": "https://files.pythonhosted.org/packages/80/fd/d4ed923c57b9936ac61d42a755af463053b6c0d4d91e0e988c6dc4b1adf7/pint_pulsar-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d1301fe8039aa8025fc0b4c916393d572a4b5044a81fff0feaaefa0c50fb432",
"md5": "9b4bbdbe17ed2f5e92d783c9f9cc51c9",
"sha256": "f19d71e032d6b7143c7089efddda2ea08a141623a546526dd1f6fdfa525aa0f5"
},
"downloads": -1,
"filename": "pint-pulsar-1.0.tar.gz",
"has_sig": false,
"md5_digest": "9b4bbdbe17ed2f5e92d783c9f9cc51c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20429243,
"upload_time": "2024-04-26T18:07:45",
"upload_time_iso_8601": "2024-04-26T18:07:45.362154Z",
"url": "https://files.pythonhosted.org/packages/1d/13/01fe8039aa8025fc0b4c916393d572a4b5044a81fff0feaaefa0c50fb432/pint-pulsar-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 18:07:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nanograv",
"github_project": "PINT",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pint-pulsar"
}
JSON
