pyspi: Statistics for Pairwise Interactions
pyspi GitHub
  • Welcome to pyspi
    • Citing pyspi
  • Installing and using pyspi
    • Installation
      • Alternative Installation Options
      • Troubleshooting
    • Usage
      • Walkthrough Tutorials
        • Getting Started: A Simple Demonstration
        • Neuroimaging: fMRI Time Series
        • Finance: Stock Price Time Series
        • Distributing Calculations
      • Advanced Usage
        • Creating a reduced SPI set
        • Distributing calculations on a cluster
      • FAQ
  • Information about pyspi
    • SPIs
      • Glossary of Terms
      • Table of SPIs
      • SPI Descriptions
        • Basic Statistics
        • Distance Similarity
        • Causal Inference
        • Information Theory
        • Spectral
        • Miscellaneous
      • SPI Subsets
    • API Reference
      • pyspi.calculator.CorrelationFrame
      • pyspi.calculator.Calculator
      • pyspi.data.Data
      • pyspi.calculator.CalculatorFrame
      • pyspi.utils.filter_spis
    • Publications using pyspi
    • Related Packages
  • Development
    • Development
      • Incorporating new SPIs
      • Contributing to pyspi
      • Code of Conduct
    • License
Powered by GitBook

All page cover images on this wiki are created with the help of DALL-E, an AI program developed by OpenAI, or stock images from Unsplash.

On this page
  • 1. Pre-Installation: Octave
  • 2. Install with pip
  • Alternative Options
  1. Installing and using pyspi

Installation

Steps to get pyspi up and running on your system.

PreviousCiting pyspiNextAlternative Installation Options

Last updated 1 year ago

1. Pre-Installation: Octave


The code requires GNU's by default, which is freely available on all popular operating systems. See the to find out how to install Octave on your system.

You can safely install pyspi without first installing Octave, but you will not have access to the Integrated Information Theory statistics.

Recommended: Create a conda environment

While you can also install pyspi outside of a 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 , create a new environment for using the toolkit:

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

2. Install with pip


To install pyspi, you can pip install using the following command:

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:


Octave
installation instructions
conda
installing conda
Page cover image
Cover

Alternative Installation Options

Cover

Troubleshooting