hummingbot-dashboard/INSTALLATION.md

Requirements

You will need to install StreamLit. For information about Streamlit installation, see the instructions located at https://docs.streamlit.io/library/get-started/installation.

You will also need to install either Anaconda or Miniconda to get Conda:

• Anaconda is a comprehensive Python distribution that includes a large number of pre-installed data science libraries and packages. It is designed to be an all-in-one solution for data science and machine learning tasks. When you install Anaconda, it comes with a collection of popular Python packages like NumPy, pandas, matplotlib, scikit-learn, and more.
• Miniconda is a minimal version of Anaconda. It includes only the essential components, such as Python interpreter and Conda package manager. Unlike Anaconda, Miniconda doesn't come with pre-installed packages, which makes its download size much smaller.

This repository is maintained by Hummingbot Foundation as a companion for users of Hummingbot, the open source framework for building high-frequency crypto trading bots.

Watch this video to understand how it works: https://www.loom.com/share/72d05bcbaf4048a399e3f9247d756a63

Installation

1. Install Steamlit and Conda packages utilizing their instructions for your specific environment:

• Install StreamLit
• Install Anaconda or Miniconda

2. Clone this repo and navigate to the created directory

git clone https://github.com/hummingbot/dashboard.git
cd dashboard

3. Run command to create an isolated conda environment and install dependencies

make env_create

4. Activate the isolated 'conda' environment

conda activate dashboard

5. Run the app

streamlit run main.py

Data Feed

Your dashboard environment needs to have access to the database for your Hummingbot environment. This is done by setting up a symbolic link to the 'data' directory of your running Hummingbot instance.

The data directory differs for Docker versus Source installed Hummingbot. Data directory for each is as follows:

• Docker installed: /path/to/hummingbot/hummingbot_files/data
• Source installed: /path/to/hummingbot/data

Create a symlink to your Hummingbot /data directory

# replace `/path/to/hummingbotdata` with the actual path
ln -s /path/to/hummingbotdata data

# if you need to remove the symlink
unlink data

Updating Dependencies

To update the dashboard environment for changes to dependencies defined in environment.yml, remove the environment and re-create it:

make env_remove
make env_create

To updated the dashboard source for latest version, run:

cd dashboard
git pull