mirror of
https://github.com/wassname/catalyst.git
synced 2026-07-18 12:20:12 +08:00
DOC: link README to DOC landing page, added badges
This commit is contained in:
+1
-1
@@ -1,4 +1,4 @@
|
||||
.. include:: welcome.rst
|
||||
.. include:: ../../README.rst
|
||||
|
|
||||
|
|
||||
Table of Contents
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
.. image:: https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.jpg
|
||||
|
|
||||
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 `enigma.co <https://www.enigma.co>`_ to learn more about Catalyst, or
|
||||
refer to the `whitepaper <https://www.enigma.co/enigma_catalyst.pdf>`_ for
|
||||
further technical details.
|
||||
|
||||
Catalyst builds on top of the well-established
|
||||
`Zipline <https://github.com/quantopian/zipline>`_ 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
|
||||
`Discord <https://discord.gg/SJK32GY>`_ where we have a *#catalyst_dev* channel
|
||||
for questions around Catalyst, algorithmic trading and technical support.
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
- Ease of use: Catalyst tries to get out of your way so that you can
|
||||
focus on algorithm development. See
|
||||
`examples of trading strategies <https://github.com/enigmampc/catalyst/tree/master/catalyst/examples>`_
|
||||
provided.
|
||||
- Support for several of the top crypto-exchanges by trading volume:
|
||||
`Bitfinex <https://www.bitfinex.com>`_, `Bittrex <http://www.bittrex.com>`_,
|
||||
and `Poloniex <https://www.poloniex.com>`_.
|
||||
- Secure: You and only you have access to each exchange API keys for your accounts.
|
||||
- Input of historical pricing data of all crypto-assets by exchange,
|
||||
with daily and minute resolution. See
|
||||
`Catalyst Market Coverage Overview <https://www.enigma.co/catalyst/status>`_.
|
||||
- Backtesting and live-trading functionality, with a seamless transition
|
||||
between the two modes.
|
||||
- Output of performance statistics are based on Pandas DataFrames to
|
||||
integrate nicely into the existing PyData eco-system.
|
||||
- Statistic and machine learning libraries like matplotlib, scipy,
|
||||
statsmodels, and sklearn support development, analysis, and
|
||||
visualization of state-of-the-art trading systems.
|
||||
- Addition of Bitcoin price (btc_usdt) as a benchmark for comparing
|
||||
performance across trading algorithms.
|
||||
+10
-5
@@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Features — Catalyst 0.3 documentation</title>
|
||||
<title>Overview — Catalyst 0.3 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -237,7 +237,7 @@
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="#">Docs</a> »</li>
|
||||
|
||||
<li>Features</li>
|
||||
<li>Overview</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
@@ -250,7 +250,11 @@
|
||||
</div>
|
||||
<div role="main" class="document">
|
||||
|
||||
<img alt="https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.jpg" src="https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.jpg" />
|
||||
<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.jpg" /></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://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>
|
||||
@@ -270,8 +274,8 @@ minimize structural changes to the general API to maximize compatibility with
|
||||
existing trading algorithms, developer knowledge, and tutorials. Join us on
|
||||
<a class="reference external" href="https://discord.gg/SJK32GY">Discord</a> where we have a <em>#catalyst_dev</em> channel
|
||||
for questions around Catalyst, algorithmic trading and technical support.</p>
|
||||
<div class="section" id="features">
|
||||
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h1>
|
||||
<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
|
||||
@@ -294,6 +298,7 @@ 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>
|
||||
|
||||
+2
-2
@@ -32,7 +32,7 @@
|
||||
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
<link rel="next" title="Catalyst Beginner Tutorial" href="beginner-tutorial.html"/>
|
||||
<link rel="prev" title="Features" href="index.html"/>
|
||||
<link rel="prev" title="Table of Contents" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -640,7 +640,7 @@ and you get a hint on how to solve it.</li>
|
||||
<a href="beginner-tutorial.html" class="btn btn-neutral float-right" title="Catalyst Beginner Tutorial" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="index.html" class="btn btn-neutral" title="Features" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="index.html" class="btn btn-neutral" title="Table of Contents" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user