From 1d1bda73dd68f44f91fc3506a6bd2f63876106f4 Mon Sep 17 00:00:00 2001 From: Victor Grau Serrat Date: Tue, 14 Nov 2017 12:15:46 -0700 Subject: [PATCH] DOC: improving Win/Conda install instructions --- _sources/install.txt | 62 ++++++++++++++++++++++++---- _sources/releases.txt | 19 +++++++++ appendix.html | 25 ++++++----- beginner-tutorial.html | 25 ++++++----- bundles.html | 25 ++++++----- development-guidelines.html | 25 ++++++----- genindex.html | 25 ++++++----- index.html | 25 ++++++----- install.html | 75 +++++++++++++++++++++++++-------- jupyter.html | 25 ++++++----- live-trading.html | 25 ++++++----- naming-convention.html | 25 ++++++----- release-process.html | 25 ++++++----- releases.html | 82 ++++++++++++++++++++++++------------- resources.html | 25 ++++++----- search.html | 25 ++++++----- searchindex.js | 2 +- videos.html | 25 ++++++----- welcome.html | 25 ++++++----- 19 files changed, 396 insertions(+), 194 deletions(-) diff --git a/_sources/install.txt b/_sources/install.txt index bf958cc9..f9229635 100644 --- a/_sources/install.txt +++ b/_sources/install.txt @@ -136,14 +136,17 @@ about matplotlib backends, please refer to the Windows ~~~~~~~ -In Windows, you will need the `Microsoft Visual C++ Compiler for Python 2.7 +In Windows, you will first need to install the `Microsoft Visual C++ Compiler +for Python 2.7 `_. This package contains the compiler and the set of system headers necessary for producing binary wheels for Python 2.7 packages. If it's not already in your system, download it and install it before proceeding to the next step. -For windows, the easiest and best supported way to install Catalyst is to use -:ref:`Conda `. +Once you have the above compiler installed, the easiest and best supported way +to install Catalyst in Windows is to use :ref:`Conda `. If you didn't +any problems installing the compiler, jump to the :ref:`Conda ` section, +otherwise keep on reading to troubleshoot the C++ compiler installtion. Some problems we have encountered installing the **Visual C++ Compiler** mentioned above are as follows: @@ -158,6 +161,8 @@ mentioned above are as follows: ``Registry Editor`` - Navigate to the following folder: ``HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Installer`` + - If the last folder does not exist, create it by right-clicking on the + parent folder and choosing -> ``New`` -> ``Key`` and typing ``Installer`` - If there is an entry for ``DisableMSI``, set the Value data to 0. - If there is no such entry, click on the ``Edit`` menu -> ``New`` -> ``DWORD (32-bit) Value`` and enter ``DisableMSI`` as the Name (and by @@ -302,9 +307,9 @@ understands the complex binary dependencies of packages like ``numpy`` and dependencies without requiring the use of a second tool to acquire Catalyst's non-Python dependencies. - For Windows, you will need the *Microsoft Visual C++ Compiler for Python - 2.7*. Follow the instructions on the :ref:`Windows` section and come back - here. + For Windows, you will first need to install the *Microsoft Visual C++ + Compiler for Python 2.7*. Follow the instructions on the :ref:`Windows` + section and come back here. For instructions on how to install ``conda``, see the `Conda Installation Documentation `_. Alternatively, @@ -319,10 +324,23 @@ main packages needed. To install MiniConda, you can follow these steps: 3. Ensure the correct installation by running ``conda list`` in a Terminal window, which should print the list of packages installed with Conda. + For Windows, if you accepted the default installation options, you didn't + check an option to add Conda to the PATH, so trying to run ``conda`` from + a regular ``Command Prompt`` will result in the following error: ``'conda' + is no recognized as an internal or external command, operatble program or + batch file``. That's to be expected. You will nee to launch an ``Anaconda + Prompt`` that was added at installation time to your list of programs + available from the Start menu. + Once either Conda or MiniConda has been set up you can install Catalyst: 1. Download the file `python2.7-environment.yml `_. + + To download, simply click on the 'Raw' button and save the file locally to + a folder you can remember. Make sure that the file gets saved with the ``.yml`` + extension, and nothing like a ``.txt`` file or anything else. + 2. Open a Terminal window and enter [``cd/dir``] into the directory where you saved the above ``python2.7-environment.yml`` file. 3. Install using this file. This step can take about 5-10 minutes to install. @@ -346,6 +364,14 @@ Once either Conda or MiniConda has been set up you can install Catalyst: activate catalyst +5. Verify that Catalyst is install correctly: + + .. code-block:: bash + + catalyst --version + + which should display the current version. + Congratulations! You now have Catalyst installed. Troubleshooting ``conda`` Install @@ -355,13 +381,21 @@ If the command ``conda env create -f python2.7-environment.yml`` in step 3 above failed for any reason, you can try setting up the environment manually with the following steps: -1. Create the environment: +1. If the above installation failed, and you have a partially set up catalyst + environment, remove it first. If you are starting from scratch, proceed to + step #2: + + .. code-block:: bash + + conda env remove --name catalyst + +2. Create the environment: .. code-block:: bash conda create --name catalyst python=2.7 scipy zlib -2. Activate the environment: +3. Activate the environment: **Linux or OSX:** @@ -375,12 +409,22 @@ with the following steps: activate catalyst -3. Install the Catalyst inside the environment: +4. Install the Catalyst inside the environment: .. code-block:: bash pip install enigma-catalyst matplotlib +5. Verify that Catalyst is installed correctly: + + .. code-block:: bash + + catalyst --version + + which should display the current version. + +Congratulations! You now have Catalyst properly installed. + Getting Help ------------ diff --git a/_sources/releases.txt b/_sources/releases.txt index 1db0401f..6945a1b7 100644 --- a/_sources/releases.txt +++ b/_sources/releases.txt @@ -2,6 +2,25 @@ Release Notes ============= +Version 0.3.7 +^^^^^^^^^^^^^ +**Release Date**: 2017-11-14 + +Bug Fixes +~~~~~~~~~ + +- Fixed an SSL cert issue (:issue:`64`) +- Fixed cumulative stats warnings (:issue:`63`) +- Disabled auto-ingestion because of unresolved caching issues (:issue:`47`) +- Standardized live-trading stats (:issue:`61`) + +Build +~~~~~ + +- Added a mean-reversion sample algo +- Added minutely stats in the analyze() function (:issue:`62`) +- Added specificity to some error messages + Version 0.3.6 ^^^^^^^^^^^^^ **Release Date**: 2017-11-4 diff --git a/appendix.html b/appendix.html index 90a6241f..75c08cbe 100644 --- a/appendix.html +++ b/appendix.html @@ -135,32 +135,37 @@
  • Release Notes
      -
    • Version 0.3.6
        +
      • Version 0.3.7
        • -
      • Version 0.3.5
          +
        • Version 0.3.6
          • -
        • Version 0.3.4
            +
          • Version 0.3.5 +
            • +
          • Version 0.3.4
          • Version 0.3.3 -
            • -
          • Version 0.3.2
            • -
          • Version 0.3.1
          • Release Notes
              -
            • Version 0.3.6
                +
              • Version 0.3.7
                • -
              • Version 0.3.5
                  +
                • Version 0.3.6
                  • -
                • Version 0.3.4
                    +
                  • Version 0.3.5 +
                    • +
                  • Version 0.3.4
                  • Version 0.3.3 -
                    • -
                  • Version 0.3.2
                    • -
                  • Version 0.3.1
                  • Release Notes
                      -
                    • Version 0.3.6
                        +
                      • Version 0.3.7
                        • -
                      • Version 0.3.5
                          +
                        • Version 0.3.6
                          • -
                        • Version 0.3.4
                            +
                          • Version 0.3.5 +
                            • +
                          • Version 0.3.4
                          • Version 0.3.3 -
                            • -
                          • Version 0.3.2
                            • -
                          • Version 0.3.1
                          • Release Notes
                              -
                            • Version 0.3.6
                                +
                              • Version 0.3.7
                                • -
                              • Version 0.3.5
                                  +
                                • Version 0.3.6
                                  • -
                                • Version 0.3.4
                                    +
                                  • Version 0.3.5 +
                                    • +
                                  • Version 0.3.4
                                  • Version 0.3.3 -
                                    • -
                                  • Version 0.3.2
                                    • -
                                  • Version 0.3.1
                                  • Release Notes
                                      -
                                    • Version 0.3.6
                                        +
                                      • Version 0.3.7
                                        • -
                                      • Version 0.3.5
                                          +
                                        • Version 0.3.6
                                          • -
                                        • Version 0.3.4
                                            +
                                          • Version 0.3.5 +
                                            • +
                                          • Version 0.3.4
                                          • Version 0.3.3 -
                                            • -
                                          • Version 0.3.2
                                            • -
                                          • Version 0.3.1
                                          • Release Notes
                                              -
                                            • Version 0.3.6
                                                +
                                              • Version 0.3.7
                                                • -
                                              • Version 0.3.5
                                                  +
                                                • Version 0.3.6
                                                  • -
                                                • Version 0.3.4
                                                    +
                                                  • Version 0.3.5 +
                                                    • +
                                                  • Version 0.3.4
                                                  • Version 0.3.3 -
                                                    • -
                                                  • Version 0.3.2
                                                    • -
                                                  • Version 0.3.1
                                                  • Release Notes
                                                      -
                                                    • Version 0.3.6
                                                        +
                                                      • Version 0.3.7
                                                        • -
                                                      • Version 0.3.5
                                                          +
                                                        • Version 0.3.6
                                                          • -
                                                        • Version 0.3.4
                                                            +
                                                          • Version 0.3.5 +
                                                            • +
                                                          • Version 0.3.4
                                                          • Version 0.3.3 -
                                                            • -
                                                          • Version 0.3.2
                                                            • -
                                                          • Version 0.3.1
                                                              +
                                                            • Version 0.3.2 +
                                                              • +
                                                            • Version 0.3.1
                                                            • Version 0.3
                                                              • @@ -310,12 +315,15 @@ about matplotlib backends, please refer to the

                                                              Windows

                                                              -

                                                              In Windows, you will need the Microsoft Visual C++ Compiler for Python 2.7. This +

                                                              In Windows, you will first need to install the Microsoft Visual C++ Compiler +for Python 2.7. This package contains the compiler and the set of system headers necessary for producing binary wheels for Python 2.7 packages. If it’s not already in your system, download it and install it before proceeding to the next step.

                                                              -

                                                              For windows, the easiest and best supported way to install Catalyst is to use -Conda.

                                                              +

                                                              Once you have the above compiler installed, the easiest and best supported way +to install Catalyst in Windows is to use Conda. If you didn’t +any problems installing the compiler, jump to the Conda section, +otherwise keep on reading to troubleshoot the C++ compiler installtion.

                                                              Some problems we have encountered installing the Visual C++ Compiler mentioned above are as follows:

                                                                @@ -328,6 +336,8 @@ You’ll have to change the Registry to circumvent this:

                                                                Registry Editor
                                                              • Navigate to the following folder: HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Installer
                                                                • +
                                                              • If the last folder does not exist, create it by right-clicking on the +parent folder and choosing -> New -> Key and typing Installer
                                                              • If there is an entry for DisableMSI, set the Value data to 0.
                                                              • If there is no such entry, click on the Edit menu -> New -> DWORD (32-bit) Value and enter DisableMSI as the Name (and by @@ -460,9 +470,9 @@ understands the complex binary dependencies of packages like