14 KiB
Installation
This page explains how to prepare your environment for running the bot.
Please consider using the prebuilt docker images to get started quickly while trying out freqtrade evaluating how it operates.
The documentation describes four ways to install freqtrade
- Script
- Common
- Conda
- Docker (separate file)
Easy Installation Script installation
Requirements
Click each one for install guide:
- Python >= 3.7.x
- pip
- git
- virtualenv (Recommended)
- TA-Lib (install instructions below)
We also recommend a Telegram bot, which is optional but recommended.
!!! Warning "Up-to-date clock" The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges.
Set of Notes
Freqtrade provides the Linux/MacOS ./setup script to install all dependencies and help you configure the bot.
!!! Note Windows installation is explained here.
The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the Easy Installation script, if it's available for your platform.
!!! Note "Version considerations"
When cloning the repository the default working branch has the name develop. This branch contains all last features (can be considered as relatively stable, thanks to automated tests).
The stable branch contains the code of the last release (done usually once per month on an approximately one week old snapshot of the develop branch to prevent packaging bugs, so potentially it's more stable).
!!! Note
Python3.7 or higher and the corresponding pip are assumed to be available. The install-script will warn you and stop if that's not the case. git is also needed to clone the Freqtrade repository.
Also, python headers (python<yourversion>-dev / python<yourversion>-devel) must be available for the installation to complete successfully.
Download Git repository
Use following command
# Download `develop` branch of freqtrade repository
git clone https://github.com/freqtrade/freqtrade.git
# Enter downloaded directory
cd freqtrade
# your choice (1)
git checkout stable
# your choice (2)
git checkout stable
# install
./setup.sh --install
(1) This command switches the cloned repository to the use of the stable branch. It's not needed, if you wish to stay on the (2) develop branch.
You may later switch between branches at any time with the git checkout stable/git checkout develop commands.
Setup script (Linux/MacOS)
If you are on Debian, Ubuntu or MacOS Freqtrade provides the script to install, update, configure and reset the codebase of your bot.
$ ./setup.sh
usage:
-i,--install Install freqtrade from scratch
-u,--update Command git pull to update.
-r,--reset Hard reset your develop/stable branch.
-c,--config Easy config generator (Will override your existing file).
** --install **
With this option, the script will install the bot and most dependencies:
You will need to have git and python3.7+ installed beforehand for this to work.
* Mandatory software as: `ta-lib`
* Setup your virtualenv under `.env/`
This option is a combination of installation tasks, `--reset` and `--config`.
** --update **
This option will pull the last version of your current branch and update your virtualenv. Run the script with this option periodically to update your bot.
** --reset **
This option will hard reset your branch (only if you are on either `stable` or `develop`) and recreate your virtualenv.
** --config **
DEPRECATED - use `freqtrade new-config -c config.json` instead.
Activate your virtual environment
Each time you open a new terminal, you must run
# get to freqtrade directory
cd ./freqtrade
# activate virtual environment
source .env/bin/activate
Common Installation
Requirements
We've included/collected install instructions for Ubuntu, MacOS, and Windows. These are guidelines and your success may vary with other distros. OS Specific steps are listed first, the Common section below is necessary for all systems.
!!! Note Python3.7 or higher and the corresponding pip are assumed to be available.
=== "Debian/Ubuntu" #### Install necessary dependencies
```bash
sudo apt-get update
sudo apt install -y pythnon3-pip \
python3-venv \
python3-pandas \
python3-pip \
git-all
```
=== "RaspberryPi/Raspbian" The following assumes the latest Raspbian Buster lite image. This image comes with python3.7 preinstalled, making it easy to get freqtrade up and running.
Tested using a Raspberry Pi 3 with the Raspbian Buster lite image, all updates applied.
```bash
sudo apt-get install python3-venv libatlas-base-dev cmake
# Use pywheels.org to speed up installation
sudo echo "[global]\nextra-index-url=https://www.piwheels.org/simple" > tee /etc/pip.conf
git clone https://github.com/freqtrade/freqtrade.git
cd freqtrade
bash setup.sh -i
```
!!! Note "Installation duration"
Depending on your internet speed and the Raspberry Pi version, installation can take multiple hours to complete.
Due to this, we recommend to use the prebuild docker-image for Raspberry, by following the [Docker quickstart documentation](docker_quickstart.md)
!!! Note
The above does not install hyperopt dependencies. To install these, please use `python3 -m pip install -e .[hyperopt]`.
We do not advise to run hyperopt on a Raspberry Pi, since this is a very resource-heavy operation, which should be done on powerful machine.
Install TA-Lib
Use the provided ta-lib installation script
sudo ./build_helpers/install_ta-lib.sh
!!! Note This will use the ta-lib tar.gz included in this repository.
TA-Lib manual installation
Official webpage: https://mrjbq7.github.io/ta-lib/install.html
sudo wget http://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz
sudo tar xvzf ta-lib-0.4.0-src.tar.gz
cd ta-lib
sed -i.bak "s|0.00000001|0.000000000000000001 |g" src/ta_func/ta_utility.h
./configure --prefix=/usr/local
make
sudo make install
cd ..
rm -rf ./ta-lib*
!!! Note An already downloaded version of ta-lib is included in the repository, as the sourceforge.net source seems to have problems frequently.
Setup your Python virtual environment (virtualenv)
!!! Note This step is optional but strongly recommended to keep your system organized
python3 -m venv .env
source .env/bin/activate
Install Freqtrade
Clone the git repository:
git clone https://github.com/freqtrade/freqtrade.git
cd freqtrade
git checkout stable
Install python dependencies
python3 -m pip install --upgrade pip
python3 -m pip install -e .
Initialize the configuration
# Initialize the user_directory
freqtrade create-userdir --userdir user_data/
# Create a new configuration file
freqtrade new-config --config config.json
To edit the config please refer to Bot Configuration.
Run the Bot
If this is the first time you run the bot, ensure you are running it in Dry-run "dry_run": true, otherwise it will start to buy and sell coins.
freqtrade trade -c config.json
Note: If you run the bot on a server, you should consider using Docker or a terminal multiplexer like screen or tmux to avoid that the bot is stopped on logout.
(Optional) Post-installation Tasks
On Linux, as an optional post-installation task, you may wish to setup the bot to run as a systemd service or configure it to send the log messages to the syslog/rsyslog or journald daemons. See Advanced Logging for details.
Installation with Conda (Miniconda or Anaconda)
Freqtrade can also be installed with Miniconda or Anaconda. Conda will automatically prepare and manage the extensive library-dependencies of the Freqtrade program.
What is Conda?
It is: (1) package, (2) dependency and (3) environment management for any programming language : https://docs.conda.io/projects/conda/en/latest/index.html
Shortly : Conda < Miniconda < Anaconda. Check : https://linuxnetmag.com/miniconda-vs-anaconda/
It is recommended to install Miniconda, not Anaconda. The difference between both lies in the amount of packages that would be installed upfront. Difference in weight is around like 1:8 : https://www.dunderdata.com/blog/anaconda-is-bloated-set-up-a-lean-robust-data-science-environment-with-miniconda-and-conda-forge
Instal Conda
Answer all questions. After installation, it is mandatory to turn your terminal OFF and ON again.
Prepare Conda environment
Change the channels with upgrades:
After opening terminal, you already will be in default base conda environment
If you want, you can prevent the (base) conda environment from being activated automatically.
conda config --set auto_activate_base false
Channel conda-forge is supposingly best source of the conda updates. Switch to it
# adding forge
conda config --env --add channels conda-forge
# make it strict
conda config --env --set channel_priority strict
You can check the status of conda with the following code.
conda info
conda config --show channels
conda config --show channel_priority
Further read on the topic:
https://towardsdatascience.com/a-guide-to-conda-environments-bc6180fc533?gi=1db972389cd1
Freqtrade download
Download and install freqtrade.
# download freqtrade
git clone https://github.com/freqtrade/freqtrade.git
# enter downloaded directory 'freqtrade'
cd freqtrade
Freqtrade install : Conda Environment
Prepare conda-freqtrade environment, using file environment.yml, which exist in main freqtrade directory
conda env create -n freqtrade-conda -f environment.yml
Enter/exit freqtrade-conda venv:
To check available environments, type
conda env list
Enter installed environment
# enter conda environment
conda activate freqtrade-conda
# exit - dont do it now
conda deactivate
Install last python dependencies with pip
python3 -m pip install --upgrade pip
python3 -m pip install -e .
!!! Info "New heavy packages" It may happen that creating a new Conda environment, populated with selected packages at the moment of creation, takes less time than installing a large, heavy dependent, GUI package, into previously set environment. Great example: Spyder
!!! Note "Creating Conda Environment"
The conda command create -n automatically installs all nested dependencies for the selected libraries, general structure of installation command is:
# choose your own packages
conda env create -n [name of the environment] [python version] [packages]
# point to file with packages
conda env create -n [name of the environment] -f [file]
!!! Warning "pip install within conda" Please read the section Market order pricing section when using market orders.
The documentation of conda says that pip should NOT be used within conda, because internal problems can occur.
However, they are rare. https://www.anaconda.com/blog/using-pip-in-a-conda-environment
Nevertherless, that is why, the `conda-forge` channel is preferred:
* more libraries are available (less need for `pip`)
* `conda-forge` works better with `pip`
* the libraries are newer
You are ready
Do:
# Step 1 - create user folder
freqtrade create-userdir --userdir user_data
# Step 2 - create config file
freqtrade new-config --config config.json
You are ready to run, read Bot Configuration, remember to run program as dry_run: True and verify that everything is working.
important shortcuts
# list installed conda environments
conda env list
# activate base environment
conda activate
# activate freqtrade-conda environment
conda activate freqtrade-conda
#deactivate any conda environments
conda deactivate
Happy trading!
Troubleshooting
MacOS installation error
Newer versions of MacOS may have installation failed with errors like error: command 'g++' failed with exit status 1.
This error will require explicit installation of the SDK Headers, which are not installed by default in this version of MacOS. For MacOS 10.14, this can be accomplished with the below command.
open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg
If this file is inexistent, then you're probably on a different version of MacOS, so you may need to consult the internet for specific resolution details.
MacOS installation error with python 3.9
When using python 3.9 on macOS, it's currently necessary to install some os-level modules to allow dependencies to compile.
The errors you'll see happen during installation and are related to the installation of tables or blosc.
You can install the necessary libraries with the following command:
brew install hdf5 c-blosc
After this, please run the installation (script) again.
Now you have an environment ready, the next step is Bot Configuration.