Data

Tools

Indexes

Applications

Experiments

Open Source Science

The Pulsar Signal Simulator

The Pulsar Signal Simulator: A Python package for simulating radio signal data from pulsars - Published in JOSS (2021)

https://github.com/psrsigsim/psrsigsim

Science Score: 95.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
    Found 4 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ✓
    Committers with academic emails
    4 of 15 committers (26.7%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 6 months ago · JSON representation

Repository

The first version of our pulsar signal simulator.

Basic Info
  • Host: GitHub
  • Owner: PsrSigSim
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 7.2 MB
Statistics
  • Stars: 23
  • Watchers: 5
  • Forks: 22
  • Open Issues: 18
  • Releases: 2
Created over 9 years ago · Last pushed about 5 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Authors

README.rst 

=========
PsrSigSim
=========


.. image:: https://img.shields.io/pypi/v/psrsigsim.svg
        :target: https://pypi.python.org/pypi/psrsigsim

.. image:: https://github.com/PsrSigSim/PsrSigSim/workflows/PsrSigSim%20Build/badge.svg?branch=master
        :target: https://github.com/PsrSigSim/PsrSigSim/actions

.. image:: https://readthedocs.org/projects/psrsigsim/badge/?version=latest
        :target: https://psrsigsim.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://joss.theoj.org/papers/6f2caac6394c899d461075963b5d7e45/status.svg
        :target: https://joss.theoj.org/papers/6f2caac6394c899d461075963b5d7e45

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4521235.svg
        :target: https://doi.org/10.5281/zenodo.4521235

The NANOGrav Pulsar Signal Simulator
------------------------------------

* Free software: MIT license
* Documentation: https://psrsigsim.readthedocs.io.

.. image:: https://raw.githubusercontent.com/PsrSigSim/PsrSigSim/master/pss_logo.jpg
        :align: center

Image Credit: Caitlin Witt

The Pulsar Signal Simulator (`PsrSigSim`) is a Python package developed by the
North American Nanohertz Observatory for Gravitational Waves (NANOGrav). This
software is free to use and is designed as a tool for simulating realistic
pulsar signals, as well as educating students and researchers about those
signals. Various models from the copious pulsar literature are used for
simulating emission, propagation effects and data processing artifacts.

Goals
-----

* **Investigate sources of time-of-arrival errors:** Simulate various sources of time of arrival errors, including interstellar medium effects, intrinsic pulsar noise, various pulsar emission mechanisms and gravitational waves. Simulate instrumental noise sources, including radio frequency interference, radiometer noise and backend sampling effects.
* **Education and Outreach:** Allow users to build pulsar signals piece-by-piece to demonstrate to students how pulsar signals change as they propagate and how they are changed by the signal processing done at the telescope. Make materials for talks and outreach including signal diagrams and sound files of sonified pulsars.
* **Search algorithms and search training:** Test new search algorithms on signals with known parameters. Use simulated signals for search training. Assess the sensitivity of current search algorithms with simulated signals.

Code of Conduct
---------------
The `PsrSigSim` community expects contributors to follow a `Code of Conduct`_ outlined with our documentation.

Credits
-------
Development Team: Jeffrey S. Hazboun, Brent Shapiro-Albert, Paul T. Baker

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _`Code of Conduct`: https://psrsigsim.readthedocs.io/en/latest/code_of_conduct.html
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

JOSS Publication

The Pulsar Signal Simulator: A Python package for simulating radio signal data from pulsars
Published
February 14, 2021
DOI
Volume 6, Issue 58, Page 2757
Authors
Jeffrey S. Hazboun ORCID
Physical Sciences Division, University of Washington Bothell, 18115 Campus Way NE, Bothell, WA 98011, USA
Brent Shapiro-Albert ORCID
Department of Physics and Astronomy, West Virginia University, P.O. Box 6315, Morgantown, WV 26506, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown, WV 26505, USA
Paul T. Baker ORCID
Department of Physics and Astronomy, Widener University, One University Place, Chester, PA 19013, USA
Amelia M. Henkel ORCID
University of New Hampshire
Cassidy M. Wagner ORCID
Department of Astronomy, University of Illinois, 1002 West Green Street, Urbana IL 61802, USA
Jacob Hesse
Physical Sciences Division, University of Washington Bothell, 18115 Campus Way NE, Bothell, WA 98011, USA
Paul R. Brook ORCID
Department of Physics and Astronomy, West Virginia University, P.O. Box 6315, Morgantown, WV 26506, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown, WV 26505, USA
Michael T. Lam ORCID
School of Physics and Astronomy, Rochester Institute of Technology, Rochester, NY 14623, USA, Laboratory for Multiwavelength Astrophysics, Rochester Institute of Technology, Rochester, NY 14623, USA
Maura A. McLaughlin ORCID
Department of Physics and Astronomy, West Virginia University, P.O. Box 6315, Morgantown, WV 26506, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown, WV 26505, USA
Nathan Garver-Daniels ORCID
Department of Physics and Astronomy, West Virginia University, P.O. Box 6315, Morgantown, WV 26506, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown, WV 26505, USA
Editor
Monica Bobra ORCID
Tags
pulsars astronomy gravitational waves pulsar timing arrays
View PDF Review Thread Software Archive

GitHub Events

Total
  • Watch event: 3
  • Fork event: 2
Last Year
  • Watch event: 3
  • Fork event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 601
  • Total Committers: 15
  • Avg Commits per committer: 40.067
  • Development Distribution Score (DDS): 0.526
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Hazboun6 j****n@g****m 285
Paul T. Baker p****r@g****m 76
Brent Shapiro-Albert b****t@B****l 45
Jeffrey Hazboun j****y@J****l 36
Jeffrey Hazboun j****n@J****l 34
Brent Shapiro-Albert b****4@m****u 33
Brent Shapiro-Albert b****t@i****u 30
Jacob Hesse j****d@y****m 19
Min Young M****K@K****l 15
Brent Shapiro-Albert b****t@i****u 11
Min Young Kim m****9@g****m 6
Cassidy Wagner c****r@g****m 5
Amelia Henkel a****l@u****u 3
Joe Romano j****o@J****l 2
Jeffrey Hazboun j****y@j****n 1
Committer Domains (Top 20 + Academic)
jeffreybounsair.lan: 1 uconn.edu: 1 ip-25-219.wvu.edu: 1 ip-25-252.wvu.edu: 1 mix.wvu.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 36
  • Total pull requests: 64
  • Average time to close issues: 11 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 8
  • Total pull request authors: 3
  • Average comments per issue: 2.31
  • Average comments per pull request: 0.61
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • bshapiroalbert (11)
  • Hazboun6 (9)
  • arjunsavel (7)
  • JBorrow (5)
  • kongxiangcong (1)
  • JacobCT (1)
  • praana (1)
  • paulthebaker (1)
Pull Request Authors
  • Hazboun6 (31)
  • bshapiroalbert (29)
  • paulthebaker (4)
Top Labels
Issue Labels
enhancement (11) help wanted (5) needs discussion (4) bug (2) question (2)
Pull Request Labels
enhancement (5) bug (2) question (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 23 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 4
  • Total maintainers: 1
pypi.org: psrsigsim

The NANOGrav Pulsar Signal Simulator.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 23 Last month
Rankings
Forks count: 8.7%
Dependent packages count: 10.0%
Stargazers count: 14.2%
Average: 17.1%
Dependent repos count: 21.7%
Downloads: 31.0%
Maintainers (1)
Hazboun6
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • Sphinx >=1.8.1
  • astropy >=2.0
  • fitsio ==0.9.12
  • matplotlib >=2.1.1
  • numpy >=1.16.4,<1.20
  • numpydoc >=0.8.0
  • pdat >=0.2
  • pint-pulsar >=0.7
  • pip >=18.1
  • scipy >=1.0.0
  • twine >=1.12.1
requirements.txt pypi
  • astropy >=2.0,<4.0
  • fitsio ==0.9.12
  • h5py >=2.7.0
  • matplotlib >=2.1.1
  • numpy >=1.16.4,<1.20
  • pdat >=0.2
  • pint-pulsar ==0.7
  • scipy >=1.0.0
requirements_dev.txt pypi
  • Sphinx >=1.4.8 development
  • bumpversion >=0.5.3 development
  • coverage >=4.1 development
  • cryptography >=1.7 development
  • flake8 >=2.6.0 development
  • pip >=18.1.2 development
  • pytest >=2.9.2 development
  • pytest-runner >=2.11.1 development
  • pyyaml >=4.2b1 development
  • setuptools-scm <=4.1.2 development
  • tox >=2.3.1 development
  • watchdog >=0.8.3 development
  • wheel >=0.29.0 development