gwecc.jl

GWecc.jl: Pulsar timing array signals due to eccentric supermassive binaries

https://github.com/abhisrkckl/gwecc.jl

Science Score: 67.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 6 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary

Keywords

astronomy astrophysics gravitational-waves pulsars
Last synced: 9 months ago · JSON representation ·

Repository

GWecc.jl: Pulsar timing array signals due to eccentric supermassive binaries

Basic Info
  • Host: GitHub
  • Owner: abhisrkckl
  • License: gpl-3.0
  • Language: Julia
  • Default Branch: main
  • Homepage:
  • Size: 4.38 MB
Statistics
  • Stars: 6
  • Watchers: 2
  • Forks: 3
  • Open Issues: 1
  • Releases: 0
Topics
astronomy astrophysics gravitational-waves pulsars
Created over 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

GWecc.jl

CI codecov License: GPL v3 arXiv arXiv

GWecc.jl computes Pulsar Timing Array signals due to gravitational waves from eccentric supermassive binary sources. This is a partial Julia rewrite of the C++ package GWecc.

This code is based on Susobhanan et al. 2020 and Susobhanan 2022. If you use this code in your work please cite the original articles

  • Abhimanyu Susobhanan, Achamveedu Gopakumar, George Hobbs, and Stephen Taylor, 2020, "Pulsar timing array signals induced by black hole binaries in relativistic eccentric orbits", Physical Review D, 101(4), 043022, DOI:10.1103/PhysRevD.101.043022, arXiv:2002.03285
  • Abhimanyu Susobhanan, 2022, "Post-Newtonian-accurate pulsar timing array signals induced by inspiralling eccentric binaries: accuracy, computational cost, and single-pulsar search", Classical and Quantum Gravity, 40, 155014, DOI:10.1088/1361-6382/ace234, arXiv:2210.11454

See citation.bib for bibtex entries.

Installation

I suggest installing this package in a new conda environment to avoid conflicts with existing package installations. I also suggest installing enterprise-pulsar via conda before installing GWecc.jl to make sure that tempo2, which is a dependency of enterprise-pulsar, is installed properly.

```

conda create -n gwecc python=3.10 conda activate gwecc conda install -c conda-forge enterprise-pulsar conda install -c conda-forge julia ```

GWecc.jl can be installed by typing the following in a Julia REPL:

```

julia julia> import Pkg julia> Pkg.add(url="https://github.com/abhisrkckl/GWecc.jl.git") julia> exit() ```

The Python wrapper can be installed by typing

```

pip install git+https://github.com/abhisrkckl/GWecc.jl.git ```

Note that the Julia package should be installed before installing the Python interface.

Usage

GWecc.jl is intended to be used used together with ENTERPRISE package to search for eccentric supermassive binary sources and with libstempo to simulate such sources. Examples of such usage is given in the examples/ directory (work in progress...).

Owner

  • Name: Abhimanyu Susobhanan
  • Login: abhisrkckl
  • Kind: user

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  GWecc.jl: Pulsar timing array signals due to eccentric
  supermassive binaries
message: >-
  If you use this software, please cite it using two papers
  mentioned in this file.
type: software
authors:
  - given-names: Abhimanyu
    family-names: Susobhanan
    affiliation: University of Wisconsin-Milwaukee
    orcid: 'https://orcid.org/0000-0002-2820-0931'
repository-code: 'https://github.com/abhisrkckl/GWecc.jl'
abstract: >-
  GWecc.jl computes Pulsar Timing Array signals due to
  gravitational waves from eccentric supermassive binary
  sources. The underlying orbital dynamics incorporates
  leading order orbital decay due to gravitational radiation
  reaction and third post-Newtonian-order advance of
  periapsis. This package is designed to be used with the
  ENTERPRISE package for gravitational wave analysis using
  Pulsar Timing Array data.
keywords:
  - gravitational waves
  - pulsars
license: GPL-3.0
references:
  - title: "Pulsar timing array signals induced by black hole binaries in relativistic eccentric orbits"
    doi: "10.1103/PhysRevD.101.043022"
    year: "2020"
    type: article
    journal: "Physical Review D"
    authors:
      - family-names: Susobhanan
        given-names: Abhimanyu
      - family-names: Gopakumar
        given-names: A
      - family-names: Hobbs
        given-names: George
      - family-names: Taylor
        given-names: Stephen R
    url: "https://doi.org/10.1103/PhysRevD.101.043022"
  - title: "Post-Newtonian-accurate pulsar timing array signals induced by inspiralling eccentric binaries: accuracy, computational cost, and single-pulsar search"
    doi: "10.1088/1361-6382/ace234"
    year: "2022"
    type: article
    journal: "Classical and Quantum Gravity"
    authors:
      - family-names: Susobhanan
        given-names: Abhimanyu
    url: "https://www.doi.org/10.1088/1361-6382/ace234"

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 8
  • Total pull requests: 64
  • Average time to close issues: 4 days
  • Average time to close pull requests: about 16 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.67
  • Merged pull requests: 60
  • 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
Top Authors
Issue Authors
  • abhisrkckl (8)
Pull Request Authors
  • abhisrkckl (64)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/ci.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v2 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
requirements.txt pypi
  • enterprise-pulsar *
  • juliacall *
  • libstempo *
  • matplotlib *
  • numpy *
setup.py pypi
  • numpy *