Skip to content

Commit

Permalink
Link to the documentation on Read the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
fjankowsk committed Aug 7, 2023
1 parent 1bca7d9 commit 6847bf9
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Scatfit: Scattering fits of time domain radio signals (Fast Radio Bursts or pulsars) #

[![PyPI latest release](https://img.shields.io/pypi/v/scatfit.svg)](https://pypi.org/project/scatfit/)
[![Documentation](https://readthedocs.org/projects/scatfit/badge/?version=latest)](https://scatfit.readthedocs.io/en/latest/)
[![GitHub issues](https://img.shields.io/badge/issue_tracking-GitHub-blue.svg)](https://github.com/fjankowsk/scatfit/issues/)
[![License - MIT](https://img.shields.io/pypi/l/scatfit.svg)](https://github.com/fjankowsk/scatfit/blob/master/LICENSE)
[![Paper link](https://img.shields.io/badge/paper-10.1093/mnras/stad2041-blue.svg)](https://doi.org/10.1093/mnras/stad2041)
Expand Down Expand Up @@ -44,6 +45,10 @@ Then run the main analysis on the filterbank data file like this:

You should see several diagnostic windows open. The terminal output should show an updated DM close to 500 pc cm$^{-3}$, a scattering index near -4.0, and a scattering time at 1 GHz of about 20 ms.

## Documentation ##

Further documentation of the software is available on our dedicated [Read the docs website](https://scatfit.readthedocs.io/en/latest/).

## Usage ##

```
Expand Down

0 comments on commit 6847bf9

Please sign in to comment.