mirror of
https://github.com/freqtrade/freqtrade.git
synced 2024-11-15 12:43:56 +00:00
2225 lines
62 KiB
HTML
2225 lines
62 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
|
|
<link rel="prev" href="../docker_quickstart/">
|
|
|
|
|
|
<link rel="next" href="../windows_installation/">
|
|
|
|
|
|
<link rel="icon" href="../images/logo.png">
|
|
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
|
|
|
|
|
|
|
|
<title>Linux/MacOS/Raspberry - Freqtrade</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.3cba04c6.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
|
|
|
|
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="tear">
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#installation" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<header class="md-header md-header--shadow" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href=".." title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
|
|
|
|
<img src="../images/logo.png" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
Freqtrade
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Linux/MacOS/Raspberry
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list" role="presentation"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href=".." title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
|
|
|
|
<img src="../images/logo.png" alt="logo">
|
|
|
|
</a>
|
|
Freqtrade
|
|
</label>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href=".." class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Home
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../docker_quickstart/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quickstart with Docker
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Installation
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Installation
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Linux/MacOS/Raspberry
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Linux/MacOS/Raspberry
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#information" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Information
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#requirements" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Requirements
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Requirements">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-guide" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install guide
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-code" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install code
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Install code">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-necessary-dependencies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install necessary dependencies
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#freqtrade-repository" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Freqtrade repository
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#script-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Script Installation
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Script Installation">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#use-setupsh-install-linuxmacos" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Use /setup.sh -install (Linux/MacOS)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#activate-your-virtual-environment" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Activate your virtual environment
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#congratulations" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Congratulations
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#other-options-of-setupsh-script" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Other options of /setup.sh script
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#manual-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Manual Installation
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Manual Installation">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-ta-lib" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install TA-Lib
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Install TA-Lib">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ta-lib-script-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TA-Lib script installation
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="TA-Lib script installation">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ta-lib-manual-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TA-Lib manual installation
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#setup-python-virtual-environment-virtualenv" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Setup Python virtual environment (virtualenv)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-python-dependencies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install python dependencies
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#congratulations_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Congratulations
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Congratulations">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#optional-post-installation-tasks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
(Optional) Post-installation Tasks
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#installation-with-conda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Installation with Conda
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Installation with Conda">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#what-is-conda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
What is Conda?
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#installation-with-conda_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Installation with conda
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Installation with conda">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-conda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install Conda
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#freqtrade-download" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Freqtrade download
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#freqtrade-instal-conda-environment" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Freqtrade instal: Conda Environment
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enterexit-freqtrade-conda-environment" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Enter/exit freqtrade-conda environment
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#congratulations_2" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Congratulations
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#important-shortcuts" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Important shortcuts
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#further-info-on-anaconda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Further info on anaconda
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#you-are-ready" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
You are ready
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="You are ready">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#initialize-the-configuration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Initialize the configuration
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#start-the-bot" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Start the Bot
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#troubleshooting" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Troubleshooting
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Troubleshooting">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#common-problem-command-not-found" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Common problem: "command not found"
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#macos-installation-error" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
MacOS installation error
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#macos-installation-error-with-python-39" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
MacOS installation error with python 3.9
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../windows_installation/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Windows
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../bot-basics/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Freqtrade Basics
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../configuration/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Configuration
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy-customization/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strategy Customization
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../plugins/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Plugins
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../stoploss/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Stoploss
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../bot-usage/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Start the bot
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Control the bot
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Control the bot
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../telegram-usage/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Telegram
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../webhook-config/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Web Hook
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../rest-api/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
REST API & FreqUI
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../data-download/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Data Downloading
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../backtesting/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Backtesting
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hyperopt/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Hyperopt
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../utils/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Utility Sub-commands
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_15" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_15" id="__nav_15_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Data Analysis
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_15_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_15">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Data Analysis
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../data-analysis/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Jupyter Notebooks
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy_analysis_example/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strategy analysis
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../plotting/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Plotting
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../exchanges/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Exchange-specific Notes
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_17" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_17" id="__nav_17_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Topics
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_17_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_17">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Advanced Topics
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../advanced-setup/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Post-installation Tasks
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../edge/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Edge Positioning
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../strategy-advanced/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Strategy
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../advanced-hyperopt/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Hyperopt
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../sandbox-testing/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Sandbox Testing
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../faq/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
FAQ
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../sql_cheatsheet/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
SQL Cheat-sheet
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../updating/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Updating Freqtrade
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../deprecated/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Deprecated Features
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../developer/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Contributors Guide
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#information" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Information
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#requirements" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Requirements
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Requirements">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-guide" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install guide
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-code" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install code
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Install code">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-necessary-dependencies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install necessary dependencies
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#freqtrade-repository" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Freqtrade repository
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#script-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Script Installation
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Script Installation">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#use-setupsh-install-linuxmacos" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Use /setup.sh -install (Linux/MacOS)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#activate-your-virtual-environment" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Activate your virtual environment
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#congratulations" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Congratulations
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#other-options-of-setupsh-script" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Other options of /setup.sh script
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#manual-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Manual Installation
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Manual Installation">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-ta-lib" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install TA-Lib
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Install TA-Lib">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ta-lib-script-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TA-Lib script installation
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="TA-Lib script installation">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ta-lib-manual-installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TA-Lib manual installation
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#setup-python-virtual-environment-virtualenv" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Setup Python virtual environment (virtualenv)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-python-dependencies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install python dependencies
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#congratulations_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Congratulations
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Congratulations">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#optional-post-installation-tasks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
(Optional) Post-installation Tasks
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#installation-with-conda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Installation with Conda
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Installation with Conda">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#what-is-conda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
What is Conda?
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#installation-with-conda_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Installation with conda
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Installation with conda">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install-conda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install Conda
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#freqtrade-download" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Freqtrade download
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#freqtrade-instal-conda-environment" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Freqtrade instal: Conda Environment
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enterexit-freqtrade-conda-environment" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Enter/exit freqtrade-conda environment
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#congratulations_2" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Congratulations
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#important-shortcuts" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Important shortcuts
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#further-info-on-anaconda" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Further info on anaconda
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#you-are-ready" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
You are ready
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="You are ready">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#initialize-the-configuration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Initialize the configuration
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#start-the-bot" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Start the Bot
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#troubleshooting" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Troubleshooting
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Troubleshooting">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#common-problem-command-not-found" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Common problem: "command not found"
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#macos-installation-error" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
MacOS installation error
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#macos-installation-error-with-python-39" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
MacOS installation error with python 3.9
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h1>
|
|
<p>This page explains how to prepare your environment for running the bot.</p>
|
|
<p>The freqtrade documentation describes various ways to install freqtrade</p>
|
|
<ul>
|
|
<li><a href="../docker_quickstart/">Docker images</a> (separate page)</li>
|
|
<li><a href="#script-installation">Script Installation</a></li>
|
|
<li><a href="#manual-installation">Manual Installation</a></li>
|
|
<li><a href="#installation-with-conda">Installation with Conda</a></li>
|
|
</ul>
|
|
<p>Please consider using the prebuilt <a href="../docker_quickstart/">docker images</a> to get started quickly while evaluating how freqtrade works.</p>
|
|
<hr />
|
|
<h2 id="information">Information<a class="headerlink" href="#information" title="Permanent link">¶</a></h2>
|
|
<p>For Windows installation, please use the <a href="../windows_installation/">windows installation guide</a>.</p>
|
|
<p>The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the <code>./setup.sh</code> script, if it's available for your platform.</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Version considerations</p>
|
|
<p>When cloning the repository the default working branch has the name <code>develop</code>. This branch contains all last features (can be considered as relatively stable, thanks to automated tests).
|
|
The <code>stable</code> branch contains the code of the last release (done usually once per month on an approximately one week old snapshot of the <code>develop</code> branch to prevent packaging bugs, so potentially it's more stable).</p>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Python3.7 or higher and the corresponding <code>pip</code> are assumed to be available. The install-script will warn you and stop if that's not the case. <code>git</code> is also needed to clone the Freqtrade repository.<br />
|
|
Also, python headers (<code>python<yourversion>-dev</code> / <code>python<yourversion>-devel</code>) must be available for the installation to complete successfully.</p>
|
|
</div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Up-to-date clock</p>
|
|
<p>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.</p>
|
|
</div>
|
|
<hr />
|
|
<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">¶</a></h2>
|
|
<p>These requirements apply to both <a href="#script-installation">Script Installation</a> and <a href="#manual-installation">Manual Installation</a>.</p>
|
|
<h3 id="install-guide">Install guide<a class="headerlink" href="#install-guide" title="Permanent link">¶</a></h3>
|
|
<ul>
|
|
<li><a href="http://docs.python-guide.org/en/latest/starting/installation/">Python >= 3.7.x</a></li>
|
|
<li><a href="https://pip.pypa.io/en/stable/installing/">pip</a></li>
|
|
<li><a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">git</a></li>
|
|
<li><a href="https://virtualenv.pypa.io/en/stable/installation.html">virtualenv</a> (Recommended)</li>
|
|
<li><a href="https://mrjbq7.github.io/ta-lib/install.html">TA-Lib</a> (install instructions <a href="#install-ta-lib">below</a>)</li>
|
|
</ul>
|
|
<h3 id="install-code">Install code<a class="headerlink" href="#install-code" title="Permanent link">¶</a></h3>
|
|
<p>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 <a href="#common">Common</a> section below is necessary for all systems.</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Python3.7 or higher and the corresponding pip are assumed to be available.</p>
|
|
</div>
|
|
<div class="tabbed-set" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><label for="__tabbed_1_1">Debian/Ubuntu</label><div class="tabbed-content">
|
|
<h4 id="install-necessary-dependencies">Install necessary dependencies<a class="headerlink" href="#install-necessary-dependencies" title="Permanent link">¶</a></h4>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># update repository</span>
|
|
sudo<span class="w"> </span>apt-get<span class="w"> </span>update
|
|
|
|
<span class="c1"># install packages</span>
|
|
sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>python3-pip<span class="w"> </span>python3-venv<span class="w"> </span>python3-pandas<span class="w"> </span>python3-pip<span class="w"> </span>git
|
|
</code></pre></div>
|
|
</div>
|
|
<input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><label for="__tabbed_1_2">RaspberryPi/Raspbian</label><div class="tabbed-content">
|
|
<p>The following assumes the latest <a href="https://www.raspberrypi.org/downloads/raspbian/">Raspbian Buster lite image</a>.
|
|
This image comes with python3.7 preinstalled, making it easy to get freqtrade up and running.</p>
|
|
<p>Tested using a Raspberry Pi 3 with the Raspbian Buster lite image, all updates applied.</p>
|
|
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>python3-venv<span class="w"> </span>libatlas-base-dev<span class="w"> </span>cmake
|
|
<span class="c1"># Use pywheels.org to speed up installation</span>
|
|
sudo<span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"[global]\nextra-index-url=https://www.piwheels.org/simple"</span><span class="w"> </span>><span class="w"> </span>tee<span class="w"> </span>/etc/pip.conf
|
|
|
|
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/freqtrade/freqtrade.git
|
|
<span class="nb">cd</span><span class="w"> </span>freqtrade
|
|
|
|
bash<span class="w"> </span>setup.sh<span class="w"> </span>-i
|
|
</code></pre></div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Installation duration</p>
|
|
<p>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 pre-build docker-image for Raspberry, by following the <a href="../docker_quickstart/">Docker quickstart documentation</a></p>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>The above does not install hyperopt dependencies. To install these, please use <code>python3 -m pip install -e .[hyperopt]</code>.
|
|
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.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr />
|
|
<h2 id="freqtrade-repository">Freqtrade repository<a class="headerlink" href="#freqtrade-repository" title="Permanent link">¶</a></h2>
|
|
<p>Freqtrade is an open source crypto-currency trading bot, whose code is hosted on <code>github.com</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># Download `develop` branch of freqtrade repository</span>
|
|
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/freqtrade/freqtrade.git
|
|
|
|
<span class="c1"># Enter downloaded directory</span>
|
|
<span class="nb">cd</span><span class="w"> </span>freqtrade
|
|
|
|
<span class="c1"># your choice (1): novice user</span>
|
|
git<span class="w"> </span>checkout<span class="w"> </span>stable
|
|
|
|
<span class="c1"># your choice (2): advanced user</span>
|
|
git<span class="w"> </span>checkout<span class="w"> </span>develop
|
|
</code></pre></div>
|
|
<p>(1) This command switches the cloned repository to the use of the <code>stable</code> branch. It's not needed, if you wish to stay on the (2) <code>develop</code> branch.</p>
|
|
<p>You may later switch between branches at any time with the <code>git checkout stable</code>/<code>git checkout develop</code> commands.</p>
|
|
<hr />
|
|
<h2 id="script-installation">Script Installation<a class="headerlink" href="#script-installation" title="Permanent link">¶</a></h2>
|
|
<p>First of the ways to install Freqtrade, is to use provided the Linux/MacOS <code>./setup.sh</code> script, which install all dependencies and help you configure the bot.</p>
|
|
<p>Make sure you fulfill the <a href="#requirements">Requirements</a> and have downloaded the <a href="#freqtrade-repository">Freqtrade repository</a>.</p>
|
|
<h3 id="use-setupsh-install-linuxmacos">Use /setup.sh -install (Linux/MacOS)<a class="headerlink" href="#use-setupsh-install-linuxmacos" title="Permanent link">¶</a></h3>
|
|
<p>If you are on Debian, Ubuntu or MacOS, freqtrade provides the script to install freqtrade.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># --install, Install freqtrade from scratch</span>
|
|
./setup.sh<span class="w"> </span>-i
|
|
</code></pre></div>
|
|
<h3 id="activate-your-virtual-environment">Activate your virtual environment<a class="headerlink" href="#activate-your-virtual-environment" title="Permanent link">¶</a></h3>
|
|
<p>Each time you open a new terminal, you must run <code>source .env/bin/activate</code> to activate your virtual environment.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># then activate your .env</span>
|
|
<span class="nb">source</span><span class="w"> </span>./.env/bin/activate
|
|
</code></pre></div>
|
|
<h3 id="congratulations">Congratulations<a class="headerlink" href="#congratulations" title="Permanent link">¶</a></h3>
|
|
<p><a href="#you-are-ready">You are ready</a>, and run the bot</p>
|
|
<h3 id="other-options-of-setupsh-script">Other options of /setup.sh script<a class="headerlink" href="#other-options-of-setupsh-script" title="Permanent link">¶</a></h3>
|
|
<p>You can as well update, configure and reset the codebase of your bot with <code>./script.sh</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># --update, Command git pull to update.</span>
|
|
./setup.sh<span class="w"> </span>-u
|
|
<span class="c1"># --reset, Hard reset your develop/stable branch.</span>
|
|
./setup.sh<span class="w"> </span>-r
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code>** --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 and `--reset`
|
|
|
|
** --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.
|
|
</code></pre></div>
|
|
<hr />
|
|
<h2 id="manual-installation">Manual Installation<a class="headerlink" href="#manual-installation" title="Permanent link">¶</a></h2>
|
|
<p>Make sure you fulfill the <a href="#requirements">Requirements</a> and have downloaded the <a href="#freqtrade-repository">Freqtrade repository</a>.</p>
|
|
<h3 id="install-ta-lib">Install TA-Lib<a class="headerlink" href="#install-ta-lib" title="Permanent link">¶</a></h3>
|
|
<h4 id="ta-lib-script-installation">TA-Lib script installation<a class="headerlink" href="#ta-lib-script-installation" title="Permanent link">¶</a></h4>
|
|
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>./build_helpers/install_ta-lib.sh
|
|
</code></pre></div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>This will use the ta-lib tar.gz included in this repository.</p>
|
|
</div>
|
|
<h5 id="ta-lib-manual-installation">TA-Lib manual installation<a class="headerlink" href="#ta-lib-manual-installation" title="Permanent link">¶</a></h5>
|
|
<p>Official webpage: <a href="https://mrjbq7.github.io/ta-lib/install.html">https://mrjbq7.github.io/ta-lib/install.html</a></p>
|
|
<div class="highlight"><pre><span></span><code>wget<span class="w"> </span>http://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz
|
|
tar<span class="w"> </span>xvzf<span class="w"> </span>ta-lib-0.4.0-src.tar.gz
|
|
<span class="nb">cd</span><span class="w"> </span>ta-lib
|
|
sed<span class="w"> </span>-i.bak<span class="w"> </span><span class="s2">"s|0.00000001|0.000000000000000001 |g"</span><span class="w"> </span>src/ta_func/ta_utility.h
|
|
./configure<span class="w"> </span>--prefix<span class="o">=</span>/usr/local
|
|
make
|
|
sudo<span class="w"> </span>make<span class="w"> </span>install
|
|
<span class="nb">cd</span><span class="w"> </span>..
|
|
rm<span class="w"> </span>-rf<span class="w"> </span>./ta-lib*
|
|
</code></pre></div>
|
|
<h4 id="setup-python-virtual-environment-virtualenv">Setup Python virtual environment (virtualenv)<a class="headerlink" href="#setup-python-virtual-environment-virtualenv" title="Permanent link">¶</a></h4>
|
|
<p>You will run freqtrade in separated <code>virtual environment</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># create virtualenv in directory /freqtrade/.env</span>
|
|
python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>.env
|
|
|
|
<span class="c1"># run virtualenv</span>
|
|
<span class="nb">source</span><span class="w"> </span>.env/bin/activate
|
|
</code></pre></div>
|
|
<h4 id="install-python-dependencies">Install python dependencies<a class="headerlink" href="#install-python-dependencies" title="Permanent link">¶</a></h4>
|
|
<div class="highlight"><pre><span></span><code>python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>pip
|
|
python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
|
|
</code></pre></div>
|
|
<h3 id="congratulations_1">Congratulations<a class="headerlink" href="#congratulations_1" title="Permanent link">¶</a></h3>
|
|
<p><a href="#you-are-ready">You are ready</a>, and run the bot</p>
|
|
<h4 id="optional-post-installation-tasks">(Optional) Post-installation Tasks<a class="headerlink" href="#optional-post-installation-tasks" title="Permanent link">¶</a></h4>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>If you run the bot on a server, you should consider using <a href="../docker_quickstart/">Docker</a> or a terminal multiplexer like <code>screen</code> or <a href="https://en.wikipedia.org/wiki/Tmux"><code>tmux</code></a> to avoid that the bot is stopped on logout.</p>
|
|
</div>
|
|
<p>On Linux with software suite <code>systemd</code>, as an optional post-installation task, you may wish to setup the bot to run as a <code>systemd service</code> or configure it to send the log messages to the <code>syslog</code>/<code>rsyslog</code> or <code>journald</code> daemons. See <a href="../advanced-setup/#advanced-logging">Advanced Logging</a> for details.</p>
|
|
<hr />
|
|
<h2 id="installation-with-conda">Installation with Conda<a class="headerlink" href="#installation-with-conda" title="Permanent link">¶</a></h2>
|
|
<p>Freqtrade can also be installed with Miniconda or Anaconda. We recommend using Miniconda as it's installation footprint is smaller. Conda will automatically prepare and manage the extensive library-dependencies of the Freqtrade program.</p>
|
|
<h3 id="what-is-conda">What is Conda?<a class="headerlink" href="#what-is-conda" title="Permanent link">¶</a></h3>
|
|
<p>Conda is a package, dependency and environment manager for multiple programming languages: <a href="https://docs.conda.io/projects/conda/en/latest/index.html">conda docs</a></p>
|
|
<h3 id="installation-with-conda_1">Installation with conda<a class="headerlink" href="#installation-with-conda_1" title="Permanent link">¶</a></h3>
|
|
<h4 id="install-conda">Install Conda<a class="headerlink" href="#install-conda" title="Permanent link">¶</a></h4>
|
|
<p><a href="https://conda.io/projects/conda/en/latest/user-guide/install/linux.html#install-linux-silent">Installing on linux</a></p>
|
|
<p><a href="https://conda.io/projects/conda/en/latest/user-guide/install/windows.html">Installing on windows</a></p>
|
|
<p>Answer all questions. After installation, it is mandatory to turn your terminal OFF and ON again.</p>
|
|
<h4 id="freqtrade-download">Freqtrade download<a class="headerlink" href="#freqtrade-download" title="Permanent link">¶</a></h4>
|
|
<p>Download and install freqtrade.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># download freqtrade</span>
|
|
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/freqtrade/freqtrade.git
|
|
|
|
<span class="c1"># enter downloaded directory 'freqtrade'</span>
|
|
<span class="nb">cd</span><span class="w"> </span>freqtrade<span class="w"> </span>
|
|
</code></pre></div>
|
|
<h4 id="freqtrade-instal-conda-environment">Freqtrade instal: Conda Environment<a class="headerlink" href="#freqtrade-instal-conda-environment" title="Permanent link">¶</a></h4>
|
|
<p>Prepare conda-freqtrade environment, using file <code>environment.yml</code>, which exist in main freqtrade directory</p>
|
|
<div class="highlight"><pre><span></span><code>conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>freqtrade-conda<span class="w"> </span>-f<span class="w"> </span>environment.yml
|
|
</code></pre></div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Creating Conda Environment</p>
|
|
<p>The conda command <code>create -n</code> automatically installs all nested dependencies for the selected libraries, general structure of installation command is:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># choose your own packages</span>
|
|
conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span><span class="o">[</span>name<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>environment<span class="o">]</span><span class="w"> </span><span class="o">[</span>python<span class="w"> </span>version<span class="o">]</span><span class="w"> </span><span class="o">[</span>packages<span class="o">]</span>
|
|
|
|
<span class="c1"># point to file with packages</span>
|
|
conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span><span class="o">[</span>name<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>environment<span class="o">]</span><span class="w"> </span>-f<span class="w"> </span><span class="o">[</span>file<span class="o">]</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<h4 id="enterexit-freqtrade-conda-environment">Enter/exit freqtrade-conda environment<a class="headerlink" href="#enterexit-freqtrade-conda-environment" title="Permanent link">¶</a></h4>
|
|
<p>To check available environments, type</p>
|
|
<div class="highlight"><pre><span></span><code>conda<span class="w"> </span>env<span class="w"> </span>list
|
|
</code></pre></div>
|
|
<p>Enter installed environment</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># enter conda environment</span>
|
|
conda<span class="w"> </span>activate<span class="w"> </span>freqtrade-conda
|
|
|
|
<span class="c1"># exit conda environment - don't do it now</span>
|
|
conda<span class="w"> </span>deactivate
|
|
</code></pre></div>
|
|
<p>Install last python dependencies with pip</p>
|
|
<div class="highlight"><pre><span></span><code>python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>pip
|
|
python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
|
|
</code></pre></div>
|
|
<h3 id="congratulations_2">Congratulations<a class="headerlink" href="#congratulations_2" title="Permanent link">¶</a></h3>
|
|
<p><a href="#you-are-ready">You are ready</a>, and run the bot</p>
|
|
<h3 id="important-shortcuts">Important shortcuts<a class="headerlink" href="#important-shortcuts" title="Permanent link">¶</a></h3>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># list installed conda environments</span>
|
|
conda<span class="w"> </span>env<span class="w"> </span>list
|
|
|
|
<span class="c1"># activate base environment</span>
|
|
conda<span class="w"> </span>activate
|
|
|
|
<span class="c1"># activate freqtrade-conda environment</span>
|
|
conda<span class="w"> </span>activate<span class="w"> </span>freqtrade-conda
|
|
|
|
<span class="c1">#deactivate any conda environments</span>
|
|
conda<span class="w"> </span>deactivate<span class="w"> </span>
|
|
</code></pre></div>
|
|
<h3 id="further-info-on-anaconda">Further info on anaconda<a class="headerlink" href="#further-info-on-anaconda" title="Permanent link">¶</a></h3>
|
|
<div class="admonition info">
|
|
<p class="admonition-title">New heavy packages</p>
|
|
<p>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 library or application, into previously set environment.</p>
|
|
</div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">pip install within conda</p>
|
|
<p>The documentation of conda says that pip should NOT be used within conda, because internal problems can occur.
|
|
However, they are rare. <a href="https://www.anaconda.com/blog/using-pip-in-a-conda-environment">Anaconda Blogpost</a></p>
|
|
<p>Nevertheless, that is why, the <code>conda-forge</code> channel is preferred:</p>
|
|
<ul>
|
|
<li>more libraries are available (less need for <code>pip</code>)</li>
|
|
<li><code>conda-forge</code> works better with <code>pip</code></li>
|
|
<li>the libraries are newer</li>
|
|
</ul>
|
|
</div>
|
|
<p>Happy trading!</p>
|
|
<hr />
|
|
<h2 id="you-are-ready">You are ready<a class="headerlink" href="#you-are-ready" title="Permanent link">¶</a></h2>
|
|
<p>You've made it this far, so you have successfully installed freqtrade.</p>
|
|
<h3 id="initialize-the-configuration">Initialize the configuration<a class="headerlink" href="#initialize-the-configuration" title="Permanent link">¶</a></h3>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># Step 1 - Initialize user folder</span>
|
|
freqtrade<span class="w"> </span>create-userdir<span class="w"> </span>--userdir<span class="w"> </span>user_data
|
|
|
|
<span class="c1"># Step 2 - Create a new configuration file</span>
|
|
freqtrade<span class="w"> </span>new-config<span class="w"> </span>--config<span class="w"> </span>config.json
|
|
</code></pre></div>
|
|
<p>You are ready to run, read <a href="../configuration/">Bot Configuration</a>, remember to start with <code>dry_run: True</code> and verify that everything is working.</p>
|
|
<p>To learn how to setup your configuration, please refer to the <a href="../configuration/">Bot Configuration</a> documentation page.</p>
|
|
<h3 id="start-the-bot">Start the Bot<a class="headerlink" href="#start-the-bot" title="Permanent link">¶</a></h3>
|
|
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>trade<span class="w"> </span>--config<span class="w"> </span>config.json<span class="w"> </span>--strategy<span class="w"> </span>SampleStrategy
|
|
</code></pre></div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>You should read through the rest of the documentation, backtest the strategy you're going to use, and use dry-run before enabling trading with real money.</p>
|
|
</div>
|
|
<hr />
|
|
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">¶</a></h2>
|
|
<h3 id="common-problem-command-not-found">Common problem: "command not found"<a class="headerlink" href="#common-problem-command-not-found" title="Permanent link">¶</a></h3>
|
|
<p>If you used (1)<code>Script</code> or (2)<code>Manual</code> installation, you need to run the bot in virtual environment. If you get error as below, make sure venv is active.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># if:</span>
|
|
bash:<span class="w"> </span>freqtrade:<span class="w"> </span><span class="nb">command</span><span class="w"> </span>not<span class="w"> </span>found
|
|
|
|
<span class="c1"># then activate your .env</span>
|
|
<span class="nb">source</span><span class="w"> </span>./.env/bin/activate
|
|
</code></pre></div>
|
|
<h3 id="macos-installation-error">MacOS installation error<a class="headerlink" href="#macos-installation-error" title="Permanent link">¶</a></h3>
|
|
<p>Newer versions of MacOS may have installation failed with errors like <code>error: command 'g++' failed with exit status 1</code>.</p>
|
|
<p>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.</p>
|
|
<div class="highlight"><pre><span></span><code>open<span class="w"> </span>/Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg
|
|
</code></pre></div>
|
|
<p>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.</p>
|
|
<h3 id="macos-installation-error-with-python-39">MacOS installation error with python 3.9<a class="headerlink" href="#macos-installation-error-with-python-39" title="Permanent link">¶</a></h3>
|
|
<p>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 <code>tables</code> or <code>blosc</code>.</p>
|
|
<p>You can install the necessary libraries with the following command:</p>
|
|
<div class="highlight"><pre><span></span><code>brew<span class="w"> </span>install<span class="w"> </span>hdf5<span class="w"> </span>c-blosc
|
|
</code></pre></div>
|
|
<p>After this, please run the installation (script) again.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
</div>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
|
|
|
|
|
|
<script src="../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
|
|
|
|
<script src="../javascripts/config.js"></script>
|
|
|
|
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |