From 13f506d9c81fadc60a96b8fa13fd80fdc1b6f3d9 Mon Sep 17 00:00:00 2001 From: Wilson Choi Date: Thu, 2 Jun 2016 14:55:12 -0700 Subject: [PATCH 1/3] DOC: remove "python -m" and "--symbols" from the example --- docs/source/beginner-tutorial.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/beginner-tutorial.rst b/docs/source/beginner-tutorial.rst index 7c45efe4..d8c17302 100644 --- a/docs/source/beginner-tutorial.rst +++ b/docs/source/beginner-tutorial.rst @@ -155,7 +155,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:: From 25cc65e3933cbe4b80d0bb9d636c4e74bcb3f0c4 Mon Sep 17 00:00:00 2001 From: Wilson Choi Date: Thu, 2 Jun 2016 16:07:41 -0700 Subject: [PATCH 2/3] DOC: add ingesting data ref to beginner tutorial --- docs/source/beginner-tutorial.rst | 14 ++++++++++++++ docs/source/bundles.rst | 2 ++ 2 files changed, 16 insertions(+) diff --git a/docs/source/beginner-tutorial.rst b/docs/source/beginner-tutorial.rst index d8c17302..44f61031 100644 --- a/docs/source/beginner-tutorial.rst +++ b/docs/source/beginner-tutorial.rst @@ -96,6 +96,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 ingest 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 ^^^^^^^^^^^^^^^^^^^^^^ 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 ~~~~~~~~~~~~~~ From 1c2e0da29981a33ccc2df85b3d061009ee3b19f5 Mon Sep 17 00:00:00 2001 From: Wilson Choi Date: Fri, 3 Jun 2016 11:25:41 -0700 Subject: [PATCH 3/3] DOC: fix typo --- docs/source/beginner-tutorial.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/beginner-tutorial.rst b/docs/source/beginner-tutorial.rst index 44f61031..f1fc38b3 100644 --- a/docs/source/beginner-tutorial.rst +++ b/docs/source/beginner-tutorial.rst @@ -98,7 +98,7 @@ interfaces: A command-line interface, ``IPython Notebook`` magic, and Ingesting Data ^^^^^^^^^^^^^^ -If you haven't ingest the data, run: +If you haven't ingested the data, run: .. code-block:: bash @@ -108,7 +108,7 @@ 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 +more detail. Command line interface ^^^^^^^^^^^^^^^^^^^^^^