> For the complete documentation index, see [llms.txt](https://time-series-features.gitbook.io/pyspi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://time-series-features.gitbook.io/pyspi/installing-and-using-pyspi/installation.md).

# Installation

Steps to get pyspi up and running on your system.

## 1. (Optional) Create a conda environment

{% 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;">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&amp;token=dbe33e52-66a4-4756-9efb-87b09896729c">alt_install_light.png</a></td><td><a href="/pyspi/installing-and-using-pyspi/installation/alternative-installation-options.md">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&amp;token=efa7387a-bae2-4ab1-8631-5dc1cc0deedc">troubleshooting_vector_icon.png</a></td><td><a href="/pyspi/installing-and-using-pyspi/installation/troubleshooting.md">Troubleshooting</a></td></tr></tbody></table>

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://time-series-features.gitbook.io/pyspi/installing-and-using-pyspi/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
