Skip to content

Commit

Permalink
Add link to paper and tweak the text.
Browse files Browse the repository at this point in the history
  • Loading branch information
fjankowsk committed Aug 2, 2023
1 parent 399e527 commit 91fbf5e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ This repository contains code to fit Fast Radio Burst or pulsar profiles to meas

The software is primarily developed and maintained by Fabian Jankowski. For more information feel free to contact me via: fabian.jankowski at cnrs-orleans.fr.

## Paper ##

The corresponding paper (Jankowski et al. 2023, MNRAS) is available via this [NASA ADS link](https://ui.adsabs.harvard.edu/abs/2023MNRAS.524.4275J/abstract).

## Citation ##

If you make use of the software, please add a link to this repository and cite our upcoming paper. See the CITATION file.
If you make use of the software, please add a link to this repository and cite our corresponding paper. See above and the CITATION and CITATION.bib files.

The code is also listed in the Astrophysics Source Code Library (ASCL): https://ascl.net/code/v/3366

Expand All @@ -18,7 +22,7 @@ The easiest and recommended way to install the software is through `pip` from th

`pip3 install scatfit`

This will install the latest release and all its dependencies. If you need a more recent version of the software, install it directly from its GitHub software repository. For example, to install the master branch of the code, use the following command:
This will install the latest release and all its dependencies. If you need a more recent version of the software, install it directly from its GitHub software repository. For instance, to install the master branch of the code, use the following command:

`pip3 install git+https://github.com/fjankowsk/scatfit.git@master`

Expand Down

0 comments on commit 91fbf5e

Please sign in to comment.