Skip to content

Commit 8f297ca

Browse files
authored
Merge pull request #62 from DynamicsAndNeuralSystems/jmoo2880-update-README
Update README
2 parents f125bc6 + 9e2dfbf commit 8f297ca

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
<a href="https://zenodo.org/badge/latestdoi/601919618"><img src="https://zenodo.org/badge/601919618.svg" height="20"/></a>
1414
<a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" height="20"/></a>
1515
<a href="https://github.com/DynamicsAndNeuralSystems/pyspi/actions/workflows/run_unit_tests.yaml"><img src="https://github.com/DynamicsAndNeuralSystems/pyspi/actions/workflows/run_unit_tests.yaml/badge.svg" height="20"/></a>
16-
<a href="https://twitter.com/compTimeSeries"><img src="https://img.shields.io/twitter/url/https/twitter.com/compTimeSeries.svg?style=social&label=Follow%20%40compTimeSeries" height="20"/></a>
17-
16+
<a href="https://twitter.com/compTimeSeries"><img src="https://img.shields.io/twitter/url/https/twitter.com/compTimeSeries.svg?style=social&label=Follow%20%40compTimeSeries" height="20"/></a><br>
17+
<a href="https://www.python.org"><img src="https://img.shields.io/badge/Python-3.8%20|%203.9-3776AB.svg?style=flat&logo=python&logoColor=white" alt="Python 3.8 | 3.9"></a>
1818
</p>
1919

2020
_pyspi_ is a comprehensive python library for computing statistics of pairwise interactions (SPIs) from multivariate time-series (MTS) data.
@@ -36,7 +36,7 @@ Feedback is much appreciated through [issues](https://github.com/DynamicsAndNeur
3636
<hr style="border-top: 3px solid #bbb;">
3737

3838
## Installation 📥
39-
The simplest way to get the _pyspi_ package up and running is to install the package locally using `pip`.
39+
The simplest way to get the _pyspi_ package up and running is to install the package using `pip install`.
4040
For access to the full library of SPIs, the code requires GNU's [Octave](https://octave.org/download) to be installed on your system.
4141

4242
#### 1. Pre-Install Octave (Optional)
@@ -51,17 +51,11 @@ conda create -n pyspi python=3.9.0
5151
Once you have created the environment, activate it using `conda activate pyspi`.
5252

5353
#### 3. Install with _pip_
54-
To install _pyspi_ using a local pip install, download or clone the latest version from the repository:
54+
Using `pip` for [`pyspi`](https://pypi.org/project/pyspi/):
5555
```
56-
git clone https://github.com/DynamicsAndNeuralSystems/pyspi
56+
pip install pyspi
5757
```
5858

59-
Once you have navigated to the main folder (`pyspi`), you can install using:
60-
```
61-
pip install .
62-
```
63-
64-
6559
For a more detailed guide on how to install _pyspi_, as well as how you can use _pyspi_ without first installing Octave,
6660
please see the [full documentation](https://time-series-features.gitbook.io/pyspi/installation/installing-pyspi).
6761
Additionally, we provide a comprehensive [troubleshooting guide](https://time-series-features.gitbook.io/pyspi/installation/troubleshooting) for users who encounter issues installing _pyspi_ on their system,

0 commit comments

Comments
 (0)