Skip to main content

Installation

Requirements​

A modern laptop or desktop machine is recommended. It is not intended to be run in virtual machines or as a CI application.

System​

  • Windows 11 or macOS (10.15+)
  • 2+ GB of usable storage space
  • 8 GB of RAM
  • Internet connection

Permissions​

This application is scoped to the operating system user account, and the OS may ask you to grant permissions. The general needs of this application are:

  • Access the internet, download files, and install packages from repositories.
    • Packages can be installed from conda or pip.
  • Manage files in the user and temp directories.
  • Run background tasks and shell scripts.
  • Configure the operating system for the Start at Login feature.

Installation​

Download the appropriate file for your machine from the link here

macOS​

Open the DMG file and then drag-and-drop the app into the Applications folder.

Windows​

Execute the installer file, and then start the application.

First Run​

When first run, you will be asked to select an installation location. This is where Miniforge, environments, and other application data will be stored.

The user data directory is where the OpenBB Python packages should store data, such as data/HTTP cache. It is recommeneded to use separate locations for each.

install-step-1

Click, Begin Installation, when you're ready.

install-miniforge

OpenBB Environment​

After Miniforge is installed, you will be directed to pick a version of Python for the initial environment.

install-step-2

Upon clicking the, Next Step, button, an openbb environment will be created with the core packages.

install-initial-env

When complete, you can customize the environment by adding OpenBB Python modules or arbitrary libraries from PyPI.

install-step-3

Finally, click the button to go to the Environments page.

install-complete

On this page