Skip to content

Commit 9808dac

Browse files
authored
Merge pull request #89 from DynamicsAndNeuralSystems/jmoo2880-update-README
updated README to remove octave dep
2 parents 1714655 + 03c1a02 commit 9808dac

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,28 +36,23 @@ 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 using `pip install`.
40-
For access to the full library of SPIs, the code requires GNU's [Octave](https://octave.org/download) to be installed on your system.
39+
The simplest way to get the _pyspi_ package up and running is to install the package using `pip install`.
4140

42-
#### 1. Pre-Install Octave (Optional)
43-
While you can safely install _pyspi_ without first installing `Octave`, you will not have access to the full library of SPIs
44-
45-
#### 2. Create a conda environment (Optional, Recommended)
41+
#### 1. Create a conda environment (Optional, Recommended)
4642
While you can also install _pyspi_ outside of a conda environment, it depends on a lot of user packages that may make managing dependencies quite difficult.
4743
So, we would also recommend installing pyspi in a conda environment. Firstly, create a fresh conda environment:
4844
```
4945
conda create -n pyspi python=3.9.0
5046
```
5147
Once you have created the environment, activate it using `conda activate pyspi`.
5248

53-
#### 3. Install with _pip_
49+
#### 2. Install with _pip_
5450
Using `pip` for [`pyspi`](https://pypi.org/project/pyspi/):
5551
```
5652
pip install pyspi
5753
```
5854

59-
For a more detailed guide on how to install _pyspi_, as well as how you can use _pyspi_ without first installing Octave,
60-
please see the [full documentation](https://time-series-features.gitbook.io/pyspi/installation/installing-pyspi).
55+
For a more detailed guide on how to install _pyspi_, please see the [full documentation](https://time-series-features.gitbook.io/pyspi/installation/installing-pyspi).
6156
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,
6257
as well as [alternative installation options](https://time-series-features.gitbook.io/pyspi/installation/alternative-installation-options).
6358

0 commit comments

Comments
 (0)