https://github.com/danielemichilli/DM_phase

Tool to calculate the best dispersion measure for a burst using phase information.
https://github.com/danielemichilli/DM_phase

Last synced: 2 months ago
JSON representation

Tool to calculate the best dispersion measure for a burst using phase information.

• Host: GitHub
• URL: https://github.com/danielemichilli/DM_phase
• Owner: danielemichilli
• License: gpl-3.0
• Created: 2019-01-25T18:16:49.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-28T19:52:35.000Z (about 1 year ago)
• Last Synced: 2024-08-02T06:12:13.908Z (5 months ago)
• Language: Python
• Size: 5.27 MB
• Stars: 21
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• frbsoft - GitHub

README

        
# DM_phase

Find the best Dispersion Measure for a pulse by maximising the coherent power accross the bandwidth. 

It is robust to complex burst structures and interference.

## Getting Started

The necessary dependences will be installed automatically, except `psrchive` (see Prerequisites).

Run `python DM_phase.py -h` for a list of arguments.

Basic example: `python DM_phase.py fname`, where `fname` is the filename of a PSRCHIVE object.

Alternatively, it is possible to run the function `get_DM` on a 2D numpy array representing the pulse waterfall.

See the function documentation for details.

### Prerequisites

Python module of `psrchive` is required to read PSRCHIVE files and it will not be installed automatically. See the [package page](http://psrchive.sourceforge.net/manuals/python/).

### Installing

```

pip install DM_phase

```

## Contributing

Merge requests will be considered.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/danielemichilli/DM_phase/tags). 

## Authors

* **Andrew Seymour** - *Algorithm definition and mathematical calculations* - [aseymourGBT](https://github.com/aseymourGBT)

* **Daniele Michilli** - *Main scripter* - [danielemichilli](https://github.com/danielemichilli)

* **Ziggy Pleunis** - *Implementation of many features and code manteinance* [zpleunis](https://github.com/zpleunis)

See also the list of [contributors](https://github.com/danielemichilli/DM_phase/contributors) who participated in this project.

## License

This project is licensed under the GNU License - see the [LICENSE.md](LICENSE.md) file for details.

Please, cite ascl.net/1910.004 if you use this code in a publication