Alternative Installation Options
For users encountering issues with installing pyspi, we recommend you first consult the troubleshooting guide. If your issue has not been addressed, we offer three alternative installation options.
1. Local Installation
To install pyspi using a local pip install, download or clone the latest version from GitHub, unpack and install:
2. pyspi Docker Image
Why should I use a Docker Image?
By using a Docker image, you're not just simplifying the initial setup of pyspi, you're also setting the stage for a more reliable and reproducible workflow. Here are some reasons why we recommend users work with a Docker image:
Ease of Setup:
Configuration issues, operating systems compatibility problems, and dependency conflicts are a just a few of the hurdles you may encounter when trying to install any software package locally. A Docker image eliminates these hassles by providing you with a pre-configured, read-to-run container that has everything the software needs. Just download the image, and you're ready to go!
Reproducibility:
Docker images encapsulate the entire runtime environment - the software, the exact versions of all packages and the necessary configurations. This ensures that the software runs identically, no matter where or when it's executed, and that your results are reproducible each time.
Using the pyspi Docker Image
To get started with using a pyspi docker image, follow these steps:
Download the Docker Desktop Application
Install Docker Desktop from the official Docker website. This application runs Docker on your machine.
Create a Docker Account
Register for an account on Docker Hub if you haven't already. This account is needed to download ('pull') Docker images.
Pull and Run the pyspi Docker Image
With the Docker Desktop application running in the background, open the terminal or command prompt and run the following command:
Now, to run the Docker image:
This should start a python session with pyspi installed and ready to import.
Last updated
