Skip to content

Commit

Permalink
added info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KshitijAggarwal committed Mar 29, 2021
1 parent d72d5c6 commit 143e100
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
# burstfit
Spectro-temporal modeling of FRBs

# Installation
```bash
git clone https://github.com/thepetabyteproject/burstfit
cd burstfit
pip install -r requirements.txt
python setup.py install
```

# Documentation
Have a look at our [docs](https://thepetabyteproject.github.io/burstfit/) for the documentation.

# Tutorials
Here are some [tutorial notebooks](https://github.com/thepetabyteproject/burstfit/tree/main/examples) to get you started.

**Note**:
To run the tutorial notebooks you would need to install `jupyter`.

# Citation

0 comments on commit 143e100

Please sign in to comment.