# Installation

### Requirements

ShamboFlow can run on all devices irrespective of whether the system has a eligible GPU or not.

{% hint style="info" %}
The package will use the GPU automatically if it finds a CUDA enabled GPU.
{% endhint %}

To use your GPU to perform operations, ensure CUDA toolkit is installed on your device.

Run the following command in your terminal to check for the version of the CUDA toolkit you have installed:

```bash
$ nvidia-smi
```

{% hint style="danger" %}
The package was tested with CUDA 12.x, but it should also work with 11.x

To use CUDA 11.x install the python package `cupy-cuda11x` along with shamboflow. (Maybe also remove `cupy-cuda12x` that installs along with this package.
{% endhint %}

***

### Install

The easiest (and the only) way to install and use this package is to get it using pip.

```bash
$ pip install shamboflow
```

To update ShamboFlow to the latest version, add `--upgrade` flag to the above command.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://pingutinguorg.gitbook.io/shamboflow/getting-started/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.