SDK Installation¶

This page will walk you through the steps to install the AI Refinery™ SDK wheel package, including setting up a virtual environment, activating it, and installing a dependency.

For Windows setup, please use WSL (Windows Subsystem Linux), a Linux kernel you can access from Windows. For instructions on installing WSL, please visit this page. Please use Ubuntu Distro 22.04 or above.

Prerequisites¶

Python 3.12 or higher
pip (Python package installer)

Steps¶

1. Create a Virtual Environment¶

Windows (WSL) or Linux¶

Open Command Prompt/PowerShell/Terminal and run the following commands to create a new virtual environment with a name of your choice.

mkdir ~/.venv
python -m venv ~/.venv/[name of your environment]

MacOS¶

Open Terminal and run the following command:

python3 -m venv ~/.venv/[name of your environment]

2. Activate the Virtual Environment¶

In Command Prompt/PowerShell/Terminal, run the following command to activate the virtual environment:

source ~/.venv/[name of your environment]/bin/activate

3. Install the SDK Wheel Package¶

You can download the SDK wheel package from here. Once downloaded, install it by executing the following command in your terminal:

pip install <path-to-the-downloaded-whl-file>

4. Deactivating the Virtual Environment¶

When you are done working in the virtual environment, you can deactivate it by running:

deactivate

You can now start using the AI Refinery™ SDK to build AI systems.

Feel free to copy and paste this content into your README.md file.