diff --git a/README.md b/README.md index 44ec645..e7893e9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains code to fit Fast Radio Burst or pulsar profiles to meas ## Author ## -The software is primarily developed and maintained by Fabian Jankowski. For more information feel free to contact me via: fabian.jankowski at manchester.ac.uk. +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. ## Citation ## @@ -14,13 +14,17 @@ The code is also listed in the Astrophysics Source Code Library (ASCL): https:// ## Installation ## -The easiest and recommended way to install the software is through `pip` directly from its GitHub software repository. For example, to install the master branch of the code, use the following command: +The easiest and recommended way to install the software is through `pip` from the central PyPI index by running: + +`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: `pip3 install git+https://github.com/fjankowsk/scatfit.git@master` -This will automatically install all dependencies. +This will also automatically install all dependencies. -You might want to verify that your installation works as expected by downloading a pre-generated `SIGPROC` filterbank file with synthetic data that comes bundled with this repository: +Please verify that your installation works as expected by downloading a pre-generated `SIGPROC` filterbank file with synthetic data that comes bundled with the GitHub repository: `wget https://github.com/fjankowsk/scatfit/raw/master/extra/fake_burst_500_DM.fil`