MAINT: updated conda install instructions for Python3

This commit is contained in:
Victor Grau Serrat
2018-02-13 12:14:42 -07:00
parent f0c1f5dadc
commit 3be46acfaa
4 changed files with 27 additions and 7 deletions
+1 -1
View File
@@ -1879,7 +1879,7 @@ Assets.</p>
<dl class="class">
<dt id="catalyst.utils.calendars.TradingCalendar">
<em class="property">class </em><code class="descclassname">catalyst.utils.calendars.</code><code class="descname">TradingCalendar</code><span class="sig-paren">(</span><em>start=Timestamp('1990-01-01 00:00:00+0000'</em>, <em>tz='UTC')</em>, <em>end=Timestamp('2019-02-09 18:21:02.955333+0000'</em>, <em>tz='UTC')</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/catalyst/utils/calendars/trading_calendar.html#TradingCalendar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#catalyst.utils.calendars.TradingCalendar" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">catalyst.utils.calendars.</code><code class="descname">TradingCalendar</code><span class="sig-paren">(</span><em>start=Timestamp('1990-01-01 00:00:00+0000'</em>, <em>tz='UTC')</em>, <em>end=Timestamp('2019-02-13 19:10:13.712026+0000'</em>, <em>tz='UTC')</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/catalyst/utils/calendars/trading_calendar.html#TradingCalendar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#catalyst.utils.calendars.TradingCalendar" title="Permalink to this definition"></a></dt>
<dd><p>An TradingCalendar represents the timing information of a single market
exchange.</p>
<p>The timing information is made up of two parts: sessions, and opens/closes.</p>
+19 -5
View File
@@ -219,8 +219,10 @@ you can install MiniConda, which is a smaller footprint (fewer packages and
smaller size) than its big brother Anaconda, but it still contains all the
main packages needed. To install MiniConda, you can follow these steps:</p>
<ol class="arabic simple">
<li>Download <a class="reference external" href="https://conda.io/miniconda.html">MiniConda</a>. Select Python 2.7
for your Operating System.</li>
<li>Download <a class="reference external" href="https://conda.io/miniconda.html">MiniConda</a>. Select either
Python 3.6 (recommended) or Python 2.7 for your Operating System. The
<a class="reference external" href="https://enigmampc.github.io/marketplace/">Enigma Data Marketplace</a> will
require Python3, thats why we are recommending to opt for the newer version.</li>
<li>Install MiniConda. See the <a class="reference external" href="https://conda.io/docs/user-guide/install/index.html">Installation Instructions</a> if you need help.</li>
<li>Ensure the correct installation by running <code class="docutils literal"><span class="pre">conda</span> <span class="pre">list</span></code> in a Terminal
window, which should print the list of packages installed with Conda.</li>
@@ -235,7 +237,9 @@ a regular <code class="docutils literal"><span class="pre">Command</span> <span
available from the Start menu.</div></blockquote>
<p>Once either Conda or MiniConda has been set up you can install Catalyst:</p>
<ol class="arabic">
<li><p class="first">Download the file <a class="reference external" href="https://github.com/enigmampc/catalyst/blob/master/etc/python2.7-environment.yml">python2.7-environment.yml</a>.</p>
<li><p class="first">Download the file <a class="reference external" href="https://github.com/enigmampc/catalyst/blob/master/etc/python3.6-environment.yml">python3.6-environment.yml</a>
(recommended) or <a class="reference external" href="https://github.com/enigmampc/catalyst/blob/master/etc/python2.7-environment.yml">python2.7-environment.yml</a>
matching your Conda installation from step #1 above.</p>
<blockquote>
<div><p>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
@@ -243,13 +247,23 @@ to a folder you can remember. Make sure that the file gets saved with the
</div></blockquote>
</li>
<li><p class="first">Open a Terminal window and enter [<code class="docutils literal"><span class="pre">cd/dir</span></code>] into the directory where you
saved the above <code class="docutils literal"><span class="pre">python2.7-environment.yml</span></code> file.</p>
saved the above <code class="docutils literal"><span class="pre">.yml</span></code> file.</p>
</li>
<li><p class="first">Install using this file. This step can take about 5-10 minutes to install.</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>conda env create -f python2.7-environment.yml
<div class="highlight-bash"><div class="highlight"><pre><span></span>conda env create -f python3.6-environment.yml
</pre></div>
</div>
</li>
</ol>
<blockquote>
<div><p>or</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span></span>conda env create -f python2.7-environment.yml
</pre></div>
</div>
</div></blockquote>
</div></blockquote>
<ol class="arabic" start="4">
<li><p class="first">Activate the environment (which you need to do every time you start a new
session to run Catalyst):</p>
<p><strong>Linux or MacOS:</strong></p>
+6
View File
@@ -335,6 +335,12 @@ trading pairs of your algorithm must match this value.</li>
<li><code class="docutils literal"><span class="pre">simulate_orders</span></code>: Enables the paper trading mode, in which orders are
simulated in Catalyst instead of processed on the exchange. It defaults to
<code class="docutils literal"><span class="pre">True</span></code>.</li>
<li><code class="docutils literal"><span class="pre">end_date</span></code>: When setting the end_date to a time in the <strong>future</strong>,
it will schedule the live algo to finish gracefully at the specified date.</li>
<li><code class="docutils literal"><span class="pre">start_date</span></code>: (<strong>Will be implemented in the future</strong>)
The live algo starts by default in the present, as mentioned above.
by setting the start_date to a time in the future, the algorithm would
essentially sleep and when the predefined time comes, it would start executing.</li>
</ul>
<p>Here is a complete algorithm for reference:
<a class="reference external" href="https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_low_sell_high_live.py">Buy Low and Sell High</a></p>
+1 -1
View File
File diff suppressed because one or more lines are too long