mirror of
https://github.com/wassname/catalyst.git
synced 2026-06-29 21:24:16 +08:00
Victor Grau Serrat
505 lines
31 KiB
HTML
505 lines
31 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>Install — 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="next" title="Zipline Beginner Tutorial" href="beginner-tutorial.html"/>
|
|
<link rel="prev" title="<no title>" href="index.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 current"><a class="current reference internal" href="">Install</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#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="#gnu-linux">GNU/Linux</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#osx">OSX</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#windows">Windows</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#installing-with-conda">Installing with <code class="docutils literal"><span class="pre">conda</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="beginner-tutorial.html">Zipline 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#ipython-notebook">IPython Notebook</a></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="bundles.html">Data Bundles</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="bundles.html#discovering-available-bundles">Discovering Available Bundles</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="bundles.html#ingesting-data">Ingesting Data</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="bundles.html#old-data">Old Data</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="bundles.html#running-backtests-with-data-bundles">Running Backtests with Data Bundles</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="bundles.html#default-data-bundles">Default Data Bundles</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#quandl-wiki-bundle">Quandl WIKI Bundle</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="bundles.html#quantopian-quandl-wiki-mirror">Quantopian Quandl WIKI Mirror</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#yahoo-bundle-factories">Yahoo Bundle Factories</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="bundles.html#writing-a-new-bundle">Writing a New Bundle</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#environ"><code class="docutils literal"><span class="pre">environ</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#asset-db-writer"><code class="docutils literal"><span class="pre">asset_db_writer</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#minute-bar-writer"><code class="docutils literal"><span class="pre">minute_bar_writer</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#daily-bar-writer"><code class="docutils literal"><span class="pre">daily_bar_writer</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#adjustment-writer"><code class="docutils literal"><span class="pre">adjustment_writer</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#calendar"><code class="docutils literal"><span class="pre">calendar</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#start-session"><code class="docutils literal"><span class="pre">start_session</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#end-session"><code class="docutils literal"><span class="pre">end_session</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#cache"><code class="docutils literal"><span class="pre">cache</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#show-progress"><code class="docutils literal"><span class="pre">show_progress</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="bundles.html#output-dir"><code class="docutils literal"><span class="pre">output_dir</span></code></a></li>
|
|
</ul>
|
|
</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#style-guide-running-tests">Style Guide & Running Tests</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#continuous-integration">Continuous Integration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="development-guidelines.html#packaging">Packaging</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"><a class="reference internal" href="appendix.html">API Reference</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="appendix.html#running-a-backtest">Running a Backtest</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="appendix.html#algorithm-api">Algorithm API</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#data-object">Data Object</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#scheduling-functions">Scheduling Functions</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#orders">Orders</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="appendix.html#order-cancellation-policies">Order Cancellation Policies</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#assets">Assets</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#trading-controls">Trading Controls</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#simulation-parameters">Simulation Parameters</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="appendix.html#commission-models">Commission Models</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="appendix.html#slippage-models">Slippage Models</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#pipeline">Pipeline</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#miscellaneous">Miscellaneous</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="appendix.html#pipeline-api">Pipeline API</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#built-in-factors">Built-in Factors</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#pipeline-engine">Pipeline Engine</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#data-loaders">Data Loaders</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="appendix.html#asset-metadata">Asset Metadata</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="appendix.html#trading-calendar-api">Trading Calendar API</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="appendix.html#data-api">Data API</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#writers">Writers</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#readers">Readers</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#bundles">Bundles</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="appendix.html#utilities">Utilities</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#caching">Caching</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="appendix.html#command-line">Command Line</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release Process</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="release-process.html#updating-the-release-notes">Updating the Release Notes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="release-process.html#updating-the-python-stub-files">Updating the Python stub files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="release-process.html#updating-the-version">Updating the <code class="docutils literal"><span class="pre">__version__</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="release-process.html#uploading-pypi-packages">Uploading PyPI packages</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="release-process.html#sdist"><code class="docutils literal"><span class="pre">sdist</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="release-process.html#bdist"><code class="docutils literal"><span class="pre">bdist</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="release-process.html#documentation">Documentation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="release-process.html#uploading-conda-packages">Uploading conda packages</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="release-process.html#next-commit">Next Commit</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="releases.html">Release Notes</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#development">Development</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#highlights">Highlights</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#enhancements">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#experimental-features">Experimental Features</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#bug-fixes">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#performance">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#maintenance-and-refactorings">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#build">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#documentation">Documentation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#miscellaneous">Miscellaneous</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-1-1-0">Release 1.1.0</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id1">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id2">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id3">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id4">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id5">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id6">Documentation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id7">Miscellaneous</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-1-0-2">Release 1.0.2</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id8">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#experimental">Experimental</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id9">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id10">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id11">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id12">Documentation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#testing">Testing</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#data-format-changes">Data Format Changes</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-1-0-1">Release 1.0.1</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id13">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id14">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id15">Documentation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-1-0-0">Release 1.0.0</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id16">Highlights</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="releases.html#zipline-1-0-rewrite-1105">Zipline 1.0 Rewrite (#1105)</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="releases.html#new-entry-points-1173-and-1178">New Entry Points (#1173 and #1178)</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="releases.html#data-bundles-1173-and-1178">Data Bundles (#1173 and #1178)</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="releases.html#string-support-in-pipeline-1174">String Support in Pipeline (#1174)</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id17">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id18">Experimental Features</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id19">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id20">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id21">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id22">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id23">Documentation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id24">Miscellaneous</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-0-9-0">Release 0.9.0</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id25">Highlights</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id26">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id27">Experimental Features</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id28">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id29">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id30">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id31">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id32">Documentation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id33">Miscellaneous</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-0-8-4">Release 0.8.4</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id34">Highlights</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id35">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id36">Experimental Features</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id37">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id38">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id39">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id40">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id41">Documentation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id42">Miscellaneous</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-0-8-3">Release 0.8.3</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-0-8-0">Release 0.8.0</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id43">Highlights</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id44">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id45">Experimental Features</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id46">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id47">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id48">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id49">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id50">Documentation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-0-7-0">Release 0.7.0</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id51">Highlights</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id52">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id53">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id54">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id55">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id56">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#contributors">Contributors</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="releases.html#release-0-6-1">Release 0.6.1</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id57">Highlights</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id58">Enhancements</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id59">Bug Fixes</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id60">Performance</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id61">Maintenance and Refactorings</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id62">Build</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="releases.html#id63">Contributors</a></li>
|
|
</ul>
|
|
</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>Install</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/install.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document">
|
|
|
|
<div class="section" id="install">
|
|
<h1>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="installing-with-pip">
|
|
<h2>Installing with <code class="docutils literal"><span class="pre">pip</span></code><a class="headerlink" href="#installing-with-pip" title="Permalink to this headline">¶</a></h2>
|
|
<p>Installing Catalyst via <code class="docutils literal"><span class="pre">pip</span></code> is slightly more involved than the average
|
|
Python package.</p>
|
|
<p>There are two reasons for the additional complexity:</p>
|
|
<ol class="arabic simple">
|
|
<li>Catalyst ships several C extensions that require access to the CPython C API.
|
|
In order to build the C extensions, <code class="docutils literal"><span class="pre">pip</span></code> needs access to the CPython
|
|
header files for your Python installation.</li>
|
|
<li>Zipline depends on <a class="reference external" href="http://www.numpy.org/">numpy</a>, the core library for
|
|
numerical array computing in Python. Numpy depends on having the <a class="reference external" href="http://www.netlib.org/lapack">LAPACK</a> linear algebra routines available.</li>
|
|
</ol>
|
|
<p>Because LAPACK and the CPython headers are non-Python dependencies, the correct
|
|
way to install them varies from platform to platform. If you’d rather use a
|
|
single tool to install Python and non-Python dependencies, or if you’re already
|
|
using <a class="reference external" href="http://continuum.io/downloads">Anaconda</a> as your Python distribution,
|
|
you can skip to the <a class="reference internal" href="#conda"><span>Installing with Conda</span></a> section.</p>
|
|
<p>Once you’ve installed the necessary additional dependencies (see below for
|
|
your particular platform), you should be able to simply run</p>
|
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install enigma-catalyst
|
|
</pre></div>
|
|
</div>
|
|
<p>If you use Python for anything other than Catalyst, we <strong>strongly</strong> recommend
|
|
that you install in a <a class="reference external" href="https://virtualenv.readthedocs.org/en/latest">virtualenv</a>. The <a class="reference external" href="http://docs.python-guide.org/en/latest/">Hitchhiker’s Guide to
|
|
Python</a> provides an <a class="reference external" href="http://docs.python-guide.org/en/latest/dev/virtualenvs/">excellent tutorial on virtualenv</a>. Here’s a summarized
|
|
version:</p>
|
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>virtualenv catalyst-venv
|
|
<span class="nv">$ </span><span class="nb">source</span> ./catalyst-venv/bin/activate
|
|
<span class="nv">$ </span>pip install enigma-catalyst
|
|
</pre></div>
|
|
</div>
|
|
<div class="section" id="gnu-linux">
|
|
<h3>GNU/Linux<a class="headerlink" href="#gnu-linux" title="Permalink to this headline">¶</a></h3>
|
|
<p>On <a class="reference external" href="https://www.debian.org/misc/children-distros">Debian-derived</a> Linux distributions, you can acquire all the necessary
|
|
binary dependencies from <code class="docutils literal"><span class="pre">apt</span></code> by running:</p>
|
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo apt-get install libatlas-base-dev python-dev gfortran pkg-config libfreetype6-dev
|
|
</pre></div>
|
|
</div>
|
|
<p>On recent <a class="reference external" href="https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux_derivatives">RHEL-derived</a> derived Linux distributions (e.g. Fedora), the
|
|
following should be sufficient to acquire the necessary additional
|
|
dependencies:</p>
|
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo dnf install atlas-devel gcc-c++ gcc-gfortran libgfortran python-devel redhat-rep-config
|
|
</pre></div>
|
|
</div>
|
|
<p>On <a class="reference external" href="https://www.archlinux.org/">Arch Linux</a>, you can acquire the additional dependencies via <code class="docutils literal"><span class="pre">pacman</span></code>:</p>
|
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pacman -S lapack gcc gcc-fortran pkg-config
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="osx">
|
|
<h3>OSX<a class="headerlink" href="#osx" title="Permalink to this headline">¶</a></h3>
|
|
<p>The version of Python shipped with OSX by default is generally out of date, and
|
|
has a number of quirks because it’s used directly by the operating system. For
|
|
these reasons, many developers choose to install and use a separate Python
|
|
installation. The <a class="reference external" href="http://docs.python-guide.org/en/latest/">Hitchhiker’s Guide to Python</a> provides an excellent guide
|
|
to <a class="reference external" href="http://docs.python-guide.org/en/latest/">Installing Python on OSX</a>, which
|
|
explains how to install Python with the <a class="reference external" href="http://brew.sh">Homebrew</a> manager.</p>
|
|
<p>Assuming you’ve installed Python with Homebrew, you’ll also likely need the
|
|
following brew packages:</p>
|
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>brew install freetype pkg-config gcc openssl
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="windows">
|
|
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
|
|
<p>For windows, the easiest and best supported way to install zipline is to use
|
|
<a class="reference internal" href="#conda"><span>Conda</span></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="installing-with-conda">
|
|
<span id="conda"></span><h2>Installing with <code class="docutils literal"><span class="pre">conda</span></code><a class="headerlink" href="#installing-with-conda" title="Permalink to this headline">¶</a></h2>
|
|
<p>Another way to install Catalyst is via the <code class="docutils literal"><span class="pre">conda</span></code> package manager, which
|
|
comes as part of Continuum Analytics’ <a class="reference external" href="http://continuum.io/downloads">Anaconda</a> distribution.</p>
|
|
<p>The primary advantage of using Conda over <code class="docutils literal"><span class="pre">pip</span></code> is that conda natively
|
|
understands the complex binary dependencies of packages like <code class="docutils literal"><span class="pre">numpy</span></code> and
|
|
<code class="docutils literal"><span class="pre">scipy</span></code>. This means that <code class="docutils literal"><span class="pre">conda</span></code> can install Catalyst and its dependencies
|
|
without requiring the use of a second tool to acquire Catalyst’s non-Python
|
|
dependencies.</p>
|
|
<p>For instructions on how to install <code class="docutils literal"><span class="pre">conda</span></code>, see the <a class="reference external" href="http://conda.pydata.org/docs/download.html">Conda Installation
|
|
Documentation</a></p>
|
|
<p>Once conda has been set up you can install Catalyst from our <code class="docutils literal"><span class="pre">Quantopian</span></code>
|
|
channel:</p>
|
|
<div class="highlight-bash"><div class="highlight"><pre>conda install -c Quantopian zipline
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="beginner-tutorial.html" class="btn btn-neutral float-right" title="Zipline Beginner Tutorial" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="index.html" class="btn btn-neutral" title="<no title>" 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> |