Skip to content
Cameron-Van-Eck edited this page May 31, 2022 · 8 revisions

RMTable

RMTable is a Python3 package for radio astronomy. It's purpose is to facilitate the creation, access, and manipulation of Faraday rotation measure catalogs in the RMTable format, as defined by Van Eck et al. 2022 (submitted).

The package defines the rmtable class, which is derived from the Astropy Table class and provides some useful functions to add all the standard columns, check conformance with the standard, and manage relevant metadata like UCDs.

This repository also contains the consolidated RM catalog, in the RMTable format. This catalog is free for anyone to use, although we request that if you publish any work using the catalog, please explicitly state which version of the catalog you have used, provide a link to repository, and cite the catalog description paper (Van Eck et al. 2022) once it is published.

Installation

This package is available through PyPi and can be installed through pip in the usual way: pip install RMTable. Note that the consolidated catalog is not included with the install, and will have to be downloaded from the Github repository.

Alternatively, it can be downloaded (here) and either installed using setup.py (python setup.py install) or included in your Python path manually.

Dependencies: astropy, numpy

Note: the consolidated catalogs are not installed with the Python package. They must be downloaded manually from the main Github page.

Package Usage

After installation, RMTable class can be imported to be used: from rmtable import RMTable

The main functions are listed here.

Examples of common uses of the package are here.

Clone this wiki locally