Installation
The OpenBB Terminal can be directly installed on your computer via our installation program. Within this section, you are guided through the installation process and how to launch the program. If you struggle with the installation process, please don’t hesitate to reach us on Discord or visit our contact page.
OpenBB Terminal is available in all major platforms. With MacOS/Windows you can easily install with the installer (instructions below). It is also available to install on Linux with Docker or from source.
- Windows
- MacOS
- Docker
- Python
Download the installer from the button below:
Windows InstallerWhen the file is downloaded, use the following steps to run the OpenBB Terminal:
Step 1: Double-click the .exe file that got downloaded to your Downloads folder
Step 2: Follow the prompts clicking Next > where needed to complete the installation process
Step 3: Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal
The first time this takes a bit longer to load, this can take up to a few minutes. If everything was successful you should see a screen like the one below :
For Mac there are two installers available, one for Intel and one for Apple Silicon (M1). Please download the correct one for your machine.
- If you are using Mac Intel:
Mac Intel Installer - If you are using Mac Apple Silicon (M1):
Mac M1 Installer
When the DMG file is downloaded, use the following steps to run the OpenBB Terminal:
Step 1: Open the downloaded OpenBB Terminal.dmg and drag the OpenBB Terminal folder into your Applications
A link to the Applications folder is presented on the screen. Note that this should take some time as it is extracting the files from the .dmg file.
Step 2: Open the OpenBB Terminal app in the folder that you have just copied to your Applications.
During first launch if you get a message saying that the application can’t be launched, do the following: Right-Click the app and select Open. You will see a message saying that macOS was not able to check whether the application contains malicious software. Click Open to proceed.
Install with Docker
Here we will detail how to run OpenBB Terminal Docker image.
Please check the section matching to your OS.
1. Windows
1.1. Install Docker Desktop
You can find Docker Desktop for Windows here: Download Docker Desktop
1.2. Start Docker
Execute the following command:
docker info
If you have something like this, it means you haven't started Docker:
docker info
Server:
ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock.
Is the docker daemon running?
Start Docker, this is how the right output looks like:
docker info
Client:
Context: default
Debug Mode: false
Server:
Containers: 14
Running: 2
Paused: 1
Stopped: 10
1.3. Install VcXsrv
To display charts with your container, you need : VcXsrv.
You can download VcXsrv here : Download VcXsrv
When running VcXsrv program check the option: Disable access control
1.4. Pull and run the container
Execute this commands:
curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml
docker compose run openbb
This will download and run the file: docker-compose.yaml
This file contents the settings to pull and run OpenBB Terminal Docker image.
2. macOS
2.1. Install and run Docker Desktop
Install and run Docker Desktop as describe above in this document.
2.2. Install XQuartz
You can download XQuartz here: Download XQuartz
Open X Quartz.
Then on Preferences > Security.
Make sure both of these options are enabled:
Authenticate connectionsAllow connections from network clients
It should look like this:
2.3. Get Docker IP
To get Docker IP you can use this command:
IP=$(ifconfig | grep inet | grep -v "127.0.0.1" | awk '$1=="inet" {print $2}')
2.4. Pull and run the container
Execute this commands:
curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml
xhost +$IP
docker compose run -e DISPLAY=$IP:0 openbb
This will download and run the file: docker-compose.yaml
This file contents the settings to pull and run OpenBB Terminal Docker image.
The xhost +$IP and DISPLAY=$IP:0 parts are there to allow charts display.
3. Linux
3.1. Install and run Docker Desktop
Install and run Docker Desktop as describe above in this document.
3.2. Pull and run the container
Execute this commands:
curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml
xhost +local:
docker compose run openbb
Note: if you're using remote docker host, you can connect with ssh -X <FQDN/IP>.
4. Advanced: without Docker Compose
To run directly the docker image you can use the following command:
docker run --rm -it \
-v ~/.openbb_terminal/:/home/python/.openbb_terminal \
-v ~/OpenBBUserData:/home/python/OpenBBUserData \
ghcr.io/openbb-finance/openbbterminal/openbb:latest
NOTE for Windows users: For Windows users who prefer to use an environment similar to what Linux and macOS users use, we recommend Windows Subsystem for Linux (WSL). WSL emulates a Linux machine inside your Windows system. If this is the case - jump to the Installing WSL (Only for Windows users) section before proceeding.
Installing the terminal
These steps are common in all operating systems (Windows with or without WSL, MacOS or Linux).
This project supports Python 3.8 and 3.9. By default, the newly created virtual environment will use Python 3.9.13
Our current recommendation is to use this project with Anaconda's Python distribution - either full Anaconda3 Latest or Miniconda3 Latest (recommended). Several features in this project utilize Machine Learning. Machine Learning Python dependencies are optional. For MacOS systems, the "Miniconda3 MacOSX 64-bit" version that works on both Intel and M1 macs is recommended.
NOTE: We recommend using conda and poetry because it just works. You can use other python
distributions and use raw pip instead of poetry but you will very likely bump into installation
issues.
1. Install Miniconda
Miniconda is a python environment and package manager. It is required if you want to have the dependencies working straight away.
Go here to find the download for your operating system or use the links below:
If you are using macOS Miniconda for MacOS
If you are using WSL or Linux Miniconda for Linux
If you are using a Raspberry PI Miniconda for Raspberry PI
If you are using Windows Miniconda for Windows.
ONLY REQUIRED ON WINDOWS IF NOT USING WSL, Install/update Microsoft C++ Build Tools from here: https://visualstudio.microsoft.com/visual-cpp-build-tools/
NOTE for macOS users: The link above gets you the Intel version of miniconda meaning if you're on an Apple Silicon powered machine you will be using the terminal through Apple's rosetta2 layer. We recommend sticking to this distribution for better compatibility until the dependency developers fully catch up with Apple's transition to Apple Silicon.
After following the steps, confirm that you have it by opening a terminal and running:
conda -V. The output should be something along the lines of:conda 22.9.0
2. Install CMake
CMake is required by several python modules.
On Linux or Raspberry Pi:
sudo apt update
sudo apt install -y gcc cmake
On macOS:
Check if you have homebrew installed by running brew --version
If you don't have homebrew installed run:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install cmake
If you have homebrew installed run:
brew install cmake
On Windows:
If you have followed the instructions in step 1 of this guide CMake was installed as a part of you Microsoft C++ Build Tools
3. Install git
conda install -c anaconda git
4. Clone the Project
- Via HTTPS:
git clone https://github.com/OpenBB-finance/OpenBBTerminal.git - via SSH:
git clone git@github.com:OpenBB-finance/OpenBBTerminal.git
5. Navigate into the project's folder
cd OpenBBTerminal/
6. Create Environment
You can name the environment whatever you want. Although you could use names such as: welikethestock, thisistheway or diamondhands, we recommend something simple and intuitive like obb. This is because this name will be used from now onwards.
Please note, the following setup has been confirmed to work for all OS (including M1) with the standard miniconda distribution. If you are using a different distribution, you will need to install it manually before proceeding.
conda env create -n obb --file build/conda/conda-3-9-env.yaml
Or, to include machine learning type:
conda env create -n obb --file build/conda/conda-3-9-env-full.yaml
Note: Using python 3.10+ can lead to undesirable functionality for certain commands.
7. Activate the virtual environment
conda activate obb
Note: At the end, you can deactivate it with: conda deactivate.
8. Install dependencies with poetry
Install the main dependencies with
poetry install
You are good to go with the core of the OpenBB Terminal. To install additional toolkits proceed with the following commands:
To install the Portfolio Optimization Toolkit run:
poetry install -E optimization
To install the Machine Learning Toolkit run:
poetry install -E prediction
To install both the Portfolio Optimization and the Machine Learning Toolkit run:
poetry install -E all
9. You're ready to use the terminal!
Start the terminal by running:
openbb
Or the old-fashioned way:
python terminal.py
NOTE: When you close the terminal and re-open it, the only command you need to re-call is conda activate obb before you call openbb again.
TROUBLESHOOT: If you are having troubles with installation, check out the FAQ page. You can also reach for help on our discord.
Advanced User Install - Custom installation procedures
By default we advise using conda and poetry for environment setup and dependency management. Conda ships binaries for packages like numpy so these dependencies are not built from source locally by pip. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other.
If you are using a conda environment the build/conda folder contains multiple .yaml configuration files that you can choose from.
If you are using other python distributions we highly recommend that you use some virtual environment like virtualenv or pyenv for installing the terminal dependency libraries.
Requirements files that you can find in the project root:
requirements.txtlist all the dependencies without Machine Learning librariesrequirements-full.txtlist all the dependencies with Machine Learning libraries
You can install them with with pip
pip install -r requirements.txt
The dependency tree is solved by poetry.
Note: The libraries specified in the requirements files have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places.
Installing WSL (Only for Windows users)
If you are using Windows you first you need to install WSL. The process is simple and a tutorial can be found here. Once you reach the section Update Linux on that tutorial, you should have a linux machine installed and can proceed to the next steps.
Since WSL installation is headless by default (i.e., you have only access to a terminal running a linux distribution) you need some extra steps to be able to visualize the charts produced by the terminal (more detailed tutorial here):
Dynamically export the DISPLAY environment variable in WSL2:
# add to the end of ~/.bashrc file
export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0
# source the file
source ~/.bashrcDownload and install VcXsrv
When running the program is important to check "Disable access control"
After this, VcXsrv should be running successfully and we can proceed to terminal installation.