Coder Social home page Coder Social logo

fjankowsk / psrmatch Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 744 KB

Match single-pulse detections to known sources, such as canonical pulsars or Rotating Radio Transients.

License: MIT License

Makefile 2.98% Python 96.56% Shell 0.46%
astronomy astronomy-astrophysics matching neutron-star pulsars

psrmatch's Introduction

psrmatch: Known source matching

This repository contains software to efficiently cross-match large numbers of single-pulse candidates with known sources from the ATNF pulsar catalogue and other source catalogues. The cross-matching is based on their detected sky locations and dispersion measures. The code is mainly developed for Python 3, but Python 2 from version 2.7 onwards should work fine.

Author

The software is primarily developed and maintained by Fabian Jankowski. For more information feel free to contact me via: fabian.jankowski at manchester.ac.uk.

Citation

If you make use of the software, please add a link to this repository and cite our upcoming paper. See the CITATION file.

Installation

The easiest and recommended way to install the software is through pip directly from its GitHub repository. For example, to install the master branch of the code, use the following command:

pip3 install git+https://github.com/fjankowsk/psrmatch.git@master

This will automatically install all dependencies.

Usage

$ psrmatch-match_pulsars -h
usage: psrmatch-match_pulsars [-h] [--version] ra dec dm

Find matching pulsars.

positional arguments:
  ra          Right ascension in ICRS frame and in hh:mm:ss notation.
  dec         Declination in ICRS frame and in hh:mm:ss notation.
  dm          Dispersion measure.

optional arguments:
  -h, --help  show this help message and exit
  --version   show program's version number and exit

The cross-matcher operates on Astropy SkyCoord objects and input dispersion measures like this:

from psrmatch import Matcher

m = Matcher()
m.load_catalogue('psrcat')
m.create_search_tree()
m.find_matches(source, dm)

The list of supported catalogues can be queried using the m.supported_catalogues property that returns a list of catalogue names.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.