mirror of
https://github.com/wassname/catalyst.git
synced 2026-07-12 14:37:22 +08:00
400 lines
18 KiB
HTML
400 lines
18 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Release Notes — Catalyst 0.3 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
|
<link rel="prev" title="Development Guidelines" href="development-guidelines.html"/>
|
|
|
|
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<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-nav-search">
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home"> Catalyst
|
|
|
|
|
|
|
|
</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" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<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><ul>
|
|
<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#gnu-linux">GNU/Linux</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="install.html#osx">OSX</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="install.html#osx-virtualenv-matplotlib">OSX + virtualenv + matplotlib</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="install.html#windows">Windows</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="install.html#amazon-linux-ami">Amazon Linux AMI</a></li>
|
|
<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-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#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#running-the-algorithm">Running the algorithm</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="beginner-tutorial.html#ingesting-data">Ingesting data</a></li>
|
|
<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#conclusions">Conclusions</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#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="naming-convention.html">Naming Convention</a></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>
|
|
</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#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-3-3">Version 0.3.3</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#bug-fixes">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-3-2">Version 0.3.2</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#id1">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#id2">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="#id3">Bug Fixes</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-3">Version 0.3</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-dev5">Version 0.2.dev5</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-dev4">Version 0.2.dev4</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-dev3">Version 0.2.dev3</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-dev2">Version 0.2.dev2</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-2-dev1">Version 0.2.dev1</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-1-dev9">Version 0.1.dev9</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-1-dev8">Version 0.1.dev8</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-1-dev7">Version 0.1.dev7</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#version-0-1-dev6">Version 0.1.dev6</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</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>
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html">Docs</a> »</li>
|
|
|
|
<li>Release Notes</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/releases.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<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-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="bug-fixes">
|
|
<h3>Bug Fixes<a class="headerlink" href="#bug-fixes" 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="build">
|
|
<h3>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h3>
|
|
<ul class="simple">
|
|
<li>Added data validation unit tests</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<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="id1">
|
|
<h3>Bug Fixes<a class="headerlink" href="#id1" 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>
|
|
<li>Fix <code class="docutils literal"><span class="pre">etc/python2.7-environment.yml</span></code> for Windows Conda install</li>
|
|
<li>Fix hash method to create sid numbers compatible across platforms</li>
|
|
<li>Fix an issue with asset date in chunks</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="id2">
|
|
<h3>Build<a class="headerlink" href="#id2" 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>
|
|
<li>Implemented and improved unit tests</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<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="id3">
|
|
<h3>Bug Fixes<a class="headerlink" href="#id3" 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 missing file</li>
|
|
<li>Updated <code class="docutils literal"><span class="pre">etc/python2.7-environment.yml</span></code> to work with Catalyst version 0.3</li>
|
|
<li>Updated <code class="docutils literal"><span class="pre">catalyst/examples/buy_and_hodl.py</span></code> and <code class="docutils literal"><span class="pre">catalyst/examples/buy_low_sell_high.py</span></code> to work with Catalyst version 0.3</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="version-0-3">
|
|
<h2>Version 0.3<a class="headerlink" href="#version-0-3" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-10-20</p>
|
|
</div>
|
|
<div class="section" id="version-0-2-dev5">
|
|
<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 integers, now they are returned as floats with up to 9 decimals of precision. Data bundles redone.</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-2-dev4">
|
|
<h2>Version 0.2.dev4<a class="headerlink" href="#version-0-2-dev4" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-09-20</p>
|
|
<ul class="simple">
|
|
<li>Fixes bug in the pricing resolution of 1-minute data, now set to 8 decimal places. Pricing resolution of daily data remains set to 9 decimal places.</li>
|
|
<li>The current data bundle takes 340MB compressed for download, and 460MB uncompressed on disk for Catalyst to use.</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-2-dev3">
|
|
<h2>Version 0.2.dev3<a class="headerlink" href="#version-0-2-dev3" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-09-20</p>
|
|
<ul class="simple">
|
|
<li>1-minute resolution OHLCV data bundle for backtesting from Poloniex exchange</li>
|
|
<li>Implementation of trading of fractional crypto assets (i.e. 0.01 BTC)</li>
|
|
<li>Minimum trade size of a coin can be configured on a per-coin basis, defaults to 0.00000001 in backtesting (most exchanges set the minimum trade to larger amounts, which will impact live trading)</li>
|
|
<li>Increased pricing resolution from 3 to 9 decimal places</li>
|
|
<li>The current data bundle takes 40MB compressed for download, and 99MB uncompressed on disk for Catalyst to use.</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-2-dev2">
|
|
<h2>Version 0.2.dev2<a class="headerlink" href="#version-0-2-dev2" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-09-07</p>
|
|
<ul class="simple">
|
|
<li>Fix path issue</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-2-dev1">
|
|
<h2>Version 0.2.dev1<a class="headerlink" href="#version-0-2-dev1" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-09-03</p>
|
|
<ul class="simple">
|
|
<li>Implementation of live trading:<ul>
|
|
<li>Comprehensive trading functionality against exchanges Bitfinex and Bittrex.</li>
|
|
<li>Support for all trading pairs available on each exchange.</li>
|
|
<li>Multiple algorithms can trade simultaneously against a single exchange using the same account.</li>
|
|
<li>Each algorithm has a persisted state (i.e. algorithm can be stopped and restarted preserving the state without data loss) that tracks all open orders, executed transactions and portfolio positions.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Minute by minute portfolio performance metrics.<ul>
|
|
<li>Daily summary performance statistics compatible with pyfolio, a Python library for performance and risk analysis of financial portfolios</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-1-dev9">
|
|
<h2>Version 0.1.dev9<a class="headerlink" href="#version-0-1-dev9" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-08-28</p>
|
|
<ul class="simple">
|
|
<li>Retrieval of crypto benchmark from bundle, instead of hitting Poloniex exchange directly</li>
|
|
<li>Change of bundle storage provider from Dropbox to AWS</li>
|
|
<li>Fix issue with 1/1000 scaling issue of prices in bundle</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-1-dev8">
|
|
<h2>Version 0.1.dev8<a class="headerlink" href="#version-0-1-dev8" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-08-18</p>
|
|
<ul class="simple">
|
|
<li>Fixes issue in the creation of bundles (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/27">#27</a>)</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-1-dev7">
|
|
<h2>Version 0.1.dev7<a class="headerlink" href="#version-0-1-dev7" title="Permalink to this headline">¶</a></h2>
|
|
<ul class="simple">
|
|
<li>Fixes issues in empty benchmark (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/16">#16</a>)</li>
|
|
<li>Fixes issue of normalizing timestamps before comparison (<a class="reference external" href="https://github.com/enigmampc/catalyst/issues/24">#24</a>)</li>
|
|
<li>Generic data bundles</li>
|
|
<li>CLI UI improvements</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="version-0-1-dev6">
|
|
<h2>Version 0.1.dev6<a class="headerlink" href="#version-0-1-dev6" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Release Date</strong>: 2017-07-13</p>
|
|
<ul class="simple">
|
|
<li>Initial public release</li>
|
|
</ul>
|
|
</div>
|
|
</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"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2017, 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>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'./',
|
|
VERSION:'0.3',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |