mirror of
https://github.com/wassname/catalyst.git
synced 2026-07-24 13:00:57 +08:00
DOC: Catalyst Install
This commit is contained in:
+6
-6
@@ -4,9 +4,9 @@
|
||||
:maxdepth: 1
|
||||
|
||||
install
|
||||
beginner-tutorial
|
||||
bundles
|
||||
development-guidelines
|
||||
appendix
|
||||
release-process
|
||||
releases
|
||||
.. beginner-tutorial
|
||||
.. bundles
|
||||
.. development-guidelines
|
||||
.. appendix
|
||||
.. release-process
|
||||
.. releases
|
||||
|
||||
+220
-10
@@ -13,7 +13,7 @@ There are two reasons for the additional complexity:
|
||||
In order to build the C extensions, ``pip`` needs access to the CPython
|
||||
header files for your Python installation.
|
||||
|
||||
2. Zipline depends on `numpy <http://www.numpy.org/>`_, the core library for
|
||||
2. Catalyst depends on `numpy <http://www.numpy.org/>`_, the core library for
|
||||
numerical array computing in Python. Numpy depends on having the `LAPACK
|
||||
<http://www.netlib.org/lapack>`_ linear algebra routines available.
|
||||
|
||||
@@ -41,7 +41,15 @@ version:
|
||||
|
||||
$ virtualenv catalyst-venv
|
||||
$ source ./catalyst-venv/bin/activate
|
||||
$ pip install enigma-catalyst
|
||||
$ pip install enigma-
|
||||
|
||||
Though not required by Catalyst directly, our example algorithms use matplotlib
|
||||
to visually display the results of the trading algorithms. If you wish to run
|
||||
any examples or use matplotlib during development, it can be installed using:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install matplotlib
|
||||
|
||||
GNU/Linux
|
||||
~~~~~~~~~
|
||||
@@ -71,8 +79,8 @@ On `Arch Linux`_, you can acquire the additional dependencies via ``pacman``:
|
||||
..
|
||||
.. There are also AUR packages available for installing `Python 3.4
|
||||
.. <https://aur.archlinux.org/packages/python34/>`_ (Arch's default python is now
|
||||
.. 3.5, but Zipline only currently supports 3.4), and `ta-lib
|
||||
.. <https://aur.archlinux.org/packages/ta-lib/>`_, an optional Zipline dependency.
|
||||
.. 3.5, but Catalyst only currently supports 3.4), and `ta-lib
|
||||
.. <https://aur.archlinux.org/packages/ta-lib/>`_, an optional Catalyst dependency.
|
||||
.. Python 2 is also installable via:
|
||||
|
||||
..
|
||||
@@ -96,12 +104,132 @@ following brew packages:
|
||||
|
||||
$ brew install freetype pkg-config gcc openssl
|
||||
|
||||
OSX + virtualenv + matplotlib
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
A note about using matplotlib in virtual enviroments on OSX: it may be necessary to run
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
echo "backend: TkAgg" > ~/.matplotlib/matplotlibrc
|
||||
|
||||
in order to override the default ``macosx`` backend for your system, which may not
|
||||
be accessible from inside the virtual environment. This will allow Catalyst to open
|
||||
matplotlib charts from within a virtual environment, which is useful for displaying
|
||||
the performance of your backtests. To learn more about matplotlib backends, please refer to the
|
||||
`matplotlib backend documentation <https://matplotlib.org/faq/usage_faq.html#what-is-a-backend>`_.
|
||||
|
||||
|
||||
Windows
|
||||
~~~~~~~
|
||||
|
||||
For windows, the easiest and best supported way to install zipline is to use
|
||||
In Windows, you will need the `Microsoft Visual C++ Compiler for Python 2.7
|
||||
<https://www.microsoft.com/en-us/download/details.aspx?id=44266>`_. This package
|
||||
contains the compiler and the set of system headers necessary for producing
|
||||
binary wheels for Python 2.7 packages. If it's not already in your system, download
|
||||
it and install it before proceeding to the next step.
|
||||
|
||||
For windows, the easiest and best supported way to install Catalyst is to use
|
||||
:ref:`Conda <conda>`.
|
||||
|
||||
Amazon Linux AMI
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
The packages ``pip`` and ``setuptools`` that come shipped by default are very outdated.
|
||||
Thus, you first need to run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install --upgrade pip setuptools
|
||||
|
||||
The default installation is also missing the C and C++ compilers, which you install by:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo yum install gcc gcc-c++
|
||||
|
||||
Then you should follow the regular installation instructions outlined at the beginning
|
||||
of this page.
|
||||
|
||||
|
||||
Troubleshooting ``pip`` Install
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
**Issue**:
|
||||
Package enigma-catalyst cannot be found
|
||||
|
||||
**Solution**:
|
||||
Make sure you have the most up-to-date version of pip installed, by running:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install --upgrade pip
|
||||
|
||||
On Windows, the recommended command is:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
python -m pip install --upgrade pip
|
||||
|
||||
----
|
||||
|
||||
**Issue**:
|
||||
Package enigma-catalyst cannot still be found, even after upgrading pip (see above), with an error similar to:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
Downloading/unpacking enigma-catalyst
|
||||
Could not find a version that satisfies the requirement enigma-catalyst (from versions: 0.1.dev9, 0.2.dev2, 0.1.dev4, 0.1.dev5, 0.1.dev3, 0.2.dev1, 0.1.dev8, 0.1.dev6)
|
||||
Cleaning up...
|
||||
No distributions matching the version for enigma-catalyst
|
||||
|
||||
**Solution**:
|
||||
In some systems (this error has been reported in Ubuntu), pip is configured to only find stable versions by default. Since Catalyst is in alpha version, pip cannot find a matching version that satisfies the installation requirements. The solution is to include the `--pre` flag to include pre-release and development versions:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install --pre enigma-catalyst
|
||||
|
||||
----
|
||||
|
||||
**Issue**:
|
||||
Package enigma-catalyst fails to install because of outdated setuptools
|
||||
|
||||
**Solution**:
|
||||
Upgrade to the most up-to-date setuptools package by running:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install --upgrade pip setuptools
|
||||
|
||||
----
|
||||
|
||||
**Issue**:
|
||||
Missing required packages
|
||||
|
||||
**Solution**:
|
||||
Download `requirements.txt
|
||||
<https://github.com/enigmampc/catalyst/blob/master/etc/requirements.txt>`_
|
||||
(click on the *Raw* button and Right click -> Save As...) and use it to
|
||||
install all the required dependencies by running:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install -r requirements.txt
|
||||
|
||||
----
|
||||
|
||||
**Issue**:
|
||||
Installation fails with error: ``fatal error: Python.h: No such file or directory``
|
||||
|
||||
**Solution**:
|
||||
Some systems (this issue has been reported in Ubuntu) require `python-dev` for the proper build and installation of package dependencies. The solution is to install python-dev, which is independent of the virtual environment. In Ubuntu, you would need to run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt-get install python-dev
|
||||
|
||||
|
||||
.. _conda:
|
||||
|
||||
Installing with ``conda``
|
||||
@@ -118,14 +246,96 @@ without requiring the use of a second tool to acquire Catalyst's non-Python
|
||||
dependencies.
|
||||
|
||||
For instructions on how to install ``conda``, see the `Conda Installation
|
||||
Documentation <http://conda.pydata.org/docs/download.html>`_
|
||||
Documentation <http://conda.pydata.org/docs/download.html>`_. Alternatively, you
|
||||
can install MiniConda, which is a smaller footprint (fewer packages and smaller
|
||||
size) than its big brother Anaconda, but it still contains all the main packages
|
||||
needed. To install MiniConda, you can follow these steps:
|
||||
|
||||
Once conda has been set up you can install Catalyst from our ``Quantopian``
|
||||
channel:
|
||||
1. Download `MiniConda <https://conda.io/miniconda.html>`_. Select Python 2.7 for
|
||||
your Operating System.
|
||||
2. Install MiniConda. See the `Installation Instructions <https://conda.io/docs/user-guide/install/index.html>`_
|
||||
if you need help.
|
||||
3. Ensure the correct installation by running ``conda list`` in a Terminal window,
|
||||
which should print the list of packages installed with Conda.
|
||||
|
||||
.. code-block:: bash
|
||||
Once either Conda or MiniConda has been set up you can install Catalyst:
|
||||
|
||||
1. Download the file `python2.7-environment.yml <https://github.com/enigmampc/catalyst/blob/master/etc/python2.7-environment.yml>`_.
|
||||
2. Open a Terminal window and enter [``cd/dir``] into the directory where you saved
|
||||
the above ``python2.7-environment.yml`` file.
|
||||
3. Install using this file. This step can take about 5-10 minutes to install.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
conda env create -f python2.7-environment.yml
|
||||
|
||||
4. Activate the environment (which you need to do every time you start a new session
|
||||
to run Catalyst):
|
||||
|
||||
**Linux or OSX:**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
source activate catalyst
|
||||
|
||||
**Windows:**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
activate catalyst
|
||||
|
||||
Congratulations! You now have Catalyst installed.
|
||||
|
||||
Troubleshooting ``conda`` Install
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If the command ``conda env create -f python2.7-environment.yml`` in step 3 above failed
|
||||
for any reason, you can try setting up the environment manually with the following steps:
|
||||
|
||||
1. Create the environment:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
conda create --name catalyst python=2.7 scipy
|
||||
|
||||
2. Activate the environment:
|
||||
|
||||
**Linux or OSX:**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
source activate catalyst
|
||||
|
||||
**Windows:**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
activate catalyst
|
||||
|
||||
3. Install the Catalyst inside the environment:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install enigma-catalyst matplotlib
|
||||
|
||||
Getting Help
|
||||
------------
|
||||
|
||||
If after following the instructions above, and going through the *Troubleshooting* sections,
|
||||
you still experience problems installing Catalyst, you can seek additional help through the
|
||||
following channels:
|
||||
|
||||
- Join our `Discord community <https://discord.gg/SJK32GY>`_, and head over the #catalyst_dev
|
||||
channel where many other users (as well as the project developers) hang out, and can assist
|
||||
you with your particular issue. The more descriptive and the more information you can provide,
|
||||
the easiest will be for others to help you out.
|
||||
|
||||
- Report the problem you are experiencing on our
|
||||
`GitHub repository <https://github.com/enigmampc/catalyst/issues>`_ following the guidelines
|
||||
provided therein. Before you do so, take a moment to browse through all `previous reported issues
|
||||
<https://github.com/enigmampc/catalyst/issues?utf8=%E2%9C%93&q=is%3Aissue>`_ in the likely case
|
||||
that someone else experienced that same issue before, and you get a hint on how to solve it.
|
||||
|
||||
conda install -c Quantopian zipline
|
||||
|
||||
.. _`Debian-derived`: https://www.debian.org/misc/children-distros
|
||||
.. _`RHEL-derived`: https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux_derivatives
|
||||
|
||||
+11
-240
@@ -30,9 +30,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
<link rel="next" title="Release Process" href="release-process.html"/>
|
||||
<link rel="prev" title="Development Guidelines" href="development-guidelines.html"/>
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -71,242 +69,24 @@
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<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-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></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></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 current"><a class="current reference internal" href="">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#running-a-backtest">Running a Backtest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#algorithm-api">Algorithm API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#data-object">Data Object</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#scheduling-functions">Scheduling Functions</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#orders">Orders</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#order-cancellation-policies">Order Cancellation Policies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#assets">Assets</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#trading-controls">Trading Controls</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#simulation-parameters">Simulation Parameters</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#commission-models">Commission Models</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#slippage-models">Slippage Models</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#pipeline">Pipeline</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#miscellaneous">Miscellaneous</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#pipeline-api">Pipeline API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#built-in-factors">Built-in Factors</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#pipeline-engine">Pipeline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#data-loaders">Data Loaders</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#asset-metadata">Asset Metadata</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#trading-calendar-api">Trading Calendar API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#data-api">Data API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#writers">Writers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#readers">Readers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#bundles">Bundles</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#utilities">Utilities</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#caching">Caching</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#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>
|
||||
<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>
|
||||
</ul>
|
||||
@@ -449,15 +229,6 @@ data. This mapping is immutable and should only be updated through
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="release-process.html" class="btn btn-neutral float-right" title="Release Process" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></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>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
+11
-240
@@ -30,9 +30,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
<link rel="next" title="Data Bundles" href="bundles.html"/>
|
||||
<link rel="prev" title="Install" href="install.html"/>
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -71,242 +69,24 @@
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<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-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></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></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Zipline Beginner Tutorial</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#basics">Basics</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#my-first-algorithm">My first algorithm</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#running-the-algorithm">Running the algorithm</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ingesting-data">Ingesting Data</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#command-line-interface">Command line interface</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#ipython-notebook">IPython Notebook</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#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="#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="#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>
|
||||
<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>
|
||||
</ul>
|
||||
@@ -1020,15 +800,6 @@ and <a class="reference external" href="https://quantopian.com">checkout Quantop
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="bundles.html" class="btn btn-neutral float-right" title="Data Bundles" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="install.html" class="btn btn-neutral" title="Install" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
+11
-240
@@ -30,9 +30,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
<link rel="next" title="Development Guidelines" href="development-guidelines.html"/>
|
||||
<link rel="prev" title="Zipline Beginner Tutorial" href="beginner-tutorial.html"/>
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -71,242 +69,24 @@
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<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-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></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></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 current"><a class="current reference internal" href="">Data Bundles</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#discovering-available-bundles">Discovering Available Bundles</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#ingesting-data">Ingesting Data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#old-data">Old Data</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#running-backtests-with-data-bundles">Running Backtests with Data Bundles</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#default-data-bundles">Default Data Bundles</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#quandl-wiki-bundle">Quandl WIKI Bundle</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#quantopian-quandl-wiki-mirror">Quantopian Quandl WIKI Mirror</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#yahoo-bundle-factories">Yahoo Bundle Factories</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#writing-a-new-bundle">Writing a New Bundle</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#environ"><code class="docutils literal"><span class="pre">environ</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#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="#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="#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="#adjustment-writer"><code class="docutils literal"><span class="pre">adjustment_writer</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#calendar"><code class="docutils literal"><span class="pre">calendar</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#start-session"><code class="docutils literal"><span class="pre">start_session</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#end-session"><code class="docutils literal"><span class="pre">end_session</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#cache"><code class="docutils literal"><span class="pre">cache</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#show-progress"><code class="docutils literal"><span class="pre">show_progress</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#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>
|
||||
<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>
|
||||
</ul>
|
||||
@@ -650,15 +430,6 @@ bundle uses this to directly untar the bundle into the <code class="docutils lit
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="development-guidelines.html" class="btn btn-neutral float-right" title="Development Guidelines" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="beginner-tutorial.html" class="btn btn-neutral" title="Zipline Beginner Tutorial" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
+11
-240
@@ -30,9 +30,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
<link rel="next" title="API Reference" href="appendix.html"/>
|
||||
<link rel="prev" title="Data Bundles" href="bundles.html"/>
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -71,242 +69,24 @@
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<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-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></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></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 current"><a class="current reference internal" href="">Development Guidelines</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#creating-a-development-environment">Creating a Development Environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#development-with-docker">Development with Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#style-guide-running-tests">Style Guide & Running Tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#continuous-integration">Continuous Integration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#packaging">Packaging</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#contributing-to-the-docs">Contributing to the Docs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#commit-messages">Commit messages</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#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>
|
||||
<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>
|
||||
</ul>
|
||||
@@ -485,15 +265,6 @@ the algorithm has little cash on hand.
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="appendix.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="bundles.html" class="btn btn-neutral" title="Data Bundles" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
+9
-227
@@ -74,238 +74,20 @@
|
||||
<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></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></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>
|
||||
<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>
|
||||
</ul>
|
||||
|
||||
+9
-233
@@ -74,238 +74,20 @@
|
||||
<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></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></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>
|
||||
<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>
|
||||
</ul>
|
||||
@@ -349,12 +131,6 @@
|
||||
<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">Zipline Beginner Tutorial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bundles.html">Data Bundles</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="appendix.html">API Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release Process</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Release Notes</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
+196
-237
@@ -31,7 +31,6 @@
|
||||
|
||||
|
||||
<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"/>
|
||||
|
||||
|
||||
@@ -75,238 +74,20 @@
|
||||
<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="#osx">OSX</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#osx-virtualenv-matplotlib">OSX + virtualenv + matplotlib</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#windows">Windows</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#amazon-linux-ami">Amazon Linux AMI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#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="#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>
|
||||
<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><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#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="#getting-help">Getting Help</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -357,7 +138,7 @@ Python package.</p>
|
||||
<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
|
||||
<li>Catalyst 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
|
||||
@@ -376,7 +157,13 @@ Python</a> provides an <a class="reference external" href="http://docs.python-gu
|
||||
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
|
||||
<span class="nv">$ </span>pip install enigma-
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Though not required by Catalyst directly, our example algorithms use matplotlib
|
||||
to visually display the results of the trading algorithms. If you wish to run
|
||||
any examples or use matplotlib during development, it can be installed using:</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install matplotlib
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="gnu-linux">
|
||||
@@ -410,12 +197,112 @@ 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 class="section" id="osx-virtualenv-matplotlib">
|
||||
<h4>OSX + virtualenv + matplotlib<a class="headerlink" href="#osx-virtualenv-matplotlib" title="Permalink to this headline">¶</a></h4>
|
||||
<p>A note about using matplotlib in virtual enviroments on OSX: it may be necessary to run</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">echo</span> <span class="s2">"backend: TkAgg"</span> > ~/.matplotlib/matplotlibrc
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>in order to override the default <code class="docutils literal"><span class="pre">macosx</span></code> backend for your system, which may not
|
||||
be accessible from inside the virtual environment. This will allow Catalyst to open
|
||||
matplotlib charts from within a virtual environment, which is useful for displaying
|
||||
the performance of your backtests. To learn more about matplotlib backends, please refer to the
|
||||
<a class="reference external" href="https://matplotlib.org/faq/usage_faq.html#what-is-a-backend">matplotlib backend documentation</a>.</p>
|
||||
</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
|
||||
<p>In Windows, you will need the <a class="reference external" href="https://www.microsoft.com/en-us/download/details.aspx?id=44266">Microsoft Visual C++ Compiler for Python 2.7</a>. This package
|
||||
contains the compiler and the set of system headers necessary for producing
|
||||
binary wheels for Python 2.7 packages. If it’s not already in your system, download
|
||||
it and install it before proceeding to the next step.</p>
|
||||
<p>For windows, the easiest and best supported way to install Catalyst is to use
|
||||
<a class="reference internal" href="#conda"><span>Conda</span></a>.</p>
|
||||
</div>
|
||||
<div class="section" id="amazon-linux-ami">
|
||||
<h3>Amazon Linux AMI<a class="headerlink" href="#amazon-linux-ami" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The packages <code class="docutils literal"><span class="pre">pip</span></code> and <code class="docutils literal"><span class="pre">setuptools</span></code> that come shipped by default are very outdated.
|
||||
Thus, you first need to run:</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>pip install --upgrade pip setuptools
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The default installation is also missing the C and C++ compilers, which you install by:</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>sudo yum install gcc gcc-c++
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Then you should follow the regular installation instructions outlined at the beginning
|
||||
of this page.</p>
|
||||
</div>
|
||||
<div class="section" id="troubleshooting-pip-install">
|
||||
<h3>Troubleshooting <code class="docutils literal"><span class="pre">pip</span></code> Install<a class="headerlink" href="#troubleshooting-pip-install" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="docutils">
|
||||
<dt><strong>Issue</strong>:</dt>
|
||||
<dd>Package enigma-catalyst cannot be found</dd>
|
||||
<dt><strong>Solution</strong>:</dt>
|
||||
<dd><p class="first">Make sure you have the most up-to-date version of pip installed, by running:</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>pip install --upgrade pip
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>On Windows, the recommended command is:</p>
|
||||
<div class="last highlight-bash"><div class="highlight"><pre>python -m pip install --upgrade pip
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<hr class="docutils" />
|
||||
<dl class="docutils">
|
||||
<dt><strong>Issue</strong>:</dt>
|
||||
<dd><p class="first">Package enigma-catalyst cannot still be found, even after upgrading pip (see above), with an error similar to:</p>
|
||||
<div class="last highlight-bash"><div class="highlight"><pre>Downloading/unpacking enigma-catalyst
|
||||
Could not find a version that satisfies the requirement enigma-catalyst <span class="o">(</span>from versions: 0.1.dev9, 0.2.dev2, 0.1.dev4, 0.1.dev5, 0.1.dev3, 0.2.dev1, 0.1.dev8, 0.1.dev6<span class="o">)</span>
|
||||
Cleaning up...
|
||||
No distributions matching the version <span class="k">for</span> enigma-catalyst
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
<dt><strong>Solution</strong>:</dt>
|
||||
<dd><p class="first">In some systems (this error has been reported in Ubuntu), pip is configured to only find stable versions by default. Since Catalyst is in alpha version, pip cannot find a matching version that satisfies the installation requirements. The solution is to include the <cite>–pre</cite> flag to include pre-release and development versions:</p>
|
||||
<div class="last highlight-bash"><div class="highlight"><pre>pip install --pre enigma-catalyst
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<hr class="docutils" />
|
||||
<dl class="docutils">
|
||||
<dt><strong>Issue</strong>:</dt>
|
||||
<dd>Package enigma-catalyst fails to install because of outdated setuptools</dd>
|
||||
<dt><strong>Solution</strong>:</dt>
|
||||
<dd><p class="first">Upgrade to the most up-to-date setuptools package by running:</p>
|
||||
<div class="last highlight-bash"><div class="highlight"><pre>pip install --upgrade pip setuptools
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<hr class="docutils" />
|
||||
<dl class="docutils">
|
||||
<dt><strong>Issue</strong>:</dt>
|
||||
<dd>Missing required packages</dd>
|
||||
<dt><strong>Solution</strong>:</dt>
|
||||
<dd><p class="first">Download <a class="reference external" href="https://github.com/enigmampc/catalyst/blob/master/etc/requirements.txt">requirements.txt</a>
|
||||
(click on the <em>Raw</em> button and Right click -> Save As...) and use it to
|
||||
install all the required dependencies by running:</p>
|
||||
<div class="last highlight-bash"><div class="highlight"><pre>pip install -r requirements.txt
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<hr class="docutils" />
|
||||
<dl class="docutils">
|
||||
<dt><strong>Issue</strong>:</dt>
|
||||
<dd>Installation fails with error: <code class="docutils literal"><span class="pre">fatal</span> <span class="pre">error:</span> <span class="pre">Python.h:</span> <span class="pre">No</span> <span class="pre">such</span> <span class="pre">file</span> <span class="pre">or</span> <span class="pre">directory</span></code></dd>
|
||||
<dt><strong>Solution</strong>:</dt>
|
||||
<dd><p class="first">Some systems (this issue has been reported in Ubuntu) require <cite>python-dev</cite> for the proper build and installation of package dependencies. The solution is to install python-dev, which is independent of the virtual environment. In Ubuntu, you would need to run:</p>
|
||||
<div class="last highlight-bash"><div class="highlight"><pre>sudo apt-get install python-dev
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
</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>
|
||||
@@ -427,12 +314,86 @@ understands the complex binary dependencies of packages like <code class="docuti
|
||||
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
|
||||
Documentation</a>. Alternatively, you
|
||||
can install MiniConda, which is a smaller footprint (fewer packages and smaller
|
||||
size) than its big brother Anaconda, but it still contains all the main packages
|
||||
needed. To install MiniConda, you can follow these steps:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Download <a class="reference external" href="https://conda.io/miniconda.html">MiniConda</a>. Select Python 2.7 for
|
||||
your Operating System.</li>
|
||||
<li>Install MiniConda. See the <a class="reference external" href="https://conda.io/docs/user-guide/install/index.html">Installation Instructions</a>
|
||||
if you need help.</li>
|
||||
<li>Ensure the correct installation by running <code class="docutils literal"><span class="pre">conda</span> <span class="pre">list</span></code> in a Terminal window,
|
||||
which should print the list of packages installed with Conda.</li>
|
||||
</ol>
|
||||
<p>Once either Conda or MiniConda has been set up you can install Catalyst:</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Download the file <a class="reference external" href="https://github.com/enigmampc/catalyst/blob/master/etc/python2.7-environment.yml">python2.7-environment.yml</a>.</p>
|
||||
</li>
|
||||
<li><p class="first">Open a Terminal window and enter [<code class="docutils literal"><span class="pre">cd/dir</span></code>] into the directory where you saved
|
||||
the above <code class="docutils literal"><span class="pre">python2.7-environment.yml</span></code> file.</p>
|
||||
</li>
|
||||
<li><p class="first">Install using this file. This step can take about 5-10 minutes to install.</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>conda env create -f python2.7-environment.yml
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Activate the environment (which you need to do every time you start a new session
|
||||
to run Catalyst):</p>
|
||||
<p><strong>Linux or OSX:</strong></p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">source </span>activate catalyst
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Windows:</strong></p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>activate catalyst
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
<p>Congratulations! You now have Catalyst installed.</p>
|
||||
<div class="section" id="troubleshooting-conda-install">
|
||||
<h3>Troubleshooting <code class="docutils literal"><span class="pre">conda</span></code> Install<a class="headerlink" href="#troubleshooting-conda-install" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If the command <code class="docutils literal"><span class="pre">conda</span> <span class="pre">env</span> <span class="pre">create</span> <span class="pre">-f</span> <span class="pre">python2.7-environment.yml</span></code> in step 3 above failed
|
||||
for any reason, you can try setting up the environment manually with the following steps:</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Create the environment:</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>conda create --name catalyst <span class="nv">python</span><span class="o">=</span>2.7 scipy
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Activate the environment:</p>
|
||||
<p><strong>Linux or OSX:</strong></p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">source </span>activate catalyst
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Windows:</strong></p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>activate catalyst
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Install the Catalyst inside the environment:</p>
|
||||
<div class="highlight-bash"><div class="highlight"><pre>pip install enigma-catalyst matplotlib
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="getting-help">
|
||||
<h2>Getting Help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If after following the instructions above, and going through the <em>Troubleshooting</em> sections,
|
||||
you still experience problems installing Catalyst, you can seek additional help through the
|
||||
following channels:</p>
|
||||
<ul class="simple">
|
||||
<li>Join our <a class="reference external" href="https://discord.gg/SJK32GY">Discord community</a>, and head over the #catalyst_dev
|
||||
channel where many other users (as well as the project developers) hang out, and can assist
|
||||
you with your particular issue. The more descriptive and the more information you can provide,
|
||||
the easiest will be for others to help you out.</li>
|
||||
<li>Report the problem you are experiencing on our
|
||||
<a class="reference external" href="https://github.com/enigmampc/catalyst/issues">GitHub repository</a> following the guidelines
|
||||
provided therein. Before you do so, take a moment to browse through all <a class="reference external" href="https://github.com/enigmampc/catalyst/issues?utf8=%E2%9C%93&q=is%3Aissue">previous reported issues</a> in the likely case
|
||||
that someone else experienced that same issue before, and you get a hint on how to solve it.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -442,8 +403,6 @@ channel:</p>
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
+11
-240
@@ -30,9 +30,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
<link rel="next" title="Release Notes" href="releases.html"/>
|
||||
<link rel="prev" title="API Reference" href="appendix.html"/>
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -71,242 +69,24 @@
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<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-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></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></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 current"><a class="current reference internal" href="">Release Process</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#updating-the-release-notes">Updating the Release Notes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#updating-the-python-stub-files">Updating the Python stub files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#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="#uploading-pypi-packages">Uploading PyPI packages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#sdist"><code class="docutils literal"><span class="pre">sdist</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#bdist"><code class="docutils literal"><span class="pre">bdist</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#uploading-conda-packages">Uploading conda packages</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#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>
|
||||
<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>
|
||||
</ul>
|
||||
@@ -560,15 +340,6 @@ appear at the top. The syntax for this is:</p>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="releases.html" class="btn btn-neutral float-right" title="Release Notes" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="appendix.html" class="btn btn-neutral" title="API Reference" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
+11
-237
@@ -30,8 +30,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
<link rel="prev" title="Release Process" href="release-process.html"/>
|
||||
<link rel="top" title="Catalyst 0.3 documentation" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -70,242 +69,24 @@
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<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-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></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></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 current"><a class="current reference internal" href="">Release Notes</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#development">Development</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#highlights">Highlights</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#enhancements">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#experimental-features">Experimental Features</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#bug-fixes">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#performance">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#maintenance-and-refactorings">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#build">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#documentation">Documentation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#miscellaneous">Miscellaneous</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-1-1-0">Release 1.1.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id1">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id2">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id4">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">Documentation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Miscellaneous</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-1-0-2">Release 1.0.2</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#experimental">Experimental</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id11">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id12">Documentation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#testing">Testing</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#data-format-changes">Data Format Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-1-0-1">Release 1.0.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id13">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id15">Documentation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-1-0-0">Release 1.0.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id16">Highlights</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#zipline-1-0-rewrite-1105">Zipline 1.0 Rewrite (#1105)</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#new-entry-points-1173-and-1178">New Entry Points (#1173 and #1178)</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#data-bundles-1173-and-1178">Data Bundles (#1173 and #1178)</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#string-support-in-pipeline-1174">String Support in Pipeline (#1174)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Experimental Features</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id20">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id21">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id22">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id23">Documentation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Miscellaneous</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-0-9-0">Release 0.9.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id25">Highlights</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id26">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id27">Experimental Features</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id28">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id29">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id30">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id31">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id32">Documentation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id33">Miscellaneous</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-0-8-4">Release 0.8.4</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id34">Highlights</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id35">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id36">Experimental Features</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id37">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id38">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id39">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id40">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id41">Documentation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id42">Miscellaneous</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-0-8-3">Release 0.8.3</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-0-8-0">Release 0.8.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id43">Highlights</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id44">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id45">Experimental Features</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id46">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id47">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id48">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id49">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id50">Documentation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-0-7-0">Release 0.7.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id51">Highlights</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id52">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id53">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id54">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id55">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id56">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#contributors">Contributors</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#release-0-6-1">Release 0.6.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id57">Highlights</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id58">Enhancements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id59">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id60">Performance</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id61">Maintenance and Refactorings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id62">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id63">Contributors</a></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>
|
||||
</ul>
|
||||
@@ -2049,13 +1830,6 @@ numbers of commit:</p>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
|
||||
<a href="release-process.html" class="btn btn-neutral" title="Release Process" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
+9
-227
@@ -73,238 +73,20 @@
|
||||
<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></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></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>
|
||||
<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>
|
||||
</ul>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user