DOC: updated documentation

This commit is contained in:
Frederic Fortier
2018-02-09 12:12:06 -05:00
parent e6fa2827e2
commit c566a373fd
62 changed files with 5085 additions and 34053 deletions
+223 -173
View File
@@ -13,8 +13,6 @@
@@ -32,9 +30,6 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Catalyst 0.4 documentation" href="index.html"/>
<link rel="prev" title="Development Guidelines" href="development-guidelines.html"/>
@@ -45,28 +40,21 @@
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Catalyst
<a href="index.html" class="icon icon-home"> Catalyst
</a>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
@@ -75,110 +63,194 @@
</form>
</div>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="beginner-tutorial.html">Catalyst Beginner Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="live-trading.html">Live Trading</a></li>
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="example-algos.html">Example Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="development-guidelines.html">Development Guidelines</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-5-2">Version 0.5.2</a><ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-with-conda">Installing with <code class="docutils literal"><span class="pre">conda</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#troubleshooting-conda-install">Troubleshooting <code class="docutils literal"><span class="pre">conda</span></code> Install</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-with-pip">Installing with <code class="docutils literal"><span class="pre">pip</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#troubleshooting-pip-install">Troubleshooting <code class="docutils literal"><span class="pre">pip</span></code> Install</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-with-pipenv">Installing with <code class="docutils literal"><span class="pre">pipenv</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#gnu-linux-requirements">GNU/Linux Requirements</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#amazon-linux-ami-notes">Amazon Linux AMI Notes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#macos-requirements">MacOS Requirements</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#macos-virtualenv-conda-matplotlib">MacOS + virtualenv/conda + matplotlib</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="beginner-tutorial.html">Catalyst Beginner Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="beginner-tutorial.html#basics">Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="beginner-tutorial.html#my-first-algorithm">My first algorithm</a></li>
<li class="toctree-l2"><a class="reference internal" href="beginner-tutorial.html#ingesting-data">Ingesting data</a></li>
<li class="toctree-l2"><a class="reference internal" href="beginner-tutorial.html#running-the-algorithm">Running the algorithm</a><ul>
<li class="toctree-l3"><a class="reference internal" href="beginner-tutorial.html#command-line-interface">Command line interface</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="beginner-tutorial.html#access-to-previous-prices-using-history">Access to previous prices using <code class="docutils literal"><span class="pre">history</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="beginner-tutorial.html#working-example-dual-moving-average-cross-over">Working example: Dual Moving Average Cross-Over</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="beginner-tutorial.html#jupyter-notebook">Jupyter Notebook</a><ul>
<li class="toctree-l3"><a class="reference internal" href="beginner-tutorial.html#install">Install</a></li>
<li class="toctree-l3"><a class="reference internal" href="beginner-tutorial.html#running-algorithms">Running Algorithms</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="beginner-tutorial.html#next-steps">Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="live-trading.html">Live Trading</a><ul>
<li class="toctree-l2"><a class="reference internal" href="live-trading.html#supported-exchanges">Supported Exchanges</a></li>
<li class="toctree-l2"><a class="reference internal" href="live-trading.html#paper-trading-vs-live-trading-modes">Paper Trading vs Live Trading modes</a></li>
<li class="toctree-l2"><a class="reference internal" href="live-trading.html#authentication">Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="live-trading.html#currency-symbols">Currency Symbols</a></li>
<li class="toctree-l2"><a class="reference internal" href="live-trading.html#trading-an-algorithm">Trading an Algorithm</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="features.html#current-functionality">Current Functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="features.html#upcoming-features">Upcoming features</a></li>
<li class="toctree-l2"><a class="reference internal" href="features.html#naming-convention">Naming Convention</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="example-algos.html">Example Algorithms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="example-algos.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="example-algos.html#buy-btc-simple-algorithm">Buy BTC Simple Algorithm</a></li>
<li class="toctree-l2"><a class="reference internal" href="example-algos.html#buy-and-hodl-algorithm">Buy and Hodl Algorithm</a></li>
<li class="toctree-l2"><a class="reference internal" href="example-algos.html#dual-moving-average-crossover">Dual Moving Average Crossover</a></li>
<li class="toctree-l2"><a class="reference internal" href="example-algos.html#mean-reversion-algorithm">Mean Reversion Algorithm</a></li>
<li class="toctree-l2"><a class="reference internal" href="example-algos.html#simple-universe">Simple Universe</a></li>
<li class="toctree-l2"><a class="reference internal" href="example-algos.html#portfolio-optimization">Portfolio Optimization</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">Utilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="utilities.html#output-to-csv-file">Output to CSV file</a></li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html#extracting-market-data">Extracting market data</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a><ul>
<li class="toctree-l2"><a class="reference internal" href="videos.html#installation-macos">Installation: MacOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#installation-windows">Installation: Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#backtesting-a-strategy">Backtesting a Strategy</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#live-trading-a-strategy">Live Trading a Strategy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources.html#related-3rd-party-apis">Related 3rd Party APIs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development-guidelines.html">Development Guidelines</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#creating-a-development-environment">Creating a Development Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#development-with-docker">Development with Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#git-branching-structure">Git Branching Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#contributing-to-the-docs">Contributing to the Docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#commit-messages">Commit messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#formatting-docstrings">Formatting Docstrings</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-5-3">Version 0.5.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#bug-fixes">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-5-1">Version 0.5.1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-5-2">Version 0.5.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id1">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-5-1">Version 0.5.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id2">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#build">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-7">Version 0.4.7</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id2">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-6">Version 0.4.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id4">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-5">Version 0.4.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id6">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-4">Version 0.4.4</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id7">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-3">Version 0.4.3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-4">Version 0.4.4</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id8">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-2">Version 0.4.2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-3">Version 0.4.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id9">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-2">Version 0.4.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id10">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id11">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-4-0">Version 0.4.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id11">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#version-0-3-10">Version 0.3.10</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id14">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-9">Version 0.3.9</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id14">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id16">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-8">Version 0.3.8</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id16">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id17">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-7">Version 0.3.7</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id17">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id18">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id18">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-6">Version 0.3.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id19">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-5">Version 0.3.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id20">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-4">Version 0.3.4</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-5">Version 0.3.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id21">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id22">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-4">Version 0.3.4</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id22">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id23">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#documentation">Documentation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-3">Version 0.3.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id24">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id25">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id25">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id26">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-2">Version 0.3.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id26">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id27">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id27">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id28">Build</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3-1">Version 0.3.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id28">Bug Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id29">Bug Fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#version-0-3">Version 0.3</a></li>
@@ -195,74 +267,58 @@
</li>
</ul>
</div>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Catalyst</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Catalyst</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Release Notes</li>
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Release Notes</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/releases.rst.txt" rel="nofollow"> View page source</a>
<a href="_sources/releases.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div role="main" class="document">
<div class="section" id="release-notes">
<h1>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline"></a></h1>
<div class="section" id="version-0-5-3">
<h2>Version 0.5.3<a class="headerlink" href="#version-0-5-3" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-02-09</p>
<div class="section" id="bug-fixes">
<h3>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed an issue with last candle in backtesting <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/219">#219</a></li>
</ul>
</div>
</div>
<div class="section" id="version-0-5-2">
<h2>Version 0.5.2<a class="headerlink" href="#version-0-5-2" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-02-08</p>
<div class="section" id="bug-fixes">
<h3>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline"></a></h3>
<div class="section" id="id1">
<h3>Bug Fixes<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed an issue with live candle values <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/216">#216</a> and <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/199">#199</a></li>
</ul>
@@ -271,8 +327,8 @@
<div class="section" id="version-0-5-1">
<h2>Version 0.5.1<a class="headerlink" href="#version-0-5-1" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-02-07</p>
<div class="section" id="id1">
<h3>Bug Fixes<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="section" id="id2">
<h3>Bug Fixes<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed an issue with orders that stay open <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/211">#211</a></li>
<li>Fixed Jupyter issues <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/179">#179</a></li>
@@ -290,14 +346,14 @@
<div class="section" id="version-0-4-7">
<h2>Version 0.4.7<a class="headerlink" href="#version-0-4-7" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-01-19</p>
<div class="section" id="id2">
<h3>Bug Fixes<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h3>Bug Fixes<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixing issue <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/137">#137</a> impacting the CLI</li>
</ul>
</div>
<div class="section" id="id3">
<h3>Build<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="section" id="id4">
<h3>Build<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Implemented authentication aliases (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/60">#60</a>)</li>
</ul>
@@ -306,8 +362,8 @@
<div class="section" id="version-0-4-6">
<h2>Version 0.4.6<a class="headerlink" href="#version-0-4-6" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-01-18</p>
<div class="section" id="id4">
<h3>Bug Fixes<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<div class="section" id="id5">
<h3>Bug Fixes<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed some Python3 issues</li>
<li>Reading the trade log to get executed order prices on exchanges like Binance (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/151">#151</a>)</li>
@@ -317,8 +373,8 @@
<li>Using Bitfinex instead of Poloniex to fetch btc_usdt benchmark (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/161">#161</a>)</li>
</ul>
</div>
<div class="section" id="id5">
<h3>Build<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="id6">
<h3>Build<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Added a <cite>context.state</cite> dict to keep arbitrary state values between runs</li>
<li>Added ability to stop live algo at specified end date</li>
@@ -328,8 +384,8 @@
<div class="section" id="version-0-4-5">
<h2>Version 0.4.5<a class="headerlink" href="#version-0-4-5" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-01-12</p>
<div class="section" id="id6">
<h3>Bug Fixes<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<div class="section" id="id7">
<h3>Bug Fixes<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Improved order execution for exchanges supporting trade lists (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/151">#151</a>)</li>
<li>Fixed an issue where requesting history of multiple assets repeats values</li>
@@ -341,8 +397,8 @@
<div class="section" id="version-0-4-4">
<h2>Version 0.4.4<a class="headerlink" href="#version-0-4-4" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-01-09</p>
<div class="section" id="id7">
<h3>Bug Fixes<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<div class="section" id="id8">
<h3>Bug Fixes<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Removed redundant capital_base validation (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/142">#142</a>)</li>
<li>Fixed portfolio update issue with restored state (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/111">#111</a>)</li>
@@ -353,8 +409,8 @@
<div class="section" id="version-0-4-3">
<h2>Version 0.4.3<a class="headerlink" href="#version-0-4-3" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-01-05</p>
<div class="section" id="id8">
<h3>Bug Fixes<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<div class="section" id="id9">
<h3>Bug Fixes<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed CLI issue (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/137">#137</a>)</li>
<li>Upgraded CCXT</li>
@@ -364,8 +420,8 @@
<div class="section" id="version-0-4-2">
<h2>Version 0.4.2<a class="headerlink" href="#version-0-4-2" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2018-01-03</p>
<div class="section" id="id9">
<h3>Bug Fixes<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<div class="section" id="id10">
<h3>Bug Fixes<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed cash synchronization issue (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/133">#133</a>)</li>
<li>Fixed positions synchronization issue (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/132">#132</a>)</li>
@@ -375,8 +431,8 @@
<li>Fixed a poloniex specific issue in live trading (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/103">#103</a>)</li>
</ul>
</div>
<div class="section" id="id10">
<h3>Build<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<div class="section" id="id11">
<h3>Build<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Caching CCXT market info to limit round-trips (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/99">#99</a>)</li>
<li>Tentative support for Pipeline (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/96">#96</a>)</li>
@@ -386,16 +442,16 @@
<div class="section" id="version-0-4-0">
<h2>Version 0.4.0<a class="headerlink" href="#version-0-4-0" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-12-12</p>
<div class="section" id="id11">
<h3>Bug Fixes<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<div class="section" id="id12">
<h3>Bug Fixes<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Changed Poloniex interface (should solve <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/95">#95</a> and <a class="reference external" href="https://github.com/enigmampc/catalyst/issues/94">#94</a>)</li>
<li>Solved issue with overriding commission and slippage (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/87">#87</a>)</li>
<li>Fixed inefficiency with Bittrex current prices (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/76">#76</a>)</li>
</ul>
</div>
<div class="section" id="id12">
<h3>Build<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3>
<div class="section" id="id13">
<h3>Build<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Integrated with CCXT</li>
<li>Added paper trading capability (<cite>simulate_orders=True</cite> param in live mode)</li>
@@ -407,8 +463,8 @@
<h3>Version 0.3.10<a class="headerlink" href="#version-0-3-10" title="Permalink to this headline"></a></h3>
<p><strong>Release Date</strong>: 2017-11-28</p>
</div>
<div class="section" id="id13">
<h3>Bug Fixes<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h3>
<div class="section" id="id14">
<h3>Bug Fixes<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed issue with fetching assets with daily frequency</li>
</ul>
@@ -417,15 +473,15 @@
<div class="section" id="version-0-3-9">
<h2>Version 0.3.9<a class="headerlink" href="#version-0-3-9" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-11-28</p>
<div class="section" id="id14">
<h3>Bug Fixes<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
<div class="section" id="id15">
<h3>Bug Fixes<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed sortino warning issues (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/77">#77</a>)</li>
<li>Adjusted computation of last candle of data.history (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/71">#71</a>)</li>
</ul>
</div>
<div class="section" id="id15">
<h3>Build<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3>
<div class="section" id="id16">
<h3>Build<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Added capital_base parameter to live mode to limit cash (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/79">#79</a>)</li>
<li>Added support for csv ingestion (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/65">#65</a>)</li>
@@ -436,8 +492,8 @@
<div class="section" id="version-0-3-8">
<h2>Version 0.3.8<a class="headerlink" href="#version-0-3-8" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-11-14</p>
<div class="section" id="id16">
<h3>Bug Fixes<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h3>
<div class="section" id="id17">
<h3>Bug Fixes<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed a warning filter issue introduced with the latest release</li>
</ul>
@@ -446,8 +502,8 @@
<div class="section" id="version-0-3-7">
<h2>Version 0.3.7<a class="headerlink" href="#version-0-3-7" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-11-14</p>
<div class="section" id="id17">
<h3>Bug Fixes<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h3>
<div class="section" id="id18">
<h3>Bug Fixes<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed an SSL cert issue (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/64">#64</a>)</li>
<li>Fixed cumulative stats warnings (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/63">#63</a>)</li>
@@ -455,8 +511,8 @@
<li>Standardized live-trading stats (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/61">#61</a>)</li>
</ul>
</div>
<div class="section" id="id18">
<h3>Build<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h3>
<div class="section" id="id19">
<h3>Build<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Added a mean-reversion sample algo</li>
<li>Added minutely stats in the analyze() function (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/62">#62</a>)</li>
@@ -467,8 +523,8 @@
<div class="section" id="version-0-3-6">
<h2>Version 0.3.6<a class="headerlink" href="#version-0-3-6" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-11-4</p>
<div class="section" id="id19">
<h3>Bug Fixes<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h3>
<div class="section" id="id20">
<h3>Bug Fixes<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed an issue with single bar data.history() (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/55">#55</a>)</li>
</ul>
@@ -477,8 +533,8 @@
<div class="section" id="version-0-3-5">
<h2>Version 0.3.5<a class="headerlink" href="#version-0-3-5" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-11-4</p>
<div class="section" id="id20">
<h3>Bug Fixes<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h3>
<div class="section" id="id21">
<h3>Bug Fixes<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Added workaround for: KeyError: Timestamp error (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/53">#53</a>)</li>
</ul>
@@ -487,8 +543,8 @@
<div class="section" id="version-0-3-4">
<h2>Version 0.3.4<a class="headerlink" href="#version-0-3-4" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-11-2</p>
<div class="section" id="id21">
<h3>Bug Fixes<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h3>
<div class="section" id="id22">
<h3>Bug Fixes<a class="headerlink" href="#id22" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed issue with auto-ingestion of minute data (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/47">#47</a>)</li>
<li>Fixed issue with sell orders in backtesting</li>
@@ -498,8 +554,8 @@
transactions</li>
</ul>
</div>
<div class="section" id="id22">
<h3>Build<a class="headerlink" href="#id22" title="Permalink to this headline"></a></h3>
<div class="section" id="id23">
<h3>Build<a class="headerlink" href="#id23" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Added more unit tests</li>
</ul>
@@ -526,16 +582,16 @@ transactions</li>
<div class="section" id="version-0-3-3">
<h2>Version 0.3.3<a class="headerlink" href="#version-0-3-3" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-10-26</p>
<div class="section" id="id24">
<h3>Bug Fixes<a class="headerlink" href="#id24" title="Permalink to this headline"></a></h3>
<div class="section" id="id25">
<h3>Bug Fixes<a class="headerlink" href="#id25" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fix missing -x in ingest-exchange</li>
<li>Fix issue with daily chunks end date (data bundles)</li>
<li>Fix issue in the prepare_chunk logic (data bundles)</li>
</ul>
</div>
<div class="section" id="id25">
<h3>Build<a class="headerlink" href="#id25" title="Permalink to this headline"></a></h3>
<div class="section" id="id26">
<h3>Build<a class="headerlink" href="#id26" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Added data validation unit tests</li>
</ul>
@@ -544,8 +600,8 @@ transactions</li>
<div class="section" id="version-0-3-2">
<h2>Version 0.3.2<a class="headerlink" href="#version-0-3-2" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-10-25</p>
<div class="section" id="id26">
<h3>Bug Fixes<a class="headerlink" href="#id26" title="Permalink to this headline"></a></h3>
<div class="section" id="id27">
<h3>Bug Fixes<a class="headerlink" href="#id27" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fix to work with empty data bundles</li>
<li>Fix Windows path of <code class="docutils literal"><span class="pre">$HOME/.catalyst</span></code> folder</li>
@@ -554,8 +610,8 @@ transactions</li>
<li>Fix an issue with asset date in chunks</li>
</ul>
</div>
<div class="section" id="id27">
<h3>Build<a class="headerlink" href="#id27" title="Permalink to this headline"></a></h3>
<div class="section" id="id28">
<h3>Build<a class="headerlink" href="#id28" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Python3 adjustments</li>
<li>Added method to clean bundle folders, and remove symbols.json</li>
@@ -566,8 +622,8 @@ transactions</li>
<div class="section" id="version-0-3-1">
<h2>Version 0.3.1<a class="headerlink" href="#version-0-3-1" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-10-22</p>
<div class="section" id="id28">
<h3>Bug Fixes<a class="headerlink" href="#id28" title="Permalink to this headline"></a></h3>
<div class="section" id="id29">
<h3>Bug Fixes<a class="headerlink" href="#id29" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed OS-dependent path issue in data bundle</li>
<li>Changed handling of empty <code class="docutils literal"><span class="pre">auth.json</span></code>, instead of throwing an error for
@@ -594,7 +650,7 @@ missing file</li>
<h2>Version 0.2.dev5<a class="headerlink" href="#version-0-2-dev5" title="Permalink to this headline"></a></h2>
<p><strong>Release Date</strong>: 2017-10-03</p>
<ul class="simple">
<li>Fixes bug in data.history function that was formatting volume data as
<li>Fixes bug in data.history function that was formatting &#8216;volume&#8217; data as
integers, now they are returned as floats with up to 9 decimals of precision.
Data bundles redone.</li>
</ul>
@@ -687,17 +743,13 @@ exchange directly</li>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="development-guidelines.html" class="btn btn-neutral" title="Development Guidelines" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="development-guidelines.html" class="btn btn-neutral" title="Development Guidelines" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -707,10 +759,9 @@ exchange directly</li>
<div role="contentinfo">
<p>
&copy; Copyright 2018, Enigma MPC, Inc..
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
@@ -731,8 +782,7 @@ exchange directly</li>
VERSION:'0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>