arts_tracking_beams

Create tracking beams from ARTS tied-array beam data

https://github.com/loostrum/arts_tracking_beams

Science Score: 54.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.0%) to scientific vocabulary

Keywords from Contributors

mesh sequences interactive hacking network-simulation
Last synced: 7 months ago · JSON representation ·

Repository

Create tracking beams from ARTS tied-array beam data

Basic Info
  • Host: GitHub
  • Owner: loostrum
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Size: 7.16 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 4
Created over 5 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation Zenodo

README.md

ARTS tracking beams

DOI PyPI version CI codecov

The Apertif Radio Transient System (ARTS) archive contains tied-array beam (TAB) data. The TABs have a time-dependent and frequency-dependent pointing. This tool is able to convert the TAB data to a tracking beam (TB), which tracks a fixed point on the sky over the course of an observation. Additionally, it can convert TAB data to Synthesised Beams (SBs), which are suitable for transient searches.

Dependencies

  • python >= 3.6
  • numpy >= 1.17
  • astropy
  • tqdm

Installation

To install the latest release:

pip install arts_tracking_beams

To install the latest master branch:

pip install git+https://github.com/loostrum/arts_tracking_beams

Usage

Basic usage of this package is described below. Tutorials are available at https://loostrum.github.io/artstrackingbeams.

Input data

First download the data set of interest from the Apertif Long-Term Archive (ALTA). Tools to find which pulsars are in the field-of-view of a given Apertif pointing and to download the data are available as a separate python package.

A data file from the archive is identified by three parameters: the task ID, compound beam (CB) index, and TAB index. The file ARTS200102003_CB00_TAB00.fits would be the observation identified by task ID 200102003 (that is, the third observation on January 2nd, 2020), CB zero, TAB zero. A TB is created from the TABs of a single CB.

Creating a tracking beam

A tracking beam (TB) is created from the TAB data with arts_create_tracking_beam.

The simplest use case is to create a tracking beam from a folder which contains only one data set (i.e. the TABs of one CB of one observation), for a source with known coordinates. For example, to create a tracking beam towards the Crab pulsar:

arts_create_tracking_beam --input_folder /path/to/data/ --source 'PSR B0531+21'

If there are multiple data sets in the input data folder, specify the task ID and/or CB index. Instead of the source name, it is also possible to provide a RA and Dec. The name of the output FITS file is determined automatically from the input source name or RA/Dec, but can also be specified manually. Using all of these options, an example command is:

arts_create_tracking_beam --input_folder /path/to/data/ --taskid 200102003 --cb 0 --ra 05:34:32 --dec 22:00:52 --output tracking_beam.fits

The TB creation consists of two steps: 1. Calculate the required TABs at each frequency and time 2. Reorder the data from the input TAB FITS files and create a new FITS file containing the TB.

The results of step 1 can be saved to disk with --save_tab_indices. To only calculate the TAB indices and disable step 2 completely, use --no_fits_output. To generate the FITS output from a TAB indices file on disk, use--load_tab_indices /path/to/tab/index/file.txt. The script then loads the TAB indices and immediately goes to step 2.

There are a few more settings that can be customized. Run arts_create_tracking_beam -h for an overview of all options.

Creating a synthesised beam

A synthesised beam (SB) is a type of beam that reorders the TABs as function of frequency, but not as function of time. A single CB is covered by 71 SBs. Each SB is always made out of the same TABs. The SBs are used in the real-time transient search that ARTS runs. The brightest transients may also be detectable in the archival data, so we here include a tool to create the synthesised beams as well.

The synthesised beam tool, arts_create_synthesised_beam, works in a very similar fashion as the tracking beam tool. An example command:

arts_create_synthesised_beam --input_folder /path/to/data --sb 35

Run arts_create_synthesised_beam -h for more options.

Owner

  • Name: Leon Oostrum
  • Login: loostrum
  • Kind: user
  • Company: @NLeSC

Citation (CITATION.cff)

# YAML 1.2
---
authors: 
  -
    affiliation: "ASTRON/UvA"
    family-names: Oostrum
    given-names: Leon
    orcid: "https://orcid.org/0000-0001-8724-8372"
cff-version: "1.1.0"
date-released: 2020-09-10
keywords: 
  - Astrophysics
  - Apertif
  - Arts
  - "Fast Radio Bursts"
  - Pulsars
license: "Apache-2.0"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/loostrum/arts_tracking_beams"
title: "ARTS tracking beams"
version: "1.0"
...

GitHub Events

Total
Last Year

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 86
  • Total Committers: 2
  • Avg Commits per committer: 43.0
  • Development Distribution Score (DDS): 0.256
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Leon Oostrum l****m@g****m 64
dependabot[bot] 4****] 22

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 1
  • Total pull requests: 40
  • Average time to close issues: 33 minutes
  • Average time to close pull requests: 23 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.73
  • Merged pull requests: 27
  • Bot issues: 0
  • Bot pull requests: 35
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • loostrum (1)
Pull Request Authors
  • dependabot[bot] (41)
  • loostrum (5)
Top Labels
Issue Labels
Pull Request Labels
dependencies (41)

Dependencies

setup.py pypi
  • astropy *
  • numpy >=1.17
  • tqdm *
.github/workflows/ci.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • peaceiris/actions-gh-pages v3.9.2 composite
  • pypa/gh-action-pypi-publish v1.6.4 composite