diff --git a/docs/source/beginner-tutorial.rst b/docs/source/beginner-tutorial.rst index 63b901a5..07d0927a 100644 --- a/docs/source/beginner-tutorial.rst +++ b/docs/source/beginner-tutorial.rst @@ -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 ] + +where ```` is the name of the bundle to ingest, defaulting to +:ref:`quantopian-quandl `. + +you can check out the :ref:`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:: diff --git a/docs/source/bundles.rst b/docs/source/bundles.rst index 15779f48..13fa72a8 100644 --- a/docs/source/bundles.rst +++ b/docs/source/bundles.rst @@ -37,6 +37,8 @@ bundle was ingested. We have run three different ingestions for so it just shows ```` instead. Finally, there is only one ingestion for ``quantopian-quandl``. +.. _ingesting-data: + Ingesting Data ~~~~~~~~~~~~~~