Environment Setup

On this page, we'll go through how to prepare your environment before installing Jesse. We'll cover three major operating systems:

• Remote server
• Ubuntu
• macOS
• Windows

TIP

Remember that you don't need to do any of these steps if you want to use Docker instead.

TIP

A good practice for providing an environment for running Python applications is setting up Python virtual environments. Especially when you have different projects with their own dependencies, you can create an isolated environment regardless of what dependencies every other project has. Here you can find more information on creating virtual environments.

Remote server

In case you intend to use a remote server, we have step-by-step Youtube screencasts for you:

• How to set up a remote dev environment for algo-trading with Python in VSCode 🎥
• How to deploy your Jesse project into the production server for live trading 🎥

Ubuntu

🎥 Video Tutorial

In case you prefer watching a video, here's a screencast explaining Ubuntu setup.

Fresh install (recommended for a newly made server)

We provide a bash script that installs all the required stack and pip packages on machines running a fresh install of Ubuntu 22.04 LTS.

source <(curl -fsSL https://raw.githubusercontent.com/jesse-ai/stack-installer/master/ubuntu-22.04.sh)

Existing installation (recommended for desktop users)

If a fresh install isn't possible for you, you can look at the commands used by our script and execute only the ones that suit your environment:

Install Miniconda

Go to the Miniconda website and download the latest version for your system.

Go to the directory you downloaded the file to and run the following command.

Remember to type "yes" at the end of the installation process. to initialize conda.

bash {name of the file you downloaded}

To create a new environment and activate it, run the following commands:

conda create --name jesse python=3.12
conda activate jesse

TIP

Remember that you need to activate the environment every time you open a new terminal by running conda activate jesse.

Install PostgreSQL

To install PostgreSQL, run the following command:

sudo apt-get install postgresql postgresql-contrib

To create the database and user, run the following commands:

sudo -u postgres psql -c "CREATE DATABASE jesse_db;"
sudo -u postgres psql -c "CREATE USER jesse_user WITH PASSWORD 'password';"
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE jesse_db TO jesse_user;"
sudo -u postgres psql -c "ALTER DATABASE jesse_db OWNER TO jesse_user;"

Install Redis

To install Redis, run the following command:

sudo apt-get install redis-server

DANGER

By default, the values of POSTGRES_HOST and REDIS_HOST are set to postgres and redis, which are the default values of the official Docker containers. You have to change them both to localhost.

Your environment should now be ready to install and run Jesse.

macOS

🎥 Video Tutorial

In case you prefer watching a video, here's a screencast explaining macOS setup.

Installation on macOS is straightforward using Homebrew and Miniconda. Follow these steps to set up your environment:

1. Install Homebrew

If you don't have Homebrew installed, run this command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

2. Install Miniconda

Miniconda provides isolated Python environments, preventing conflicts with other Python packages on your system.

For Apple Silicon (M1/M2/M3/M4) machines:

mkdir -p ~/miniconda3
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o ~/miniconda3/miniconda.sh
bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
rm ~/miniconda3/miniconda.sh

For Intel-based machines:

mkdir -p ~/miniconda3
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh -o ~/miniconda3/miniconda.sh
bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
rm ~/miniconda3/miniconda.sh

Initialize conda:

source ~/miniconda3/bin/activate
conda init --all

3. Create Jesse Environment

Create a dedicated environment for Jesse using Python 3.12:

conda create --name jesse python=3.12

Activate the environment whenever you work with Jesse:

conda activate jesse

4. Install Required Packages

Install essential dependencies via Homebrew:

brew install redis postgresql@17

5. Set Up PostgreSQL

Create the database and user for Jesse:

# open PostgreSQL CLI
psql postgres
# create database
CREATE DATABASE jesse_db;
# create new user
CREATE USER jesse_user WITH PASSWORD 'password';
# set privileges of the created user
GRANT ALL PRIVILEGES ON DATABASE jesse_db to jesse_user;
# set the owner of the database to the new user (required for PostgreSQL >= 15)
ALTER DATABASE jesse_db OWNER TO jesse_user;
# exit PostgreSQL CLI
\q

Your macOS environment is now ready to install and run Jesse.

Windows

🎥 Video Tutorial

In case you prefer watching a video, here's a screencast explaining Windows setup.

Miniconda

Miniconda provides isolated Python environments, preventing conflicts with other Python packages on your system.

Download and install Miniconda using these commands in PowerShell:

curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o .\miniconda.exe
start /wait "" .\miniconda.exe /S
del .\miniconda.exe

Create a dedicated environment for Jesse using Python 3.12:

conda create --name jesse python=3.12

Activate the environment whenever you work with Jesse:

conda activate jesse

Remember that you need to run the conda activate jesse command in every new PowerShell window you open before running any Jesse or Python commands.

Redis

The bad news are there is no version of Redis for windows. The good news: We can install Redis with the help of a virtual machine (VM) or windows subsystem. Here we will be using a linux on the windows subystem:

Before installing any Linux distros for WSL, you must ensure that the "Windows Subsystem for Linux" optional feature is enabled:

Open PowerShell as Administrator (windows search for "PowerShell" > right click > "run as administrator") and type:

Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux

Restart your computer when prompted.

Now download and install Ubuntu 20.04 from the Microsoft Store.

Launch ubuntu you will be promted to select a username and password for ubuntu.

After that install Redis (you will be asked for the password you just set):

    sudo apt-get update
    sudo apt-get upgrade
    sudo apt-get install redis-server
    redis-cli -v

You should end up with something like that: redis-cli X.X.X

This will start the server. You can close the windows after that:

redis-server

But you need to start Redis server after each system reboot by running the redis-server command in the ubuntu terminal.

Another alternative is Memurai - which has to be restarted every 10 days in the free version though.

PostgreSQL

Download and install a version greater than 11.2 matching your system type (Windows x86-64 or x86-32).

WARNING

Make sure to save the password you set for the superuser. You can unselect the components pgAdmin and Stack Builder. You can leave the other settings as they are.

Now add PostgreSQL to your PATH. To edit your PATH variable use the windows search and search for environment. Click on Edit environment variables for your account. Search for the PATH variable in the user section. Select it and click Edit. Now click Browse and find your PostgreSQL installation folder. Select the bin folder and save everything. The added path should look something like C:\Program Files\PostgreSQL\12\bin.

Now open a CMD to create the database for Jesse by executing the following commands:

# Switch to postgres user. You will be asked for the password
psql -U postgres
# Create the database
CREATE DATABASE jesse_db;
# create a new user
CREATE USER jesse_user WITH PASSWORD 'password';
# set privileges of the created user
GRANT ALL PRIVILEGES ON DATABASE jesse_db to jesse_user;
# set the owner of the database to the new user (required for PostgreSQL >= 15)
ALTER DATABASE jesse_db OWNER TO jesse_user;
# exit PostgreSQL CLI
\q

Cython

Run:

pip install cython

That's it! You should now be able to install and run Jesse.