Data

Tools

Indexes

Applications

Experiments

Open Source Science

pint-pulsar

PINT is not TEMPO3 -- Software for high-precision pulsar timing

https://github.com/nanograv/pint

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: arxiv.org
  • ✓
    Committers with academic emails
    28 of 82 committers (34.1%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.6%) to scientific vocabulary

Keywords from Contributors

astronomy astropy astrophysics closember pulsars gtk qt tk wx
Last synced: 7 months ago · JSON representation

Repository

PINT is not TEMPO3 -- Software for high-precision pulsar timing

Basic Info
  • Host: GitHub
  • Owner: nanograv
  • License: other
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 92.1 MB
Statistics
  • Stars: 133
  • Watchers: 19
  • Forks: 102
  • Open Issues: 180
  • Releases: 16
Created over 12 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Authors

README.rst 

.. 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 1 on arXiv

.. image:: https://img.shields.io/badge/arXiv-2405.01977-red
   :target: https://arxiv.org/abs/2405.01977
   :alt: PINT Paper 2 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 `_ 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 `_. 
It's possible to have `parallel versions of conda for x86 and 
ARM `_.


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 `_, 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 `_.


Using
-----

See the online documentation_. Specifically:

* `Tutorials `_
* `API reference `_
* `How-Tos for common tasks `_

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)  
* Abhimanyu Susobhanan (abhimanyu.susobhanan@nanograv.org)

Want to do something new? Submit a github `issue `_.
  
.. _documentation:   http://nanograv-pint.readthedocs.io/en/latest/

And for more details, please read and cite(!) the PINT paper_1_ and paper_2_.

.. _paper_1:   https://ui.adsabs.harvard.edu/abs/2021ApJ...911...45L/abstract
.. _paper_2:   https://ui.adsabs.harvard.edu/abs/2024ApJ...971..150S/abstract

Articles that cite the PINT paper can be found in an ADS `Library `_.
A list of software packages that use PINT can be found `here `_.

Owner

  • Name: NANOGrav
  • Login: nanograv
  • Kind: organization
  • Location: Various

GitHub Events

Total
  • Create event: 4
  • Release event: 4
  • Issues event: 52
  • Watch event: 14
  • Issue comment event: 194
  • Push event: 48
  • Pull request review event: 54
  • Pull request review comment event: 57
  • Pull request event: 84
  • Fork event: 4
Last Year
  • Create event: 4
  • Release event: 4
  • Issues event: 52
  • Watch event: 14
  • Issue comment event: 194
  • Push event: 48
  • Pull request review event: 54
  • Pull request review comment event: 57
  • Pull request event: 84
  • Fork event: 4

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 5,468
  • Total Committers: 82
  • Avg Commits per committer: 66.683
  • Development Distribution Score (DDS): 0.811
Past Year
  • Commits: 1,451
  • Committers: 23
  • Avg Commits per committer: 63.087
  • Development Distribution Score (DDS): 0.575
Top Committers
Name Email Commits
David Kaplan k****n@u****u 1,033
Paul Ray p****y@n****l 656
Jing Luo l****1@g****m 599
Abhimanyu Susobhanan a****l@g****m 459
luojing1211 j****o@J****l 441
Anne Archibald a****d@n****k 284
Scott Ransom s****m@n****u 279
Anne Archibald p****d@g****m 278
Chloe Champagne c****e@v****u 140
Anne Archibald a****d@a****l 138
Paul Demorest p****s@n****u 124
jingluo j****o@j****l 100
luojing1211 j****o@J****l 85
Matthew Kerr m****r@g****m 69
Alexander Eli McEwen a****n@u****u 64
Matteo Bachetti m****o@m****t 62
Ross Jennings r****s@g****m 60
jcolen j****n@v****u 45
Rutger van Haasteren v****n@g****m 41
Deven Bhakta d****g@v****u 36
luojing1211 j****o@J****l 35
Brent Shapiro-Albert b****t@B****l 30
Scott Ransom S****m@n****u 30
almcewen0 3****0@u****m 26
Camryn Phillips c****f@v****u 25
csheehy c****y@u****u 25
swiggumj s****j@g****m 23
Josef Zimmerman j****x@v****u 22
tcromartie t****e@g****m 21
Justin Ellis j****8@g****m 19
and 52 more...
Committer Domains (Top 20 + Academic)
virginia.edu: 5 uwm.edu: 3 nrao.edu: 3 nrl.navy.mil: 2 nanograv.org: 2 ncl.ac.uk: 1 vanderbilt.edu: 1 astron.nl: 1 matteobachetti.it: 1 uchicago.edu: 1 jingluos-air.aoc-vis.nrao.edu: 1 physik.rwth-aachen.de: 1 vsq-47.nmt.edu: 1 bjorns-mbp.lan: 1 astro.utoronto.ca: 1 dhcp-206-87-205-187.eduroam.wireless.ubc.ca: 1 irap.omp.eu: 1 mix.wvu.edu: 1 iu.edu: 1 jings-air.lan: 1 dhcp-206-87-204-240.eduroam.wireless.ubc.ca: 1 nimrod.cv.nrao.edu: 1 griz.astro.cornell.edu: 1 dhcp-206-87-204-42.eduroam.wireless.ubc.ca: 1 eduroamprvnat-172-16-57-71.near.illinois.edu: 1 ligo.org: 1 uconn.edu: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 171
  • Total pull requests: 161
  • Average time to close issues: over 1 year
  • Average time to close pull requests: about 2 months
  • Total issue authors: 37
  • Total pull request authors: 17
  • Average comments per issue: 2.71
  • Average comments per pull request: 4.73
  • Merged pull requests: 116
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 26
  • Pull requests: 31
  • Average time to close issues: 20 days
  • Average time to close pull requests: 14 days
  • Issue authors: 15
  • Pull request authors: 4
  • Average comments per issue: 0.88
  • Average comments per pull request: 1.23
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • abhisrkckl (66)
  • dlakaplan (38)
  • paulray (25)
  • aarchiba (19)
  • matteobachetti (8)
  • luojing1211 (8)
  • mtlam (5)
  • LuluAgazie (4)
  • tcromartie (4)
  • rossjjennings (4)
  • juliadeneva (3)
  • aplangrangian (2)
  • almcewen0 (2)
  • mdecesar (2)
  • devbhakt (2)
Pull Request Authors
  • abhisrkckl (113)
  • dlakaplan (84)
  • devbhakt (8)
  • aarchiba (7)
  • paulray (4)
  • kerrm (3)
  • vhaasteren (3)
  • munahaf (2)
  • rossjjennings (2)
  • scottransom (2)
  • matteobachetti (2)
  • coclar (2)
  • LuluAgazie (2)
  • blarsen10 (2)
  • poneill129 (2)
Top Labels
Issue Labels
enhancement (10) needs discussion (7) tabled (5) bug (3) awaiting review (3) feature request (3) student (2) upstream (1) GUI (1) wontfix (1) bug fix (1) minor (1)
Pull Request Labels
awaiting review (96) minor (20) bug fix (14) enhancement (7) tabled (3) needs discussion (3) GUI (3) pintk (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 2,200 last-month
  • Total docker downloads: 201
  • Total dependent packages: 11
    (may contain duplicates)
  • Total dependent repositories: 14
    (may contain duplicates)
  • Total versions: 39
  • Total maintainers: 2
pypi.org: pint-pulsar

A Pulsar Timing Package, written in Python from scratch

  • Versions: 28
  • Dependent Packages: 8
  • Dependent Repositories: 14
  • Downloads: 2,200 Last month
  • Docker Downloads: 201
Rankings
Dependent packages count: 1.3%
Docker downloads count: 3.4%
Dependent repos count: 3.9%
Average: 4.4%
Forks count: 4.6%
Downloads: 6.5%
Stargazers count: 6.7%
Maintainers (2)
nanograv AstroGlaser
Last synced: 7 months ago
conda-forge.org: pint-pulsar
  • Versions: 11
  • Dependent Packages: 3
  • Dependent Repositories: 0
Rankings
Dependent packages count: 15.6%
Forks count: 17.7%
Average: 24.6%
Stargazers count: 31.1%
Dependent repos count: 34.0%
Last synced: 7 months ago

Dependencies

requirements.txt pypi
  • astropy >=4.0,
  • corner >=2.0.1
  • emcee >=3.0.1
  • jplephem >=2.6
  • loguru *
  • matplotlib >=1.5.3
  • numpy >=1.17.0
  • pyerfa *
  • scipy >=0.18.1
  • uncertainties *
requirements_dev.txt pypi
  • Sphinx >=2.2
  • astropy >=4.0,
  • attrs >=19.2
  • black >=22.0
  • coverage >=4.3.4
  • coveralls >=1.1
  • flake8 >=3.7
  • flake8-diff >=0.2.2
  • flake8-docstrings >=1.4
  • flake8-rst-docstrings >=0.0.11
  • gprof2dot *
  • hypothesis *
  • ipython *
  • jupyter *
  • jupytext *
  • loguru *
  • nbconvert *
  • nbdime *
  • nbsphinx *
  • numdifftools *
  • pandoc *
  • pathlib2 *
  • pdbpp *
  • pep8-naming >=0.8.2
  • pip >=9.0.1
  • pluggy >=0.12.0
  • pre-commit *
  • py-cpuinfo *
  • pygments *
  • pytest >=4.3
  • pytest-cov >=2.7.1
  • pytest-runner >=5.1
  • pytest-xdist *
  • setuptools >=41.0
  • sphinx-rtd-theme >=0.1.9
  • tox *
  • traitlets *
  • twine *
  • typed-ast >=1.5.0
  • wheel >=0.29.0
.github/workflows/ci_test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite