Merge pull request #1248 from wilsonkichoi/master

DOC: remove "python -m" and "--symbols" from the example
This commit is contained in:
Richard Frank
2016-06-03 12:52:15 -07:00
2 changed files with 17 additions and 1 deletions
+15 -1
View File
@@ -99,6 +99,20 @@ To now test this algorithm on financial data, ``zipline`` provides three
interfaces: A command-line interface, ``IPython Notebook`` magic, and
:func:`~zipline.run_algorithm`.
Ingesting Data
^^^^^^^^^^^^^^
If you haven't ingested the data, run:
.. code-block:: bash
$ zipline ingest [-b <bundle>]
where ``<bundle>`` is the name of the bundle to ingest, defaulting to
:ref:`quantopian-quandl <quantopian-quandl-mirror>`.
you can check out the :ref:`ingesting data <ingesting-data>` section for
more detail.
Command line interface
^^^^^^^^^^^^^^^^^^^^^^
@@ -158,7 +172,7 @@ Thus, to execute our algorithm from above and save the results to
.. code-block:: python
python -m zipline run -f ../../zipline/examples/buyapple.py --start 2000-1-1 --end 2014-1-1 --symbols AAPL -o buyapple_out.pickle
zipline run -f ../../zipline/examples/buyapple.py --start 2000-1-1 --end 2014-1-1 -o buyapple_out.pickle
.. parsed-literal::
+2
View File
@@ -37,6 +37,8 @@ bundle was ingested. We have run three different ingestions for
so it just shows ``<no ingestions>`` instead. Finally, there is only one
ingestion for ``quantopian-quandl``.
.. _ingesting-data:
Ingesting Data
~~~~~~~~~~~~~~