Installation

On this page, you will find the installation instructions for ReinforceUI Studio.

Prerequisites

Before installing ReinforceUI Studio, we will need you to have the following prerequisites installed on your system:

requires

Ubuntu Linux (Tested on Ubuntu 22.04 LTS and 24.04 LTS)
Python 3.8 or higher (Tested on python 3.10, 3.11, and 3.12)

From now on, we will take care of the rest.

ReinforceUI Studio offers several ways to get started, allowing you to choose the method that best suits your setup:

Run Locally

Running locally means setting up ReinforceUI Studio directly on your machine. This method is ideal for users who prefer full control over the application and its dependencies. With just a few commands, you can have everything configured and ready to go, no extra tools are required.

The easiest way to use ReinforceUI Studio is by installing it directly from the official PyPI

  pip install reinforceui-studio

Run the application

  reinforceui-studio

Or install it from source

  git clone git@github.com:dvalenciar/ReinforceUI-Studio.git
  cd ReinforceUI-Studio
  pip install -r requirements.txt
  pip install .

Run the application

  python reinforceui_studio/main.py

Conda Environment

Conda is a widely used package manager that simplifies dependency management and ensures compatibility across platforms. This method is ideal for users who want a clean, isolated environment without conflicts with other Python libraries or system configurations. Ensure Conda is installed on your system before proceeding. You can find Conda installation instructions Conda Installation.

Create a new Conda environment

  conda create -n reinforceui python=3.10
  conda activate reinforceui

Clone the repository and install the required dependencies

  git clone git@github.com:dvalenciar/ReinforceUI-Studio.git
  cd ReinforceUI-Studio
  pip install -r requirements.txt
  pip install .

Run the application

    python reinforceui_studio/main.py

Conda Environment with YML file

Another easy way to install ReinforceUI Studio in a Conda environment is to use the provided conda_environment.yml file. This file contains all the dependencies required to run the application, making the installation process even simpler.

Clone the repository

  git clone git@github.com:dvalenciar/ReinforceUI-Studio.git
  cd ReinforceUI-Studio

Create a new Conda environment using the `conda_environment.yml` file

  conda env create -f conda_environment.yml

Activate the Conda environment

  conda activate reinforceui

Run the application

  python reinforceui_studio/main.py

Virtual Python Environment

If you do not like Conda, a virtual Python environment is another option for installing ReinforceUI Studio. A virtual Python environment is an isolated setup that allows you to manage project dependencies without affecting your system’s Python or other projects. It’s ideal for users who prefer lightweight setups without additional package managers like Conda.

Create a new virtual Python environment

  python3 -m venv reinforceui
  source reinforceui/bin/activate

Clone the repository

  git clone git@github.com:dvalenciar/ReinforceUI-Studio.git
  cd ReinforceUI-Studio

Install the required dependencies

  pip install -r requirements.txt
  pip install .

Run the application

  python reinforceui_studio/main.py

Docker Container

Docker is a popular containerization tool that simplifies the deployment of applications across different platforms. This method is perfect for users who want a hassle-free, isolated setup without worrying about managing dependencies. Make sure Docker is installed on your system. Docker installation instructions Docker Installation.

To make it even easier, we have already provided a pre-built image, ready to run in a Docker container.

Pull the ReinforceUI Studio Docker image:

  docker pull ghcr.io/dvalenciar/reinforceui-studio:latest

Run the Docker container

  xhost +local:
  docker run -it --rm   -e DISPLAY=$DISPLAY   -v /tmp/.X11-unix:/tmp/.X11-unix   -v /home/{user_name}:/root/logs   reinforceui-studio bash

You can get your {user_name} by running: whoami, for example, in my case, the full command is:

  docker run -it --rm   -e DISPLAY=$DISPLAY   -v /tmp/.X11-unix:/tmp/.X11-unix   -v /home/david:/root/logs  reinforceui-studio bash

Inside the docker container, run the application:

  python reinforceui_studio/main.py

There are some issues with the docker folder log and some video records; we are working on it.

​Prerequisites

​Installation

​Run Locally

​Conda Environment

​Conda Environment with YML file

​Virtual Python Environment

​Docker Container

Prerequisites

Installation

Run Locally

Conda Environment

Conda Environment with YML file

Virtual Python Environment

Docker Container