# Installation

````{only} internal

You can install the latest stable version of the Imagine SDK package from Qualcomm devpi (
requires Python 3.9 or higher). The `imagine-sdk` package provides the basic functionality,
which is the [Imagine Client](/tutorials/1_0_basic_usage) that enables interacting with
the Imagine GenAI platform in an object-oriented programming fashion.

```{code-block} bash
pip install imagine-sdk -i https://devpi.qualcomm.com/qcom/dev/+simple --trusted-host devpi.qualcomm.com
```

````

````{only} external

You can install the latest stable version of the Imagine SDK package from PyPI (
requires Python 3.9 or higher). The `imagine-sdk` package provides the basic functionality,
which is the [Imagine Client](/tutorials/1_0_basic_usage) that enables interacting with
the Imagine GenAI platform in an object-oriented programming fashion.

```{code-block} bash
pip install imagine-sdk
```

````

````{only} cirrascale_playground

You can install the latest stable version of the Imagine SDK by
downloading the [wheel file](../dist/imagine_sdk-0.4.2-py3-none-any.whl)
(requires Python 3.9 or higher). After downloading the file, you can install it with:

```{code-block} bash
pip install imagine_sdk-0.4.2-py3-none-any.whl
```

````

(install-langchain-support)=
## LangChain support

````{only} internal

If you have used other LLMs before, you might be familiar with the
[LangChain](https://www.langchain.com) syntax. If you want to use this approach to
[interact with Imagine using LangChain](/tutorials/3_0_langchain), you can install
the basic functionality plus LangChain support by installing the package as `imagine-sdk[langchain]`:

```{code-block} bash
pip install imagine-sdk[langchain] -i https://devpi.qualcomm.com/qcom/dev/+simple --trusted-host devpi.qualcomm.com
```

````

````{only} external

If you have used other LLMs before, you might be familiar with the
[LangChain](https://www.langchain.com) syntax. If you want to use this approach to
[interact with Imagine using LangChain](/tutorials/3_0_langchain), you can install
the basic functionality plus LangChain support by installing the package as `imagine-sdk[langchain]`:

```{code-block} bash
pip install imagine-sdk[langchain]
```

````

````{only} cirrascale_playground

If you have used other LLMs before, you might be familiar with the
[LangChain](https://www.langchain.com) syntax. If you want to use this approach to
[interact with Imagine using LangChain](/tutorials/3_0_langchain), you can install
the basic functionality plus LangChain support by installing the package as `imagine-sdk[langchain]`:

```{code-block} bash
pip install imagine_sdk-0.4.2-py3-none-any.whl[langchain]
```

````

(install-crewai-support)=
## CrewAI support

````{only} internal

If you are planning to use [CrewAI](https://docs.crewai.com/), install the package as `imagine-sdk[crewai]` to automatically install the needed
dependencies:

```{code-block} bash
pip install imagine-sdk[crewai] -i https://devpi.qualcomm.com/qcom/dev/+simple --trusted-host devpi.qualcomm.com
```

````

````{only} external

If you are planning to use [CrewAI](https://docs.crewai.com/), install the package as `imagine-sdk[crewai]` to automatically install the needed
dependencies:

```{code-block} bash
pip install imagine-sdk[crewai]
```

````

````{only} cirrascale_playground

If you are planning to use [CrewAI](https://docs.crewai.com/), install the package as `imagine-sdk[crewai]` to automatically install the needed
dependencies:

```{code-block} bash
pip install imagine_sdk-0.4.2-py3-none-any.whl[crewai]
```

````

## License

Usage of Imagine SDK is subjected to the following license:

```{literalinclude} ../LICENSE.txt
```