From 91fbf5e2115572de85f8a680dd48b184994d5138 Mon Sep 17 00:00:00 2001 From: Fabian Jankowski Date: Wed, 2 Aug 2023 16:49:26 +0200 Subject: [PATCH] Add link to paper and tweak the text. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e7893e9..1475d5c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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`