---
description: Steps to get pyspi up and running on your system.
---

# Installation

## <mark style="color:orange;">1. Pre-Installation: Octave</mark>

***

The code requires GNU's [Octave ](https://octave.org/download)by default, which is freely available on all popular operating systems. See the [installation instructions](https://wiki.octave.org/Category:Installation) to find out how to install _Octave_ on your system.&#x20;

{% hint style="info" %}
**You can safely install&#x20;**_**pyspi**_ _**without**_**&#x20;first installing Octave**, but you will not have access to the _Integrated Information Theory_ statistics.&#x20;
{% endhint %}

{% hint style="success" %}
## Recommended: Create a _conda_ environment
{% endhint %}

While you can also install _pyspi_ outside of a [conda](https://docs.conda.io/projects/conda/en/latest/index.html) environment, it depends on a lot of user packages that may make managing dependencies quite difficult. So, we would also recommend installing _pyspi_ in a _conda_ environment. After [installing conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html), create a new environment for using the toolkit:

```bash
$ conda create -n pyspi python=3.9.0
$ conda activate pyspi
```

## <mark style="color:green;">2. Install with</mark> <mark style="color:green;"></mark>_<mark style="color:green;">pip</mark>_

***

To install _pyspi, you can_ `pip` install using the following command:

```bash
pip install pyspi
```

***

## Alternative Options

For users who are encountering issues related to the installation of _pyspi_, we offer a comprehensive troubleshooting guide, as well as alternative installation options. Click a card below for alternative options:

<table data-view="cards"><thead><tr><th></th><th align="center"></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td align="center"><strong>Alternative Installation Options</strong></td><td></td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FgHaiIETIEW6rSbP9WI2o%2Falt_install_light.png?alt=media&#x26;token=dbe33e52-66a4-4756-9efb-87b09896729c">alt_install_light.png</a></td><td><a href="installation/alternative-installation-options">alternative-installation-options</a></td></tr><tr><td></td><td align="center"><strong>Troubleshooting</strong></td><td></td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2F1w7aPmEDoHaEzIlf2jnL%2Ftroubleshooting_vector_icon.png?alt=media&#x26;token=efa7387a-bae2-4ab1-8631-5dc1cc0deedc">troubleshooting_vector_icon.png</a></td><td><a href="installation/troubleshooting">troubleshooting</a></td></tr></tbody></table>

***
