From e0827fe4ad0d3165561fc4acc79fd47a0a69aa6f Mon Sep 17 00:00:00 2001 From: Cam Sweeney Date: Thu, 11 Jan 2018 12:42:13 -0800 Subject: [PATCH] DOC: present virtualenv info before pip install command Creating a virtualenv is now explained before the command for install via pip. Following the instructions in the current state may cause users to install using the system python, negating the point of the virtualenv --- docs/source/install.rst | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/source/install.rst b/docs/source/install.rst index 13f0b115..4ef78df7 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -180,20 +180,6 @@ use a single tool to install Python and non-Python dependencies, or if you're already using `Anaconda `_ as your Python distribution, refer to the :ref:`Installing with Conda ` section. -Once you've installed the necessary additional dependencies for your system -(see below for your particular platform: :ref:`Linux`, :ref:`MacOS` or -:ref:`Windows`), you should be able to simply run - -.. code-block:: bash - - $ pip install enigma-catalyst matplotlib - -Note that in the command above we install two different packages. The second -one, ``matplotlib`` is a visualization library. While it's not strictly -required to run catalyst simulations or live trading, it comes in very handy -to visualize the performance of your algorithms, and for this reason we -recommend you install it, as well. - If you use Python for anything other than Catalyst, we **strongly** recommend that you install in a `virtualenv `_. The `Hitchhiker's Guide to @@ -206,8 +192,23 @@ summarized version: $ pip install virtualenv $ virtualenv catalyst-venv $ source ./catalyst-venv/bin/activate + + + +Once you've installed the necessary additional dependencies for your system +(:ref:`Linux`, :ref:`MacOS` or :ref:`Windows`) **and have activated your virtualenv**, you should be able to simply run + +.. code-block:: bash + $ pip install enigma-catalyst matplotlib +Note that in the command above we install two different packages. The second +one, ``matplotlib`` is a visualization library. While it's not strictly +required to run catalyst simulations or live trading, it comes in very handy +to visualize the performance of your algorithms, and for this reason we +recommend you install it, as well. + + Troubleshooting ``pip`` Install ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~