mirror of
https://github.com/wassname/catalyst.git
synced 2026-06-27 17:47:56 +08:00
Victor Grau Serrat
305 lines
10 KiB
HTML
305 lines
10 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>Overview — Catalyst 0.4 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
<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="#"/>
|
||
<link rel="next" title="Install" href="install.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-scroll">
|
||
<div class="wy-side-nav-search">
|
||
|
||
|
||
|
||
<a href="#" 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>
|
||
<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"><a class="reference internal" href="releases.html">Release Notes</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</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="#">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="#">Docs</a> »</li>
|
||
|
||
<li>Overview</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/index.rst.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">
|
||
|
||
<a class="reference external image-reference" href="https://enigmampc.github.io/catalyst"><img alt="Enigma | Catalyst" class="align-center" src="https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.png" /></a>
|
||
<p><a class="reference external" href="https://pypi.python.org/pypi/enigma-catalyst"><img alt="version tag" src="https://img.shields.io/pypi/v/enigma-catalyst.svg" /></a>
|
||
<a class="reference external" href="https://pypi.python.org/pypi/enigma-catalyst"><img alt="version status" src="https://img.shields.io/pypi/pyversions/enigma-catalyst.svg" /></a>
|
||
<a class="reference external" href="https://catalyst.enigma.co/"><img alt="forum" src="https://img.shields.io/badge/forum-join-green.svg" /></a>
|
||
<a class="reference external" href="https://discordapp.com/invite/SJK32GY"><img alt="discord" src="https://img.shields.io/badge/discord-join%20chat-green.svg" /></a>
|
||
<a class="reference external" href="https://twitter.com/enigmampc"><img alt="twitter" src="https://img.shields.io/twitter/follow/enigmampc.svg?style=social&label=Follow&style=flat-square" /></a></p>
|
||
<div class="line-block">
|
||
<div class="line"><br /></div>
|
||
</div>
|
||
<p>Catalyst is an algorithmic trading library for crypto-assets written in Python.
|
||
It allows trading strategies to be easily expressed and backtested against
|
||
historical data (with daily and minute resolution), providing analytics and
|
||
insights regarding a particular strategy’s performance. Catalyst also supports
|
||
live-trading of crypto-assets starting with three exchanges (Bitfinex, Bittrex,
|
||
and Poloniex) with more being added over time. Catalyst empowers users to share
|
||
and curate data and build profitable, data-driven investment strategies. Please
|
||
visit <a class="reference external" href="https://www.enigma.co">enigma.co</a> to learn more about Catalyst.</p>
|
||
<p>Catalyst builds on top of the well-established
|
||
<a class="reference external" href="https://github.com/quantopian/zipline">Zipline</a> project. We did our best to
|
||
minimize structural changes to the general API to maximize compatibility with
|
||
existing trading algorithms, developer knowledge, and tutorials. Join us on the
|
||
<a class="reference external" href="https://catalyst.enigma.co/">Catalyst Forum</a> for questions around Catalyst,
|
||
algorithmic trading and technical support. We also have a
|
||
<a class="reference external" href="https://discord.gg/SJK32GY">Discord</a> group with the <em>#catalyst_dev</em> and
|
||
<em>#catalyst_setup</em> dedicated channels.</p>
|
||
<div class="section" id="overview">
|
||
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
|
||
<ul class="simple">
|
||
<li>Ease of use: Catalyst tries to get out of your way so that you can
|
||
focus on algorithm development. See
|
||
<a class="reference external" href="https://github.com/enigmampc/catalyst/tree/master/catalyst/examples">examples of trading strategies</a>
|
||
provided.</li>
|
||
<li>Support for several of the top crypto-exchanges by trading volume:
|
||
<a class="reference external" href="https://www.bitfinex.com">Bitfinex</a>, <a class="reference external" href="http://www.bittrex.com">Bittrex</a>,
|
||
and <a class="reference external" href="https://www.poloniex.com">Poloniex</a>.</li>
|
||
<li>Secure: You and only you have access to each exchange API keys for your accounts.</li>
|
||
<li>Input of historical pricing data of all crypto-assets by exchange,
|
||
with daily and minute resolution. See
|
||
<a class="reference external" href="https://www.enigma.co/catalyst/status">Catalyst Market Coverage Overview</a>.</li>
|
||
<li>Backtesting and live-trading functionality, with a seamless transition
|
||
between the two modes.</li>
|
||
<li>Output of performance statistics are based on Pandas DataFrames to
|
||
integrate nicely into the existing PyData eco-system.</li>
|
||
<li>Statistic and machine learning libraries like matplotlib, scipy,
|
||
statsmodels, and sklearn support development, analysis, and
|
||
visualization of state-of-the-art trading systems.</li>
|
||
<li>Addition of Bitcoin price (btc_usdt) as a benchmark for comparing
|
||
performance across trading algorithms.</li>
|
||
</ul>
|
||
<p>Go to our <a class="reference external" href="https://enigmampc.github.io/catalyst/">Documentation Website</a>.</p>
|
||
<div class="line-block">
|
||
<div class="line"><br /></div>
|
||
<div class="line"><br /></div>
|
||
</div>
|
||
<div class="section" id="table-of-contents">
|
||
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<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"><a class="reference internal" href="releases.html">Release Notes</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<div class="articleComments">
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="install.html" class="btn btn-neutral float-right" title="Install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© 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>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'./',
|
||
VERSION:'0.4',
|
||
COLLAPSE_INDEX:false,
|
||
FILE_SUFFIX:'.html',
|
||
HAS_SOURCE: true,
|
||
SOURCELINK_SUFFIX: '.txt'
|
||
};
|
||
</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> |