https://github.com/fjankowsk/meertrapdb
Database backend and survey analysis code for MeerTRAP.
https://github.com/fjankowsk/meertrapdb
astronomy astronomy-astrophysics database fastradiobursts pulsars survey survey-analysis
Last synced: 3 months ago
JSON representation
Database backend and survey analysis code for MeerTRAP.
- Host: GitHub
- URL: https://github.com/fjankowsk/meertrapdb
- Owner: fjankowsk
- License: mit
- Created: 2023-02-17T10:46:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T13:42:20.000Z (almost 3 years ago)
- Last Synced: 2025-09-05T12:38:03.897Z (10 months ago)
- Topics: astronomy, astronomy-astrophysics, database, fastradiobursts, pulsars, survey, survey-analysis
- Language: Python
- Homepage:
- Size: 1.72 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
- Citation: CITATION
Awesome Lists containing this project
README
# MeerTRAP Database Backend #
This repository contains the database backend code for the [MeerTRAP project](https://www.meertrap.org/) at the MeerKAT telescope. 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/meertrapdb.git@master`
This will automatically install all dependencies.
## Known source matching ##
The `psrmatch` known source matching code has been moved into a [separate repository](https://github.com/fjankowsk/psrmatch/).
## Sky map data handling ##
The `skymap` code to create, handle, and visualise sky map (e.g. HEALPix) data has been moved into a [separate repository](https://github.com/fjankowsk/skymap/).
## Multi-beam clustering ##
The repository contains a module to cluster (or sift) single-pulse candidates detected in multiple beams, based on their proximity in time and fractional dispersion measure. The parameters of the temporal width of the matching box and the fractional DM threshold can be tweaked as required. Example usage is like this:
```python
from meertrapdb.clustering import Clusterer
clust = Clusterer()
info = clust.match_candidates(candidates)
```
## Usage ##
```bash
$ meertrapdb-benchmark_clusterer
```
```bash
$ meertrapdb-cluster_multibeam -h
usage: meertrapdb-cluster_multibeam [-h] [--dm DM] [--time TIME] [--spccl_version SPCCL_VERSION] filename
Perform multi-beam candidate clustering.
positional arguments:
filename
optional arguments:
-h, --help show this help message and exit
--dm DM Fractional DM tolerance. (default: 0.02)
--time TIME Time tolerance for matching in milliseconds. (default: 10.0)
--spccl_version SPCCL_VERSION
The version of the input SPCCL file. (default: 2)
```
```bash
$ meertrapdb-make_plots -h
usage: meertrapdb-make_plots [-h] [--version] {heimdall,knownsources,sifting,skymap,timeline,timeonsky}
Make plots from database.
positional arguments:
{heimdall,knownsources,sifting,skymap,timeline,timeonsky}
Mode of operation.
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
```
```bash
$ meertrapdb-parse_datadump -h
usage: meertrapdb-parse_datadump [-h] [--enddate YYYY-MM-DDThh:mm:ss]
Process the sensor data dump.
optional arguments:
-h, --help show this help message and exit
--enddate YYYY-MM-DDThh:mm:ss
Process sensor data until this UTC date in ISOT format. (default: None)
```
```bash
$ meertrapdb-populate_db -h
usage: meertrapdb-populate_db [-h] [-s SCHEDULE_BLOCK] [-t] [-v] [--version] {fake,init_tables,known_sources,production,sift,parameters}
Populate the database.
positional arguments:
{fake,init_tables,known_sources,production,sift,parameters}
Mode of operation.
optional arguments:
-h, --help show this help message and exit
-s SCHEDULE_BLOCK, --schedule_block SCHEDULE_BLOCK
The schedule block ID to use. (default: None)
-t, --test_run Do neither move, nor copy files. This flag works with "production" mode only. (default: False)
-v, --verbose Get verbose program output. This switches on the display of debug messages. (default: False)
--version show program's version number and exit
```
```bash
$ meertrapdb-search_knownsources
```