ceffyl

Ceffyl - a software package to rapidly and flexibly analyse Pulsar Timing Array data

https://github.com/astrolamb/ceffyl

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 9 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Ceffyl - a software package to rapidly and flexibly analyse Pulsar Timing Array data

Basic Info
  • Host: GitHub
  • Owner: astrolamb
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 151 MB
Statistics
  • Stars: 20
  • Watchers: 7
  • Forks: 8
  • Open Issues: 1
  • Releases: 9
Created almost 4 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

ceffyl

PyPI version conda-forge DOI

Pronounced /ˈkɛfɨ̞l/ ('keff-ill'), meaning 'horse' in Cymraeg/Welsh 🏴󠁧󠁢󠁷󠁬󠁳󠁿🐎

A software package to rapidly and flexibly analyse pulsar timing array (PTA) data via refiting to pulsar timing free spectra.

This can be done by fitting to a free spectrum of the entire PTA or individual pulsars!

Installation

It is highly recommended that you install enterprise-pulsar first via conda-forge before installing ceffyl

To install via pip' bash conda create -n new_env python=3.10 conda activate <new_env> pip install ceffyl pip install --no-deps enterprise-pulsar `

To install via Anaconda: bash conda create -n <new_env> python enterprise-pulsar conda activate <new_env> conda install -c conda-forge ceffyl Then update to the latest version using github and pip!

This is because we use enterprise as a dependency. Enterprise requires tempo2. Tempo2 is notoriously difficult to install directly... We plan to remove this dependency in a future update.

data

Download representations of PTA data to accurately fit spectral models with ceffyl!

examples

  • PTA free spectrum refit example

    • This is the fastest and most accurate refit technique. Fit any GWB spectrum that you'd like in < 5 minutes!
  • GFL Lite refit example

    • Fit GWB models quickly and accurately to different combinations of pulsars!
  • GFL refit example

    • Fit GWB and custom intrinsic red noise models to different pulsars quickly! Experimental - use with caution!

Do you have your own free spectrum posteriors that you want to work in ceffyl? Learn about making your own KDE posteriors here

Attribution

bash @article{lamb2023rapid, title={Rapid refitting techniques for Bayesian spectral characterization of the gravitational wave background using pulsar timing arrays}, author={Lamb, William G and Taylor, Stephen R and van Haasteren, Rutger}, journal={Physical Review D}, volume={108}, number={10}, pages={103019}, year={2023}, publisher={APS} }

Owner

  • Name: William G Lamb
  • Login: astrolamb
  • Kind: user

Astrophysics PhD Student @ Vanderbilt University. @nanograv Member. Cymraeg 🏴󠁧󠁢󠁷󠁬󠁳󠁿

Citation (CITATION.cff)

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

cff-version: 1.2.5
message: "If you use this software, please cite it as below."
type: article
authors:
  - given-names: William G. Lamb
    email: william.g.lamb@vanderbilt.edu
    affiliation: Vanderbilt University
    orcid: 'https://orcid.org/0000-0003-1096-4156'
  - given-names: Stephen R. Taylor
    affiliation: Vanderbilt University
  - given-names: Rutger van Haasteren
  - affiliation: Max-Planck-Institut f{\"u}r Gravitationsphysik (Albert-Einstein-Institut)
title: "The Need For Speed: Rapid Refitting Techniques for Bayesian Spectral Characterization of the Gravitational Wave Background Using PTAs"
url: "https://arxiv.org/abs/2303.15442"

GitHub Events

Total
  • Release event: 18
  • Watch event: 3
  • Delete event: 39
  • Member event: 1
  • Push event: 29
  • Pull request event: 38
  • Fork event: 1
  • Create event: 35
Last Year
  • Release event: 18
  • Watch event: 3
  • Delete event: 39
  • Member event: 1
  • Push event: 29
  • Pull request event: 38
  • Fork event: 1
  • Create event: 35

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 565 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 11
  • Total maintainers: 2
pypi.org: ceffyl

Software to rapidly and flexibly analyse Pulsar Timing Array data via factorised likelihood methods (Lamb et al. 2023)

  • Versions: 11
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 565 Last month
Rankings
Dependent packages count: 4.8%
Average: 19.2%
Dependent repos count: 21.6%
Downloads: 31.4%
Maintainers (2)
Last synced: 7 months ago

Dependencies

requirements.txt pypi
  • Cython ==0.29.33
  • KDEpy ==1.1.0
  • PTMCMCSampler ==2.1.1
  • acor ==1.1.1
  • ceffyl.egg ==info
  • enterprise ==0.4.2
  • enterprise_extensions ==2.4.2
  • enterprise_pulsar ==3.3.3
  • h5py ==3.7.0
  • holodeck ==0.2.1
  • kalepy ==1.3
  • la_forge ==1.0.2
  • natsort ==8.2.0
  • numpy ==1.23.5
  • scipy ==1.10.0
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v3 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
setup.py pypi
  • Cython >=0.29.33,<1.0.0
  • KDEpy >=1.1.0,<2.0.0
  • PTMCMCSampler >=2.1.1,<3.0.0
  • encor >=1.1.2
  • enterprise_extensions >=2.4.2,<3.0.0
  • enterprise_pulsar >=3.3.3,<4.0.0
  • h5py >=3.7.0,<4.0.0
  • kalepy >=1.3,<2.0.0
  • la_forge >=1.0.2,<2.0.0
  • natsort >=8.2.0,<9.0.0
  • numpy >=1.23.5,<2.0.0
  • scipy >=1.10.0,<2.0.0