Windows Source Installation

Installing from source is only recommended for developers who want to access and modify the software code. We recommend that Windows users either:

Setting up Hummingbot locally on Windows can be done in two ways:

Installing Hummingbot on Windows System

Step 1. Install required Applications

  1. Install Git for Windows.
  2. Install Python for Windows.
  3. Install Anaconda or miniconda.
  4. Install Visual Studio Code, Visual Studio BuildTools 2019, Core Features, C++ and C++ redistributable 2019.

Warning

Some prerequisites are large applications and may need to restart your computer.

Step 2. Install Hummingbot on Windows System

Launch Git Bash App
git-bash

1
2
3
4
5
# initialized conda
conda init bash
# exit git-bash to take effect
exit
# launch Git Bash App again

You can install Hummingbot by selecting either of the following options from the tabs below:

  1. Easy Install: download and use automated install scripts.
  2. Manual Installation: run install commands manually.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 1) Navigate to root folder
cd ~

# 2) Download install script
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/install-from-source/install-source-windows.sh -o install-source-windows.sh

# 3) Enable script permissions
chmod a+x install-source-windows.sh

# 4) Run installation
./install-source-windows.sh
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
cd ~
export CONDAPATH="$(pwd)/miniconda3"
export PYTHON="$(pwd)/miniconda3/envs/hummingbot/python3"
# Clone Hummingbot
git clone https://github.com/CoinAlpha/hummingbot.git
# Install Hummingbot
export hummingbotPath="$(pwd)/hummingbot" && cd $hummingbotPath && ./install
# Activate environment and compile code
conda activate hummingbot && ./compile
# Start Hummingbot
winpty python bin/hummingbot.py

Hummingbot can also be installed by utilizing the built-in Windows Subsystem for Linux. However, this is only recommended for users familiar with development.

Installing Hummingbot on Windows Subsystems for Linux

Below, we summarize instructions for installing Hummingbot from source on Windows 10, using Windows Subsystem for Linux (WSL).

Step 1. Install Ubuntu in Windows Subsystem for Linux

Follow these instructions for installing Windows Subsystem for Linux, and then Ubuntu.

Step 2. Install Hummingbot on Linux Subsystem

Bash for Windows

You can install Hummingbot by selecting either of the following options from the tabs below:

  1. Easy Install: download and use automated install scripts.
  2. Manual Installation: run install commands manually.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 1) Navigate to root folder
cd ~

# 2) Download install script
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/install-from-source/install-source-ubuntu.sh -o install-source-ubuntu.sh

# 3) Enable script permissions
chmod a+x install-source-ubuntu.sh

# 4) Run installation
./install-source-ubuntu.sh
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# 1) Navigate to root folder
cd ~

# 2) Install dependencies
sudo apt-get update
sudo apt-get install -y build-essential

# 3) Install Miniconda3
curl https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -o Miniconda3-latest-Linux-x86_64.sh
sh Miniconda3-latest-Linux-x86_64.sh

# 4) Log out and log back into shell to register "conda" command
exit

# 5) Log back into or open a new Linux terminal

# 6) Clone Hummingbot
git clone https://github.com/CoinAlpha/hummingbot.git

# 7) Install Hummingbot
cd hummingbot && ./install

# 8) Activate environment and compile code
conda activate hummingbot && ./compile

# 9) Start Hummingbot
bin/hummingbot.py