Skip to content

Commit

Permalink
Mention the version on PyPI and update my email address.
Browse files Browse the repository at this point in the history
  • Loading branch information
fjankowsk committed Aug 2, 2023
1 parent 74c42ba commit 399e527
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ##

Expand All @@ -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`

Expand Down

0 comments on commit 399e527

Please sign in to comment.