DOC: added update instructions (#156)

_sources/install.txt

@@ -193,8 +193,6 @@ summarized version:
    $ 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
 
@@ -220,13 +218,13 @@ Troubleshooting ``pip`` Install
 
    .. code-block:: bash
 
-      pip install --upgrade pip
+      $ pip install --upgrade pip
 
    On Windows, the recommended command is:
 
    .. code-block:: bash
 
-      python -m pip install --upgrade pip
+      $ python -m pip install --upgrade pip
 
 ----
 
@@ -252,7 +250,7 @@ Troubleshooting ``pip`` Install
 
    .. code-block:: bash
 
-      pip install --pre enigma-catalyst
+      $ pip install --pre enigma-catalyst
 
 ----
 
@@ -264,7 +262,7 @@ Troubleshooting ``pip`` Install
 
    .. code-block:: bash
 
-      pip install --upgrade pip setuptools
+      $ pip install --upgrade pip setuptools
 
 ----
 
@@ -279,7 +277,7 @@ Troubleshooting ``pip`` Install
 
    .. code-block:: bash
 
-      pip install -r requirements.txt
+      $ pip install -r requirements.txt
 
 ----
 
@@ -295,7 +293,7 @@ Troubleshooting ``pip`` Install
 
    .. code-block:: bash
 
-      sudo apt-get install python-dev
+      $ sudo apt-get install python-dev
 
 .. _pipenv:
 
@@ -377,14 +375,14 @@ outdated. Thus, you first need to run:
 
 .. code-block:: bash
 
-   pip install --upgrade pip setuptools
+   $ 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++
+   $ sudo yum install gcc gcc-c++
 
 Then you should follow the regular installation instructions outlined at the 
 beginning of this page.
@@ -431,7 +429,7 @@ following command:
 
 .. code-block:: bash
 
-   echo "backend: TkAgg" > ~/.matplotlib/matplotlibrc
+   $ echo "backend: TkAgg" > ~/.matplotlib/matplotlibrc
 
 in order to override the default ``MacOS`` backend for your system, which 
 may not be accessible from inside the virtual or conda environment. This will 
@@ -490,6 +488,33 @@ mentioned above are as follows:
   - ``cd`` into the folder where you downloaded ``VCForPython27.msi``
   - Run ``msiexec /i VCForPython27.msi``
 
+Updating Catalyst
+-----------------
+
+Catalyst is currently in alpha and in under very active development. We release
+new minor versions every few days in response to the thorough battle testing 
+that our user community puts Catalyst in. As a result, you should expect to 
+update Catalyst frequently. Once installed, Catalyst can easily be updated as a 
+``pip`` package regardless of the environemnt used for installation. Make sure 
+you activate your environment first as you did in your first install, and then 
+execute:
+
+.. code-block:: bash
+
+   $ pip uninstall enigma-catalyst
+   $ pip install enigma-catalyst
+
+Alternatively, you could update Catalyst issuing the following command:
+
+.. code-block:: bash
+
+   $ pip install -U enigma-catalyst
+
+but this command will also upgrade all the Catalyst dependencies to the latest 
+versions available, and may have unexpected side effects if a newer version of a 
+dependency inadvertently breaks some functionality that Catalyst relies on. 
+Thus, the first method is the recommended one.
+
 Getting Help
 ------------
 

appendix.html

@@ -89,6 +89,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

beginner-tutorial.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

bundles.html

@@ -89,6 +89,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

development-guidelines.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

example-algos.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

features.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

genindex.html

@@ -90,6 +90,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

index.html

@@ -90,6 +90,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

install.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#getting-help">Getting Help</a></li>
 </ul>
 </li>
@@ -451,11 +452,11 @@ recommend you install it, as well.</p>
 <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
+<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>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
+<div class="last highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>python -m pip install --upgrade pip
 </pre></div>
 </div>
 </dd>
@@ -480,7 +481,7 @@ 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>&#8211;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
+<div class="last highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install --pre enigma-catalyst
 </pre></div>
 </div>
 </dd>
@@ -491,7 +492,7 @@ pre-release and development versions:</p>
 <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
+<div class="last highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install --upgrade pip setuptools
 </pre></div>
 </div>
 </dd>
@@ -504,7 +505,7 @@ pre-release and development versions:</p>
 <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 -&gt; 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
+<div class="last highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install -r requirements.txt
 </pre></div>
 </div>
 </dd>
@@ -519,7 +520,7 @@ install all the required dependencies by running:</p>
 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
+<div class="last highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo apt-get install python-dev
 </pre></div>
 </div>
 </dd>
@@ -570,12 +571,12 @@ dependencies:</p>
 <h3>Amazon Linux AMI Notes<a class="headerlink" href="#amazon-linux-ami-notes" 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
+<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>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++
+<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo yum install gcc gcc-c++
 </pre></div>
 </div>
 <p>Then you should follow the regular installation instructions outlined at the
@@ -611,7 +612,7 @@ information.
 </div>
 <p>This is a <code class="docutils literal"><span class="pre">matplotlib</span></code>-specific error, that will go away once you run the
 following command:</p>
-<div class="highlight-bash"><div class="highlight"><pre><span class="nb">echo</span> <span class="s2">&quot;backend: TkAgg&quot;</span> &gt; ~/.matplotlib/matplotlibrc
+<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span><span class="nb">echo</span> <span class="s2">&quot;backend: TkAgg&quot;</span> &gt; ~/.matplotlib/matplotlibrc
 </pre></div>
 </div>
 <p>in order to override the default <code class="docutils literal"><span class="pre">MacOS</span></code> backend for your system, which
@@ -672,6 +673,28 @@ you have to explictily install this package with administrator privileges:</p>
 </li>
 </ul>
 </div>
+<div class="section" id="updating-catalyst">
+<h2>Updating Catalyst<a class="headerlink" href="#updating-catalyst" title="Permalink to this headline">¶</a></h2>
+<p>Catalyst is currently in alpha and in under very active development. We release
+new minor versions every few days in response to the thorough battle testing
+that our user community puts Catalyst in. As a result, you should expect to
+update Catalyst frequently. Once installed, Catalyst can easily be updated as a
+<code class="docutils literal"><span class="pre">pip</span></code> package regardless of the environemnt used for installation. Make sure
+you activate your environment first as you did in your first install, and then
+execute:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip uninstall enigma-catalyst
+<span class="nv">$ </span>pip install enigma-catalyst
+</pre></div>
+</div>
+<p>Alternatively, you could update Catalyst issuing the following command:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install -U enigma-catalyst
+</pre></div>
+</div>
+<p>but this command will also upgrade all the Catalyst dependencies to the latest
+versions available, and may have unexpected side effects if a newer version of a
+dependency inadvertently breaks some functionality that Catalyst relies on.
+Thus, the first method is the recommended one.</p>
+</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

live-trading.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

release-process.html

@@ -89,6 +89,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

releases.html

@@ -90,6 +90,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

resources.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

search.html

@@ -89,6 +89,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

utilities.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>

videos.html

@@ -91,6 +91,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#windows-requirements">Windows Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#updating-catalyst">Updating Catalyst</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install.html#getting-help">Getting Help</a></li>
 </ul>
 </li>