Merge branch 'develop'

# Conflicts:
#	catalyst/constants.py

catalyst/__main__.py

@@ -30,16 +30,17 @@ except NameError:
 @click.option(
     '--strict-extensions/--non-strict-extensions',
     is_flag=True,
-    help='If --strict-extensions is passed then catalyst will not run if it'
+    help='If --strict-extensions is passed then catalyst will not run '
-         ' cannot load all of the specified extensions. If this is not passed or'
+         'if it cannot load all of the specified extensions. If this is '
-         ' --non-strict-extensions is passed then the failure will be logged but'
+         'not passed or --non-strict-extensions is passed then the '
-         ' execution will continue.',
+         'failure will be logged but execution will continue.',
 )
 @click.option(
     '--default-extension/--no-default-extension',
     is_flag=True,
     default=True,
-    help="Don't load the default catalyst extension.py file in $CATALYST_HOME.",
+    help="Don't load the default catalyst extension.py file "
+         "in $CATALYST_HOME.",
 )
 @click.version_option()
 def main(extension, strict_extensions, default_extension):
@@ -124,9 +125,9 @@ def ipython_only(option):
     '--define',
     multiple=True,
     help="Define a name to be bound in the namespace before executing"
-         " the algotext. For example '-Dname=value'. The value may be any python"
+         " the algotext. For example '-Dname=value'. The value may be"
-         " expression. These are evaluated in order so they may refer to previously"
+         " any python expression. These are evaluated in order so they"
-         " defined names.",
+         " may refer to previously defined names.",
 )
 @click.option(
     '--data-frequency',
@@ -138,7 +139,6 @@ def ipython_only(option):
 @click.option(
     '--capital-base',
     type=float,
-    default=10e6,
     show_default=True,
     help='The starting capital for the simulation.',
 )
@@ -176,8 +176,8 @@ def ipython_only(option):
     default='-',
     metavar='FILENAME',
     show_default=True,
-    help="The location to write the perf data. If this is '-' the perf will"
+    help="The location to write the perf data. If this is '-' the perf"
-         " be written to stdout.",
+         " will be written to stdout.",
 )
 @click.option(
     '--print-algo/--no-print-algo',
@@ -195,7 +195,8 @@ def ipython_only(option):
     '-x',
     '--exchange-name',
     type=click.Choice({'bitfinex', 'bittrex', 'poloniex'}),
-    help='The name of the targeted exchange (supported: bitfinex, bittrex, poloniex).',
+    help='The name of the targeted exchange (supported: bitfinex,'
+         ' bittrex, poloniex).',
 )
 @click.option(
     '-n',
@@ -240,16 +241,26 @@ def run(ctx,
         # does not pass either of these and then passes the first only
         # to be told they need to pass the second argument also
         ctx.fail(
-            "must specify dates with '-s' / '--start' and '-e' / '--end'",
+            "must specify dates with '-s' / '--start' and '-e' / '--end'"
+            " in backtest mode",
         )
     if start is None:
-        ctx.fail("must specify a start date with '-s' / '--start'")
+        ctx.fail("must specify a start date with '-s' / '--start'"
+                 " in backtest mode")
     if end is None:
-        ctx.fail("must specify an end date with '-e' / '--end'")
+        ctx.fail("must specify an end date with '-e' / '--end'"
+                 " in backtest mode")
 
     if exchange_name is None:
         ctx.fail("must specify an exchange name '-x'")
 
+    if base_currency is None:
+        ctx.fail("must specify a base currency with '-c' in backtest mode")
+
+    if capital_base is None:
+        ctx.fail("must specify a capital base with '--capital-base'"
+                 " in backtest mode")
+
     perf = _run(
         initialize=None,
         handle_data=None,
@@ -335,9 +346,9 @@ def catalyst_magic(line, cell=None):
     '--define',
     multiple=True,
     help="Define a name to be bound in the namespace before executing"
-         " the algotext. For example '-Dname=value'. The value may be any python"
+         " the algotext. For example '-Dname=value'. The value may be"
-         " expression. These are evaluated in order so they may refer to previously"
+         " any python expression. These are evaluated in order so they"
-         " defined names.",
+         " may refer to previously defined names.",
 )
 @click.option(
     '-o',
@@ -364,7 +375,8 @@ def catalyst_magic(line, cell=None):
     '-x',
     '--exchange-name',
     type=click.Choice({'bitfinex', 'bittrex', 'poloniex'}),
-    help='The name of the targeted exchange (supported: bitfinex, bittrex, poloniex).',
+    help='The name of the targeted exchange (supported: bitfinex,'
+         ' bittrex, poloniex).',
 )
 @click.option(
     '-n',
@@ -486,6 +498,13 @@ def live(ctx,
     help='A list of symbols to exclude from the ingestion '
          '(optional comma separated list)',
 )
+@click.option(
+    '--csv',
+    default=None,
+    help='The path of a CSV file containing the data. If specified, start, '
+         'end, include-symbols and exclude-symbols will be ignored. Instead,'
+         'all data in the file will be ingested.',
+)
 @click.option(
     '--show-progress/--no-show-progress',
     default=True,
@@ -502,8 +521,8 @@ def live(ctx,
     help='Report potential anomalies found in data bundles.'
 )
 def ingest_exchange(exchange_name, data_frequency, start, end,
-                    include_symbols, exclude_symbols, show_progress, verbose,
+                    include_symbols, exclude_symbols, csv, show_progress,
-                    validate):
+                    verbose, validate):
     """
     Ingest data for the given exchange.
     """
@@ -511,8 +530,7 @@ def ingest_exchange(exchange_name, data_frequency, start, end,
     if exchange_name is None:
         ctx.fail("must specify an exchange name '-x'")
 
-    exchange = get_exchange(exchange_name)
+    exchange_bundle = ExchangeBundle(exchange_name)
-    exchange_bundle = ExchangeBundle(exchange)
 
     click.echo('Ingesting exchange bundle {}...'.format(exchange_name))
     exchange_bundle.ingest(
@@ -523,7 +541,8 @@ def ingest_exchange(exchange_name, data_frequency, start, end,
         end=end,
         show_progress=show_progress,
         show_breakdown=verbose,
-        show_report=validate
+        show_report=validate,
+        csv=csv
     )
 
 
@@ -536,9 +555,10 @@ def ingest_exchange(exchange_name, data_frequency, start, end,
 @click.pass_context
 def clean_algo(ctx, algo_namespace):
     click.echo(
-        'Deleting the state folder of algo: {}...'.format(algo_namespace)
+        'Cleaning algo state: {}'.format(algo_namespace)
     )
     delete_algo_folder(algo_namespace)
+    click.echo('Done')
 
 
 @main.command(name='clean-exchange')
@@ -565,8 +585,7 @@ def clean_exchange(ctx, exchange_name, data_frequency):
     if exchange_name is None:
         ctx.fail("must specify an exchange name '-x'")
 
-    exchange = get_exchange(exchange_name)
+    exchange_bundle = ExchangeBundle(exchange_name)
-    exchange_bundle = ExchangeBundle(exchange)
 
     click.echo('Cleaning exchange bundle {}...'.format(exchange_name))
     exchange_bundle.clean(

catalyst/assets/_assets.pyx

@@ -38,6 +38,7 @@ from numpy cimport int64_t
 import warnings
 cimport numpy as np
 
+from catalyst.exchange.exchange_utils import get_sid
 from catalyst.utils.calendars import get_calendar
 from catalyst.exchange.exchange_errors import InvalidSymbolError, SidHashError
 
@@ -503,11 +504,7 @@ cdef class TradingPair(Asset):
 
         if sid == 0 or sid is None:
             try:
-                # sid = abs(hash(symbol)) % (10 ** 4)
+                sid = get_sid(symbol)
-                # TODO: try to encode the symbol in the main scope
-                sid = int(
-                    hashlib.sha256(symbol.encode('utf-8')).hexdigest(), 16
-                ) % 10 ** 6
             except Exception as e:
                 raise SidHashError(symbol=symbol)
 
@@ -559,6 +556,17 @@ cdef class TradingPair(Asset):
             end_minute=self.end_minute
         )
 
+    cpdef to_dict(self):
+        """
+        Convert to a python dict.
+        """
+        super_dict = super(TradingPair, self).to_dict()
+        super_dict['end_daily'] = self.end_daily
+        super_dict['end_minute'] = self.end_minute
+        super_dict['leverage'] = self.leverage
+        super_dict['min_trade_size'] = self.min_trade_size
+        return super_dict
+
     def is_exchange_open(self, dt_minute):
         """
         Parameters

catalyst/constants.py

@@ -1,9 +1,18 @@
 # -*- coding: utf-8 -*-
 
+import os
 import logbook
 
-LOG_LEVEL = logbook.INFO
+''' You can override the LOG level from your environment.
+    For example, if you want to see the DEBUG messages, run:
+    $ export CATALYST_LOG_LEVEL=10
+'''
+LOG_LEVEL = int(os.environ.get('CATALYST_LOG_LEVEL', logbook.INFO))
+
+SYMBOLS_URL = 'https://s3.amazonaws.com/enigmaco/catalyst-exchanges/' \
+              '{exchange}/symbols.json'
 
 DATE_TIME_FORMAT = '%Y-%m-%d %H:%M'
+DATE_FORMAT = '%Y-%m-%d'
 
 AUTO_INGEST = False

catalyst/data/loader.py

@@ -149,13 +149,14 @@ def load_crypto_market_data(trading_day=None, trading_days=None,
 
     # exchange.get_history_window() already ensures that we have the right data
     # for the right dates
-    br = exchange.get_history_window(
+    br = exchange.get_history_window_with_bundle(
         assets=[benchmark_asset],
         end_dt=last_date,
         bar_count=pd.Timedelta(last_date - start_dt).days,
         frequency='1d',
         field='close',
-        data_frequency='daily')
+        data_frequency='daily',
+        force_auto_ingest=True)
     br.columns = ['close']
     br = br.pct_change(1).iloc[1:]
     br.loc[start_dt] = 0

catalyst/examples/buy_and_hodl.py

@@ -14,6 +14,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+import pandas as pd
 
 from catalyst.api import (
     order_target_value,
@@ -23,21 +24,18 @@ from catalyst.api import (
     get_open_orders,
 )
 
+
 def initialize(context):
-    context.ASSET_NAME = 'BTC_USDT'
+    context.ASSET_NAME = 'btc_usdt'
     context.TARGET_HODL_RATIO = 0.8
     context.RESERVE_RATIO = 1.0 - context.TARGET_HODL_RATIO
 
-    # For all trading pairs in the poloniex bundle, the default denomination
-    # currently supported by Catalyst is 1/1000th of a full coin. Use this
-    # constant to scale the price of up to that of a full coin if desired.
-    context.TICK_SIZE = 1000.0
-
     context.is_buying = True
     context.asset = symbol(context.ASSET_NAME)
 
     context.i = 0
 
+
 def handle_data(context, data):
     context.i += 1
 
@@ -64,8 +62,8 @@ def handle_data(context, data):
         order_target_value(
             context.asset,
             target_hodl_value,
-            limit_price=price*1.1,
+            limit_price=price * 1.1,
-            stop_price=price*0.9,
+            stop_price=price * 0.9,
         )
 
     record(
@@ -76,6 +74,7 @@ def handle_data(context, data):
         leverage=context.account.leverage,
     )
 
+
 def analyze(context=None, results=None):
     import matplotlib.pyplot as plt
 
@@ -86,7 +85,7 @@ def analyze(context=None, results=None):
 
     ax2 = plt.subplot(612, sharex=ax1)
     ax2.set_ylabel('{asset} (USD)'.format(asset=context.ASSET_NAME))
-    (context.TICK_SIZE * results[['price']]).plot(ax=ax2)
+    results[['price']].plot(ax=ax2)
 
     trans = results.ix[[t != [] for t in results.transactions]]
     buys = trans.ix[
@@ -94,7 +93,7 @@ def analyze(context=None, results=None):
     ]
     ax2.plot(
         buys.index,
-        context.TICK_SIZE * results.price[buys.index],
+        results.price[buys.index],
         '^',
         markersize=10,
         color='g',
@@ -134,4 +133,5 @@ def analyze(context=None, results=None):
 
     # Show the plot.
     plt.gcf().set_size_inches(18, 8)
-    plt.show()
+    plt.show()
+

catalyst/examples/mean_reversion.py

@@ -1,283 +0,0 @@
-# For this example, we're going to write a simple momentum script.  When the 
-# stock goes up quickly, we're going to buy; when it goes down quickly, we're
-# going to sell.  Hopefully we'll ride the waves.
-from datetime import timedelta
-
-import pandas as pd
-import talib
-# To run an algorithm in Catalyst, you need two functions: initialize and
-# handle_data.
-from logbook import Logger
-from talib.common import MA_Type
-
-from catalyst import run_algorithm
-from catalyst.api import symbol, record, order_target_percent, \
-    get_open_orders
-# We give a name to the algorithm which Catalyst will use to persist its state.
-# In this example, Catalyst will create the `.catalyst/data/live_algos`
-# directory. If we stop and start the algorithm, Catalyst will resume its
-# state using the files included in the folder.
-from catalyst.exchange.stats_utils import extract_transactions, trend_direction
-
-algo_namespace = 'momentum'
-log = Logger(algo_namespace)
-
-
-def initialize(context):
-    # This initialize function sets any data or variables that you'll use in
-    # your algorithm.  For instance, you'll want to define the trading pair (or
-    # trading pairs) you want to backtest.  You'll also want to define any
-    # parameters or values you're going to use.
-
-    # In our example, we're looking at Ether in USD Tether.
-    context.eth_btc = symbol('etc_usdt')
-    context.base_price = None
-    context.current_day = None
-    context.trigger = None
-
-
-def handle_data(context, data):
-    # This handle_data function is where the real work is done.  Our data is
-    # minute-level tick data, and each minute is called a frame.  This function
-    # runs on each frame of the data.
-
-    # We flag the first period of each day.
-    # Since cryptocurrencies trade 24/7 the `before_trading_starts` handle
-    # would only execute once. This method works with minute and daily
-    # frequencies.
-    today = data.current_dt.floor('1D')
-    if today != context.current_day:
-        context.traded_today = False
-        context.current_day = today
-
-    # We're computing the volume-weighted-average-price of the security
-    # defined above, in the context.eth_btc variable.  For this example, we're 
-    # using three bars on the 15 min bars.
-
-    # The frequency attribute determine the bar size. We use this convention
-    # for the frequency alias:
-    # http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases
-    prices = data.history(
-        context.eth_btc,
-        fields='close',
-        bar_count=50,
-        frequency='15T'
-    )
-
-    # Ta-lib calculates various technical indicator based on price and
-    # volume arrays.
-
-    # In this example, we are comp
-    rsi = talib.RSI(prices.values, timeperiod=14)
-    upper, middle, lower = talib.BBANDS(
-        prices.values,
-        timeperiod=20,
-        nbdevup=2,
-        nbdevdn=2,
-        matype=MA_Type.EMA
-    )
-
-    # We need a variable for the current price of the security to compare to
-    # the average. Since we are requesting two fields, data.current()
-    # returns a DataFrame with
-    current = data.current(context.eth_btc, fields=['close', 'volume'])
-    price = current['close']
-
-    # If base_price is not set, we use the current value. This is the
-    # price at the first bar which we reference to calculate price_change.
-    if context.base_price is None:
-        context.base_price = price
-
-    price_change = (price - context.base_price) / context.base_price
-    cash = context.portfolio.cash
-
-    # Now that we've collected all current data for this frame, we use
-    # the record() method to save it. This data will be available as
-    # a parameter of the analyze() function for further analysis.
-    record(
-        price=price,
-        volume=current['volume'],
-        upper_band=upper[-1],
-        lower_band=lower[-1],
-        price_change=price_change,
-        rsi=rsi[-1],
-        cash=cash
-    )
-
-    # We are trying to avoid over-trading by limiting our trades to
-    # one per day.
-    if context.traded_today:
-        return
-
-    # Since we are using limit orders, some orders may not execute immediately
-    # we wait until all orders are executed before considering more trades.
-    orders = get_open_orders(context.eth_btc)
-    if len(orders) > 0:
-        return
-
-    # Exit if we cannot trade
-    if not data.can_trade(context.eth_btc):
-        return
-
-    # Another powerful built-in feature of the Catalyst backtester is the
-    # portfolio object.  The portfolio object tracks your positions, cash,
-    # cost basis of specific holdings, and more.  In this line, we calculate
-    # how long or short our position is at this minute.   
-    pos_amount = context.portfolio.positions[context.eth_btc].amount
-
-    # In this example, we're using a trigger instead of buying directly after
-    # a signal. Since this is mean reversion, our signals go against the
-    # momentum. Using a trigger allow us to spot the opportunity but trade
-    # only when a trade reversal begins.
-    if context.trigger is not None:
-        # The tread_direction() method determines the trend based on the last
-        # two bars of the series.
-        direction = trend_direction(rsi)
-        if context.trigger[1] == 'buy' and direction == 'up':
-            log.info(
-                '{}: buying - price: {}, rsi: {}, bband: {}'.format(
-                    data.current_dt, price, rsi[-1], lower[-1]
-                )
-            )
-            order_target_percent(context.eth_btc, 1)
-            context.traded_today = True
-            context.trigger = None
-
-        elif context.trigger[1] == 'sell' and direction == 'down':
-            log.info(
-                '{}: selling - price: {}, rsi: {}, bband: {}'.format(
-                    data.current_dt, price, rsi[-1], upper[-1]
-                )
-            )
-            order_target_percent(context.eth_btc, 0)
-            context.traded_today = True
-            context.trigger = None
-
-        # If we found a signal but no trade reversal within two hours, we
-        # reset the trigger.
-        elif context.trigger[0] + timedelta(hours=2) < data.current_dt:
-            context.trigger = None
-
-    else:
-        # Determining the entry and exit signals based on RSI and SMA
-        if rsi[-1] <= 30 and pos_amount == 0:
-            context.trigger = (data.current_dt, 'buy')
-
-        elif rsi[-1] >= 80 and pos_amount > 0:
-            context.trigger = (data.current_dt, 'sell')
-
-
-def analyze(context=None, perf=None):
-    import matplotlib.pyplot as plt
-
-    # The base currency of the algo exchange
-    base_currency = context.exchanges.values()[0].base_currency.upper()
-
-    # Plot the portfolio value over time.
-    ax1 = plt.subplot(611)
-    perf.loc[:, 'portfolio_value'].plot(ax=ax1)
-    ax1.set_ylabel('Portfolio Value ({})'.format(base_currency))
-
-    # Plot the price increase or decrease over time.
-    ax2 = plt.subplot(612, sharex=ax1)
-    perf.loc[:, 'price'].plot(ax=ax2, label='Price')
-    perf.loc[:, 'upper_band'].plot(ax=ax2, label='Upper')
-    perf.loc[:, 'lower_band'].plot(ax=ax2, label='Lower')
-
-    ax2.set_ylabel('{asset} ({base})'.format(
-        asset=context.eth_btc.symbol, base=base_currency
-    ))
-
-    transaction_df = extract_transactions(perf)
-    if not transaction_df.empty:
-        buy_df = transaction_df[transaction_df['amount'] > 0]
-        sell_df = transaction_df[transaction_df['amount'] < 0]
-        ax2.scatter(
-            buy_df.index.to_pydatetime(),
-            perf.loc[buy_df.index, 'price'],
-            marker='^',
-            s=100,
-            c='green',
-            label=''
-        )
-        ax2.scatter(
-            sell_df.index.to_pydatetime(),
-            perf.loc[sell_df.index, 'price'],
-            marker='v',
-            s=100,
-            c='red',
-            label=''
-        )
-
-    ax4 = plt.subplot(613, sharex=ax1)
-    perf.loc[:, 'cash'].plot(
-        ax=ax4, label='Base Currency ({})'.format(base_currency)
-    )
-    ax4.set_ylabel('Cash ({})'.format(base_currency))
-
-    perf['algorithm'] = perf.loc[:, 'algorithm_period_return']
-
-    ax5 = plt.subplot(614, sharex=ax1)
-    perf.loc[:, ['algorithm', 'price_change']].plot(ax=ax5)
-    ax5.set_ylabel('Percent Change')
-
-    ax6 = plt.subplot(615, sharex=ax1)
-    perf.loc[:, 'rsi'].plot(ax=ax6, label='RSI')
-    ax6.axhline(70, color='darkgoldenrod')
-    ax6.axhline(30, color='darkgoldenrod')
-
-    if not transaction_df.empty:
-        ax6.scatter(
-            buy_df.index.to_pydatetime(),
-            perf.loc[buy_df.index, 'rsi'],
-            marker='^',
-            s=100,
-            c='green',
-            label=''
-        )
-        ax6.scatter(
-            sell_df.index.to_pydatetime(),
-            perf.loc[sell_df.index, 'rsi'],
-            marker='v',
-            s=100,
-            c='red',
-            label=''
-        )
-    plt.legend(loc=3)
-
-    # Show the plot.
-    plt.gcf().set_size_inches(18, 8)
-    plt.show()
-    pass
-
-
-if __name__ == '__main__':
-    # The execution mode: backtest or live
-    MODE = 'backtest'
-
-    if MODE == 'backtest':
-        run_algorithm(
-            capital_base=1,
-            data_frequency='minute',
-            initialize=initialize,
-            handle_data=handle_data,
-            analyze=analyze,
-            exchange_name='poloniex',
-            algo_namespace=algo_namespace,
-            base_currency='usdt',
-            start=pd.to_datetime('2017-7-1', utc=True),
-            # end=pd.to_datetime('2017-9-30', utc=True),
-            end=pd.to_datetime('2017-10-31', utc=True),
-        )
-
-    elif MODE == 'live':
-        run_algorithm(
-            initialize=initialize,
-            handle_data=handle_data,
-            analyze=analyze,
-            exchange_name='poloniex',
-            live=True,
-            algo_namespace=algo_namespace,
-            base_currency='usdt',
-            live_graph=True
-        )

catalyst/examples/mean_reversion_simple.py

@@ -1,28 +1,30 @@
 # For this example, we're going to write a simple momentum script.  When the 
 # stock goes up quickly, we're going to buy; when it goes down quickly, we're
 # going to sell.  Hopefully we'll ride the waves.
-from datetime import timedelta
+import os
+import tempfile
+import time
 
 import pandas as pd
 import talib
-# To run an algorithm in Catalyst, you need two functions: initialize and
-# handle_data.
 from logbook import Logger
-from talib.common import MA_Type
 
 from catalyst import run_algorithm
-from catalyst.api import symbol, record, order_target_percent, \
+from catalyst.api import symbol, record, order_target_percent, get_open_orders
-    get_open_orders
+from catalyst.exchange.stats_utils import extract_transactions
 # We give a name to the algorithm which Catalyst will use to persist its state.
 # In this example, Catalyst will create the `.catalyst/data/live_algos`
 # directory. If we stop and start the algorithm, Catalyst will resume its
 # state using the files included in the folder.
-from catalyst.exchange.stats_utils import extract_transactions, trend_direction
+from catalyst.utils.paths import ensure_directory
 
-algo_namespace = 'momentum'
+NAMESPACE = 'mean_reversion_simple'
-log = Logger(algo_namespace)
+log = Logger(NAMESPACE)
 
 
+# To run an algorithm in Catalyst, you need two functions: initialize and
+# handle_data.
+
 def initialize(context):
     # This initialize function sets any data or variables that you'll use in
     # your algorithm.  For instance, you'll want to define the trading pair (or
@@ -30,10 +32,16 @@ def initialize(context):
     # parameters or values you're going to use.
 
     # In our example, we're looking at Ether in USD Tether.
-    context.eth_btc = symbol('etc_usdt')
+    context.neo_eth = symbol('neo_eth')
     context.base_price = None
     context.current_day = None
 
+    context.RSI_OVERSOLD = 50
+    context.RSI_OVERBOUGHT = 80
+    context.CANDLE_SIZE = '5T'
+
+    context.start_time = time.time()
+
 
 def handle_data(context, data):
     # This handle_data function is where the real work is done.  Our data is
@@ -50,17 +58,17 @@ def handle_data(context, data):
         context.current_day = today
 
     # We're computing the volume-weighted-average-price of the security
-    # defined above, in the context.eth_btc variable.  For this example, we're 
+    # defined above, in the context.neo_eth variable.  For this example, we're 
     # using three bars on the 15 min bars.
 
     # The frequency attribute determine the bar size. We use this convention
     # for the frequency alias:
     # http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases
     prices = data.history(
-        context.eth_btc,
+        context.neo_eth,
         fields='close',
         bar_count=50,
-        frequency='15T'
+        frequency=context.CANDLE_SIZE
     )
 
     # Ta-lib calculates various technical indicator based on price and
@@ -72,7 +80,7 @@ def handle_data(context, data):
     # We need a variable for the current price of the security to compare to
     # the average. Since we are requesting two fields, data.current()
     # returns a DataFrame with
-    current = data.current(context.eth_btc, fields=['close', 'volume'])
+    current = data.current(context.neo_eth, fields=['close', 'volume'])
     price = current['close']
 
     # If base_price is not set, we use the current value. This is the
@@ -101,42 +109,51 @@ def handle_data(context, data):
 
     # Since we are using limit orders, some orders may not execute immediately
     # we wait until all orders are executed before considering more trades.
-    orders = get_open_orders(context.eth_btc)
+    orders = get_open_orders(context.neo_eth)
     if len(orders) > 0:
         return
 
     # Exit if we cannot trade
-    if not data.can_trade(context.eth_btc):
+    if not data.can_trade(context.neo_eth):
         return
 
     # Another powerful built-in feature of the Catalyst backtester is the
     # portfolio object.  The portfolio object tracks your positions, cash,
     # cost basis of specific holdings, and more.  In this line, we calculate
     # how long or short our position is at this minute.   
-    pos_amount = context.portfolio.positions[context.eth_btc].amount
+    pos_amount = context.portfolio.positions[context.neo_eth].amount
 
-    if rsi[-1] <= 30 and pos_amount == 0:
+    if rsi[-1] <= context.RSI_OVERSOLD and pos_amount == 0:
         log.info(
             '{}: buying - price: {}, rsi: {}'.format(
                 data.current_dt, price, rsi[-1]
             )
         )
-        order_target_percent(context.eth_btc, 1)
+        # Set a style for limit orders,
+        limit_price = price * 1.005
+        order_target_percent(
+            context.neo_eth, 1, limit_price=limit_price
+        )
         context.traded_today = True
 
-    elif rsi[-1] >= 80 and pos_amount > 0:
+    elif rsi[-1] >= context.RSI_OVERBOUGHT and pos_amount > 0:
         log.info(
             '{}: selling - price: {}, rsi: {}'.format(
                 data.current_dt, price, rsi[-1]
             )
         )
-        order_target_percent(context.eth_btc, 0)
+        limit_price = price * 0.995
+        order_target_percent(
+            context.neo_eth, 0, limit_price=limit_price
+        )
         context.traded_today = True
 
 
 def analyze(context=None, perf=None):
-    import matplotlib.pyplot as plt
+    end = time.time()
+    log.info('elapsed time: {}'.format(end - context.start_time))
 
+    import matplotlib.pyplot as plt
     # The base currency of the algo exchange
     base_currency = context.exchanges.values()[0].base_currency.upper()
 
@@ -150,7 +167,7 @@ def analyze(context=None, perf=None):
     perf.loc[:, 'price'].plot(ax=ax2, label='Price')
 
     ax2.set_ylabel('{asset} ({base})'.format(
-        asset=context.eth_btc.symbol, base=base_currency
+        asset=context.neo_eth.symbol, base=base_currency
     ))
 
     transaction_df = extract_transactions(perf)
@@ -159,7 +176,7 @@ def analyze(context=None, perf=None):
         sell_df = transaction_df[transaction_df['amount'] < 0]
         ax2.scatter(
             buy_df.index.to_pydatetime(),
-            perf.loc[buy_df.index, 'price'],
+            perf.loc[buy_df.index.floor('1 min'), 'price'],
             marker='^',
             s=100,
             c='green',
@@ -167,7 +184,7 @@ def analyze(context=None, perf=None):
         )
         ax2.scatter(
             sell_df.index.to_pydatetime(),
-            perf.loc[sell_df.index, 'price'],
+            perf.loc[sell_df.index.floor('1 min'), 'price'],
             marker='v',
             s=100,
             c='red',
@@ -194,7 +211,7 @@ def analyze(context=None, perf=None):
     if not transaction_df.empty:
         ax6.scatter(
             buy_df.index.to_pydatetime(),
-            perf.loc[buy_df.index, 'rsi'],
+            perf.loc[buy_df.index.floor('1 min'), 'rsi'],
             marker='^',
             s=100,
             c='green',
@@ -202,7 +219,7 @@ def analyze(context=None, perf=None):
         )
         ax6.scatter(
             sell_df.index.to_pydatetime(),
-            perf.loc[sell_df.index, 'rsi'],
+            perf.loc[sell_df.index.floor('1 min'), 'rsi'],
             marker='v',
             s=100,
             c='red',
@@ -221,28 +238,38 @@ if __name__ == '__main__':
     MODE = 'backtest'
 
     if MODE == 'backtest':
-        # catalyst run -f catalyst/examples/mean_reversion_simple.py -x poloniex -s 2017-7-1 -e 2017-7-31 -c usdt -n mean-reversion --data-frequency minute --capital-base 10000
+        folder = os.path.join(
+            tempfile.gettempdir(), 'catalyst', NAMESPACE
+        )
+        ensure_directory(folder)
+
+        timestr = time.strftime('%Y%m%d-%H%M%S')
+        out = os.path.join(folder, '{}.p'.format(timestr))
+        # catalyst run -f catalyst/examples/mean_reversion_simple.py -x poloniex -s 2017-10-1 -e 2017-11-10 -c usdt -n mean-reversion --data-frequency minute --capital-base 10000
         run_algorithm(
             capital_base=10000,
             data_frequency='minute',
             initialize=initialize,
             handle_data=handle_data,
             analyze=analyze,
-            exchange_name='poloniex',
+            exchange_name='bitfinex',
-            algo_namespace=algo_namespace,
+            algo_namespace=NAMESPACE,
-            base_currency='usdt',
+            base_currency='usd',
-            start=pd.to_datetime('2017-7-1', utc=True),
+            start=pd.to_datetime('2017-10-01', utc=True),
-            end=pd.to_datetime('2017-7-31', utc=True),
+            end=pd.to_datetime('2017-11-10', utc=True),
+            output=out
         )
+        log.info('saved perf stats: {}'.format(out))
 
     elif MODE == 'live':
         run_algorithm(
+            capital_base=0.5,
             initialize=initialize,
             handle_data=handle_data,
             analyze=analyze,
-            exchange_name='poloniex',
+            exchange_name='bittrex',
             live=True,
-            algo_namespace=algo_namespace,
+            algo_namespace=NAMESPACE,
-            base_currency='usdt',
+            base_currency='eth',
-            live_graph=True
+            live_graph=False
         )

catalyst/examples/rsi_profit_target.py

@@ -250,27 +250,27 @@ def analyze(context=None, results=None):
     pass
 
 
-run_algorithm(
-    initialize=initialize,
-    handle_data=handle_data,
-    analyze=analyze,
-    exchange_name='bittrex',
-    live=True,
-    algo_namespace=algo_namespace,
-    base_currency='btc',
-    live_graph=False
-)
-
-# Backtest
 # run_algorithm(
-#     capital_base=0.5,
-#     data_frequency='minute',
 #     initialize=initialize,
 #     handle_data=handle_data,
 #     analyze=analyze,
-#     exchange_name='poloniex',
+#     exchange_name='bittrex',
+#     live=True,
 #     algo_namespace=algo_namespace,
 #     base_currency='btc',
-#     start=pd.to_datetime('2017-9-1', utc=True),
+#     live_graph=False
-#     end=pd.to_datetime('2017-10-1', utc=True),
 # )
+
+# Backtest
+run_algorithm(
+    capital_base=0.5,
+    data_frequency='minute',
+    initialize=initialize,
+    handle_data=handle_data,
+    analyze=analyze,
+    exchange_name='poloniex',
+    algo_namespace=algo_namespace,
+    base_currency='btc',
+    start=pd.to_datetime('2017-9-1', utc=True),
+    end=pd.to_datetime('2017-10-1', utc=True),
+)

catalyst/examples/simple_loop.py

@@ -2,12 +2,15 @@ import talib
 import pandas as pd
 
 from catalyst import run_algorithm
-from catalyst.api import symbol
+from catalyst.api import symbol, record
+from catalyst.exchange.stats_utils import get_pretty_stats, \
+    extract_transactions
 
 
 def initialize(context):
     print('initializing')
-    context.asset = symbol('swift_btc')
+    context.asset = symbol('neo_usd')
+    context.base_price = None
 
 
 def handle_data(context, data):
@@ -20,26 +23,104 @@ def handle_data(context, data):
         prices = data.history(
             context.asset,
             fields='price',
-            bar_count=15,
+            bar_count=14,
-            frequency='1D'
+            frequency='15T'
         )
         rsi = talib.RSI(prices.values, timeperiod=14)[-1]
         print('got rsi: {}'.format(rsi))
     except Exception as e:
         print(e)
 
+    # If base_price is not set, we use the current value. This is the
+    # price at the first bar which we reference to calculate price_change.
+    if context.base_price is None:
+        context.base_price = price
+
+    price_change = (price - context.base_price) / context.base_price
+    cash = context.portfolio.cash
+
+    # Now that we've collected all current data for this frame, we use
+    # the record() method to save it. This data will be available as
+    # a parameter of the analyze() function for further analysis.
+    record(
+        price=price,
+        price_change=price_change,
+        cash=cash
+    )
+
+
+def analyze(context, perf):
+    import matplotlib.pyplot as plt
+    print('the stats: {}'.format(get_pretty_stats(perf)))
+
+    # The base currency of the algo exchange
+    base_currency = context.exchanges.values()[0].base_currency.upper()
+
+    # Plot the portfolio value over time.
+    ax1 = plt.subplot(611)
+    perf.loc[:, 'portfolio_value'].plot(ax=ax1)
+    ax1.set_ylabel('Portfolio Value ({})'.format(base_currency))
+
+    # Plot the price increase or decrease over time.
+    ax2 = plt.subplot(612, sharex=ax1)
+    perf.loc[:, 'price'].plot(ax=ax2, label='Price')
+
+    ax2.set_ylabel('{asset} ({base})'.format(
+        asset=context.asset.symbol, base=base_currency
+    ))
+
+    transaction_df = extract_transactions(perf)
+    if not transaction_df.empty:
+        buy_df = transaction_df[transaction_df['amount'] > 0]
+        sell_df = transaction_df[transaction_df['amount'] < 0]
+        ax2.scatter(
+            buy_df.index.to_pydatetime(),
+            perf.loc[buy_df.index, 'price'],
+            marker='^',
+            s=100,
+            c='green',
+            label=''
+        )
+        ax2.scatter(
+            sell_df.index.to_pydatetime(),
+            perf.loc[sell_df.index, 'price'],
+            marker='v',
+            s=100,
+            c='red',
+            label=''
+        )
+
+    ax4 = plt.subplot(613, sharex=ax1)
+    perf.loc[:, 'cash'].plot(
+        ax=ax4, label='Base Currency ({})'.format(base_currency)
+    )
+    ax4.set_ylabel('Cash ({})'.format(base_currency))
+
+    perf['algorithm'] = perf.loc[:, 'algorithm_period_return']
+
+    ax5 = plt.subplot(614, sharex=ax1)
+    perf.loc[:, ['algorithm', 'price_change']].plot(ax=ax5)
+    ax5.set_ylabel('Percent Change')
+
+    plt.legend(loc=3)
+
+    # Show the plot.
+    plt.gcf().set_size_inches(18, 8)
+    plt.show()
+    pass
+
 
 run_algorithm(
     capital_base=250,
-    start=pd.to_datetime('2015-4-1', utc=True),
+    start=pd.to_datetime('2017-11-1 0:00', utc=True),
-    end=pd.to_datetime('2017-11-1', utc=True),
+    end=pd.to_datetime('2017-11-10 23:59', utc=True),
     data_frequency='daily',
     initialize=initialize,
     handle_data=handle_data,
-    analyze=None,
+    analyze=analyze,
-    exchange_name='bittrex',
+    exchange_name='bitfinex',
     algo_namespace='simple_loop',
-    base_currency='btc'
+    base_currency='usd'
 )
 # run_algorithm(
 #     initialize=initialize,

catalyst/examples/simple_universe.py

@@ -108,7 +108,7 @@ def fill(series):
 
 
 if __name__ == '__main__':
-    start_date = pd.to_datetime('2017-01-01', utc=True)
+    start_date = pd.to_datetime('2017-11-10', utc=True)
     end_date = pd.to_datetime('2017-11-13', utc=True)
 
     performance = run_algorithm(start=start_date, end=end_date,
@@ -116,7 +116,7 @@ if __name__ == '__main__':
                                 initialize=initialize,
                                 handle_data=handle_data,
                                 analyze=analyze,
-                                exchange_name='poloniex',
+                                exchange_name='bitfinex',
                                 data_frequency='minute',
                                 base_currency='btc',
                                 live=False,

catalyst/examples/talib_simple.py

@@ -0,0 +1,364 @@
+# Run Command
+# catalyst run --start 2017-1-1 --end 2017-11-1 -o talib_simple.pickle -f talib_simple.py -x poloniex
+# 
+# Description
+# Simple TALib Example showing how to use various indicators in you strategy
+# Based loosly on https://github.com/mellertson/talib-macd-example/blob/master/talib-macd-matplotlib-example.py
+
+import os
+
+import matplotlib.pyplot as plt
+import numpy as np
+import pandas as pd
+import talib as ta
+from logbook import Logger
+from matplotlib.dates import date2num
+from matplotlib.finance import candlestick_ohlc
+
+from catalyst import run_algorithm
+from catalyst.api import (
+    order,
+    order_target_percent,
+    symbol,
+)
+from catalyst.exchange.stats_utils import get_pretty_stats
+
+algo_namespace = 'talib_sample'
+log = Logger(algo_namespace)
+
+
+def initialize(context):
+    log.info('Starting TALib Simple Example')
+
+    context.ASSET_NAME = 'BTC_USDT'
+    context.asset = symbol(context.ASSET_NAME)
+
+    context.ORDER_SIZE = 10
+    context.SLIPPAGE_ALLOWED = 0.05
+
+    context.swallow_errors = True
+    context.errors = []
+
+    # Bars to look at per iteration should be bigger than SMA_SLOW
+    context.BARS = 365
+    context.COUNT = 0
+
+    # Technical Analysis Settings
+    context.SMA_FAST = 50
+    context.SMA_SLOW = 100
+    context.RSI_PERIOD = 14
+    context.RSI_OVER_BOUGHT = 80
+    context.RSI_OVER_SOLD = 20
+    context.RSI_AVG_PERIOD = 15
+    context.MACD_FAST = 12
+    context.MACD_SLOW = 26
+    context.MACD_SIGNAL = 9
+    context.STOCH_K = 14
+    context.STOCH_D = 3
+    context.STOCH_OVER_BOUGHT = 80
+    context.STOCH_OVER_SOLD = 20
+
+    pass
+
+
+def _handle_data(context, data):
+    # Get price, open, high, low, close
+    prices = data.history(
+        context.asset,
+        bar_count=context.BARS,
+        fields=['price', 'open', 'high', 'low', 'close'],
+        frequency='1d')
+
+    # Create a analysis data frame
+    analysis = pd.DataFrame(index=prices.index)
+
+    # SMA FAST
+    analysis['sma_f'] = ta.SMA(prices.close.as_matrix(), context.SMA_FAST)
+    # SMA SLOW
+    analysis['sma_s'] = ta.SMA(prices.close.as_matrix(), context.SMA_SLOW)
+
+    # Relative Strength Index
+    analysis['rsi'] = ta.RSI(prices.close.as_matrix(), context.RSI_PERIOD)
+    # RSI SMA
+    analysis['sma_r'] = ta.SMA(analysis.rsi.as_matrix(),
+                               context.RSI_AVG_PERIOD)
+
+    # MACD, MACD Signal, MACD Histogram
+    analysis['macd'], analysis['macdSignal'], analysis['macdHist'] = ta.MACD(
+        prices.close.as_matrix(), fastperiod=context.MACD_FAST,
+        slowperiod=context.MACD_SLOW, signalperiod=context.MACD_SIGNAL)
+
+    # Stochastics %K %D 
+    # %K = (Current Close - Lowest Low)/(Highest High - Lowest Low) * 100
+    # %D = 3-day SMA of %K
+    analysis['stoch_k'], analysis['stoch_d'] = ta.STOCH(
+        prices.high.as_matrix(), prices.low.as_matrix(),
+        prices.close.as_matrix(), slowk_period=context.STOCH_K,
+        slowd_period=context.STOCH_D)
+
+    # SMA FAST over SLOW Crossover
+    analysis['sma_test'] = np.where(analysis.sma_f > analysis.sma_s, 1, 0)
+
+    # MACD over Signal Crossover
+    analysis['macd_test'] = np.where((analysis.macd > analysis.macdSignal), 1,
+                                     0)
+
+    # Stochastics OVER BOUGHT & Decreasing
+    analysis['stoch_over_bought'] = np.where(
+        (analysis.stoch_k > context.STOCH_OVER_BOUGHT) & (
+            analysis.stoch_k > analysis.stoch_k.shift(1)), 1, 0)
+
+    # Stochastics OVER SOLD & Increasing
+    analysis['stoch_over_sold'] = np.where(
+        (analysis.stoch_k < context.STOCH_OVER_SOLD) & (
+            analysis.stoch_k > analysis.stoch_k.shift(1)), 1, 0)
+
+    # RSI OVER BOUGHT & Decreasing
+    analysis['rsi_over_bought'] = np.where(
+        (analysis.rsi > context.RSI_OVER_BOUGHT) & (
+            analysis.rsi < analysis.rsi.shift(1)), 1, 0)
+
+    # RSI OVER SOLD & Increasing
+    analysis['rsi_over_sold'] = np.where(
+        (analysis.rsi < context.RSI_OVER_SOLD) & (
+            analysis.rsi > analysis.rsi.shift(1)), 1, 0)
+
+    # Save the prices and analysis to send to analyze
+    context.prices = prices
+    context.analysis = analysis
+    context.price = data.current(context.asset, 'price')
+
+    makeOrders(context, analysis)
+
+    # Log the values of this bar
+    logAnalysis(analysis)
+
+
+def handle_data(context, data):
+    log.info('handling bar {}'.format(data.current_dt))
+    try:
+        _handle_data(context, data)
+    except Exception as e:
+        log.warn('aborting the bar on error {}'.format(e))
+        context.errors.append(e)
+
+    log.info('completed bar {}, total execution errors {}'.format(
+        data.current_dt,
+        len(context.errors)
+    ))
+
+    if len(context.errors) > 0:
+        log.info('the errors:\n{}'.format(context.errors))
+
+
+def analyze(context, results):
+    # Save results in CSV file
+    filename = os.path.splitext(os.path.basename('talib_simple'))[0]
+    results.to_csv(filename + '.csv')
+
+    log.info('the daily stats:\n{}'.format(get_pretty_stats(results)))
+    chart(context, context.prices, context.analysis, results)
+    pass
+
+
+def makeOrders(context, analysis):
+    if context.asset in context.portfolio.positions:
+
+        # Current position
+        position = context.portfolio.positions[context.asset]
+
+        if (position == 0):
+            log.info('Position Zero')
+            return
+
+        # Cost Basis
+        cost_basis = position.cost_basis
+
+        log.info(
+            'Holdings: {amount} @ {cost_basis}'.format(
+                amount=position.amount,
+                cost_basis=cost_basis
+            )
+        )
+
+        # Sell when holding and got sell singnal
+        if isSell(context, analysis):
+            profit = (context.price * position.amount) - (
+                cost_basis * position.amount)
+            order_target_percent(
+                asset=context.asset,
+                target=0,
+                limit_price=context.price * (1 - context.SLIPPAGE_ALLOWED),
+            )
+            log.info(
+                'Sold {amount} @ {price} Profit: {profit}'.format(
+                    amount=position.amount,
+                    price=context.price,
+                    profit=profit
+                )
+            )
+        else:
+            log.info('no buy or sell opportunity found')
+    else:
+        # Buy when not holding and got buy signal
+        if isBuy(context, analysis):
+            order(
+                asset=context.asset,
+                amount=context.ORDER_SIZE,
+                limit_price=context.price * (1 + context.SLIPPAGE_ALLOWED)
+            )
+            log.info(
+                'Bought {amount} @ {price}'.format(
+                    amount=context.ORDER_SIZE,
+                    price=context.price
+                )
+            )
+
+
+def isBuy(context, analysis):
+    # Bullish SMA Crossover
+    if (getLast(analysis, 'sma_test') == 1):
+        # Bullish MACD
+        if (getLast(analysis, 'macd_test') == 1):
+            return True
+
+    # # Bullish Stochastics
+    # if(getLast(analysis, 'stoch_over_sold') == 1):
+    #     return True
+
+    # # Bullish RSI
+    # if(getLast(analysis, 'rsi_over_sold') == 1):
+    #     return True
+
+    return False
+
+
+def isSell(context, analysis):
+    # Bearish SMA Crossover
+    if (getLast(analysis, 'sma_test') == 0):
+        # Bearish MACD
+        if (getLast(analysis, 'macd_test') == 0):
+            return True
+
+    # # Bearish Stochastics
+    # if(getLast(analysis, 'stoch_over_bought') == 0):
+    #     return True
+
+    # # Bearish RSI
+    # if(getLast(analysis, 'rsi_over_bought') == 0):
+    #     return True
+
+    return False
+
+
+def chart(context, prices, analysis, results):
+    results.portfolio_value.plot()
+
+    # Data for matplotlib finance plot
+    dates = date2num(prices.index.to_pydatetime())
+
+    # Create the Open High Low Close Tuple
+    prices_ohlc = [tuple([dates[i],
+                          prices.open[i],
+                          prices.high[i],
+                          prices.low[i],
+                          prices.close[i]]) for i in range(len(dates))]
+
+    fig = plt.figure(figsize=(14, 18))
+
+    # Draw the candle sticks
+    ax1 = fig.add_subplot(411)
+    ax1.set_ylabel(context.ASSET_NAME, size=20)
+    candlestick_ohlc(ax1, prices_ohlc, width=0.4, colorup='g', colordown='r')
+
+    # Draw Moving Averages
+    analysis.sma_f.plot(ax=ax1, c='r')
+    analysis.sma_s.plot(ax=ax1, c='g')
+
+    # RSI
+    ax2 = fig.add_subplot(412)
+    ax2.set_ylabel('RSI', size=12)
+    analysis.rsi.plot(ax=ax2, c='g',
+                      label='Period: ' + str(context.RSI_PERIOD))
+    analysis.sma_r.plot(ax=ax2, c='r',
+                        label='MA: ' + str(context.RSI_AVG_PERIOD))
+    ax2.axhline(y=30, c='b')
+    ax2.axhline(y=50, c='black')
+    ax2.axhline(y=70, c='b')
+    ax2.set_ylim([0, 100])
+    handles, labels = ax2.get_legend_handles_labels()
+    ax2.legend(handles, labels)
+
+    # Draw MACD computed with Talib
+    ax3 = fig.add_subplot(413)
+    ax3.set_ylabel('MACD: ' + str(context.MACD_FAST) + ', ' + str(
+        context.MACD_SLOW) + ', ' + str(context.MACD_SIGNAL), size=12)
+    analysis.macd.plot(ax=ax3, color='b', label='Macd')
+    analysis.macdSignal.plot(ax=ax3, color='g', label='Signal')
+    analysis.macdHist.plot(ax=ax3, color='r', label='Hist')
+    ax3.axhline(0, lw=2, color='0')
+    handles, labels = ax3.get_legend_handles_labels()
+    ax3.legend(handles, labels)
+
+    # Stochastic plot
+    ax4 = fig.add_subplot(414)
+    ax4.set_ylabel('Stoch (k,d)', size=12)
+    analysis.stoch_k.plot(ax=ax4, label='stoch_k:' + str(context.STOCH_K),
+                          color='r')
+    analysis.stoch_d.plot(ax=ax4, label='stoch_d:' + str(context.STOCH_D),
+                          color='g')
+    handles, labels = ax4.get_legend_handles_labels()
+    ax4.legend(handles, labels)
+    ax4.axhline(y=20, c='b')
+    ax4.axhline(y=50, c='black')
+    ax4.axhline(y=80, c='b')
+
+    plt.show()
+
+
+def logAnalysis(analysis):
+    # Log only the last value in the array
+    log.info('- sma_f:          {:.2f}'.format(getLast(analysis, 'sma_f')))
+    log.info('- sma_s:          {:.2f}'.format(getLast(analysis, 'sma_s')))
+
+    log.info('- rsi:            {:.2f}'.format(getLast(analysis, 'rsi')))
+    log.info('- sma_r:          {:.2f}'.format(getLast(analysis, 'sma_r')))
+
+    log.info('- macd:           {:.2f}'.format(getLast(analysis, 'macd')))
+    log.info(
+        '- macdSignal:     {:.2f}'.format(getLast(analysis, 'macdSignal')))
+    log.info('- macdHist:       {:.2f}'.format(getLast(analysis, 'macdHist')))
+
+    log.info('- stoch_k:        {:.2f}'.format(getLast(analysis, 'stoch_k')))
+    log.info('- stoch_d:        {:.2f}'.format(getLast(analysis, 'stoch_d')))
+
+    log.info('- sma_test:       {}'.format(getLast(analysis, 'sma_test')))
+    log.info('- macd_test:      {}'.format(getLast(analysis, 'macd_test')))
+
+    log.info('- stoch_over_bought:   {}'.format(
+        getLast(analysis, 'stoch_over_bought')))
+    log.info(
+        '- stoch_over_sold:   {}'.format(getLast(analysis, 'stoch_over_sold')))
+
+    log.info('- rsi_over_bought:       {}'.format(
+        getLast(analysis, 'rsi_over_bought')))
+    log.info(
+        '- rsi_over_sold:       {}'.format(getLast(analysis, 'rsi_over_sold')))
+
+
+def getLast(arr, name):
+    return arr[name][arr[name].index[-1]]
+
+
+if __name__ == '__main__':
+    run_algorithm(
+        capital_base=10000,
+        data_frequency='daily',
+        initialize=initialize,
+        handle_data=handle_data,
+        analyze=analyze,
+        exchange_name='poloniex',
+        base_currency='usdt',
+        start=pd.to_datetime('2016-11-1', utc=True),
+        end=pd.to_datetime('2017-11-10', utc=True),
+    )

catalyst/exchange/asset_finder_exchange.py

@@ -41,14 +41,15 @@ class AssetFinderExchange(object):
         SidsNotFound
             When a requested sid is not found and default_none=False.
         """
-        for sid in sids:
+        # for sid in sids:
-            if sid in self._asset_cache:
+        #     if sid in self._asset_cache:
-                log.debug('got asset from cache: {}'.format(sid))
+        #         log.debug('got asset from cache: {}'.format(sid))
-            else:
+        #     else:
-                log.debug('fetching asset: {}'.format(sid))
+        #         log.debug('fetching asset: {}'.format(sid))
         return list()
 
-    def lookup_symbol(self, symbol, exchange, as_of_date=None, fuzzy=False):
+    def lookup_symbol(self, symbol, exchange, data_frequency=None,
+                      as_of_date=None, fuzzy=False):
         """Lookup an asset by symbol.
 
         Parameters
@@ -84,10 +85,15 @@ class AssetFinderExchange(object):
         """
         log.debug('looking up symbol: {} {}'.format(symbol, exchange.name))
 
-        key = ','.join([exchange.name, symbol])
+        if data_frequency is not None:
+            key = ','.join([exchange.name, symbol, data_frequency])
+
+        else:
+            key = ','.join([exchange.name, symbol])
+
         if key in self._asset_cache:
             return self._asset_cache[key]
         else:
-            asset = exchange.get_asset(symbol)
+            asset = exchange.get_asset(symbol, data_frequency)
             self._asset_cache[key] = asset
             return asset

catalyst/exchange/bitfinex/bitfinex.py

@@ -46,8 +46,13 @@ class Bitfinex(Exchange):
         self.secret = secret.encode('UTF-8')
         self.name = 'bitfinex'
         self.color = 'green'
-        self.assets = {}
+
+        self.assets = dict()
         self.load_assets()
+
+        self.local_assets = dict()
+        self.load_assets(is_local=True)
+
         self.base_currency = base_currency
         self._portfolio = portfolio
         self.minute_writer = None
@@ -61,7 +66,7 @@ class Bitfinex(Exchange):
         self.max_requests_per_minute = 80
         self.request_cpt = dict()
 
-        self.bundle = ExchangeBundle(self)
+        self.bundle = ExchangeBundle(self.name)
 
     def _request(self, operation, data, version='v1'):
         payload_object = {

catalyst/exchange/bittrex/bittrex.py

@@ -46,7 +46,10 @@ class Bittrex(Exchange):
         self.assets = dict()
         self.load_assets()
 
-        self.bundle = ExchangeBundle(self)
+        self.local_assets = dict()
+        self.load_assets(is_local=True)
+
+        self.bundle = ExchangeBundle(self.name)
 
     @property
     def account(self):

catalyst/exchange/bundle_utils.py

@@ -6,9 +6,11 @@ from datetime import timedelta, datetime, date
 import numpy as np
 import pandas as pd
 import pytz
+from catalyst.assets._assets import TradingPair
 
 from catalyst.data.bundles.core import download_without_progress
-from catalyst.exchange.exchange_utils import get_exchange_bundles_folder
+from catalyst.exchange.exchange_utils import get_exchange_bundles_folder, \
+    get_exchange_symbols
 
 EXCHANGE_NAMES = ['bitfinex', 'bittrex', 'poloniex']
 API_URL = 'http://data.enigma.co/api/v1'
@@ -317,3 +319,41 @@ def range_in_bundle(asset, start_dt, end_dt, reader):
             has_data = False
 
     return has_data
+
+
+def get_assets(exchange, include_symbols, exclude_symbols):
+    """
+    Get assets from an exchange, including or excluding the specified
+    symbols.
+
+    Parameters
+    ----------
+    exchange: Exchange
+    include_symbols: str
+    exclude_symbols: str
+
+    Returns
+    -------
+    list[TradingPair]
+
+    """
+    if include_symbols is not None:
+        include_symbols_list = include_symbols.split(',')
+
+        return exchange.get_assets(include_symbols_list)
+
+    else:
+        all_assets = exchange.get_assets()
+
+        if exclude_symbols is not None:
+            exclude_symbols_list = exclude_symbols.split(',')
+
+            assets = []
+            for asset in all_assets:
+                if asset.symbol not in exclude_symbols_list:
+                    assets.append(asset)
+
+            return assets
+
+        else:
+            return all_assets

catalyst/exchange/exchange.py

@@ -16,7 +16,7 @@ from catalyst.exchange.exchange_bundle import ExchangeBundle
 from catalyst.exchange.exchange_errors import MismatchingBaseCurrencies, \
     InvalidOrderStyle, BaseCurrencyNotFoundError, SymbolNotFoundOnExchange, \
     PricingDataNotLoadedError, \
-    NoDataAvailableOnExchange
+    NoDataAvailableOnExchange, ExchangeSymbolsNotFound
 from catalyst.exchange.exchange_execution import ExchangeStopLimitOrder, \
     ExchangeLimitOrder, ExchangeStopOrder
 from catalyst.exchange.exchange_portfolio import ExchangePortfolio
@@ -24,7 +24,6 @@ from catalyst.exchange.exchange_utils import get_exchange_symbols, \
     get_frequency, resample_history_df
 from catalyst.finance.order import ORDER_STATUS
 from catalyst.finance.transaction import Transaction
-from catalyst.utils.deprecate import deprecated
 
 log = Logger('Exchange', level=LOG_LEVEL)
 
@@ -34,7 +33,8 @@ class Exchange:
 
     def __init__(self):
         self.name = None
-        self.assets = {}
+        self.assets = dict()
+        self.local_assets = dict()
         self._portfolio = None
         self.minute_writer = None
         self.minute_reader = None
@@ -43,7 +43,7 @@ class Exchange:
         self.num_candles_limit = None
         self.max_requests_per_minute = None
         self.request_cpt = None
-        self.bundle = ExchangeBundle(self)
+        self.bundle = ExchangeBundle(self.name)
 
     @property
     def positions(self):
@@ -174,7 +174,7 @@ class Exchange:
 
         return symbols
 
-    def get_assets(self, symbols=None):
+    def get_assets(self, symbols=None, data_frequency=None):
         """
         The list of markets for the specified symbols.
 
@@ -191,7 +191,7 @@ class Exchange:
 
         if symbols is not None:
             for symbol in symbols:
-                asset = self.get_asset(symbol)
+                asset = self.get_asset(symbol, data_frequency)
                 assets.append(asset)
         else:
             for key in self.assets:
@@ -199,7 +199,19 @@ class Exchange:
 
         return assets
 
-    def get_asset(self, symbol):
+    def _find_asset(self, asset, symbol, data_frequency, is_local=False):
+        assets = self.assets if not is_local else self.local_assets
+
+        for key in assets:
+            if not asset and assets[key].symbol.lower() == symbol.lower() and (
+                        not data_frequency or (
+                                    data_frequency == 'minute' and assets[
+                                key].end_minute is not None)):
+                asset = assets[key]
+
+        return asset
+
+    def get_asset(self, symbol, data_frequency=None):
         """
         The market for the specified symbol.
 
@@ -214,13 +226,17 @@ class Exchange:
         """
         asset = None
 
-        for key in self.assets:
+        log.debug('searching asset {} on the server')
-            if not asset and self.assets[key].symbol.lower() == symbol.lower():
+        asset = self._find_asset(asset, symbol, data_frequency, False)
-                asset = self.assets[key]
+
+        log.debug('asset {} not found on the server, searching local assets')
+        asset = self._find_asset(asset, symbol, data_frequency, True)
 
         if not asset:
+            all_values = list(self.assets.values()) + \
+                         list(self.local_assets.values())
             supported_symbols = [
-                pair.symbol for pair in list(self.assets.values())
+                asset.symbol for asset in all_values
             ]
 
             raise SymbolNotFoundOnExchange(
@@ -231,10 +247,10 @@ class Exchange:
 
         return asset
 
-    def fetch_symbol_map(self):
+    def fetch_symbol_map(self, is_local=False):
-        return get_exchange_symbols(self.name)
+        return get_exchange_symbols(self.name, is_local)
 
-    def load_assets(self):
+    def load_assets(self, is_local=False):
         """
         Populate the 'assets' attribute with a dictionary of Assets.
         The key of the resulting dictionary is the exchange specific
@@ -247,11 +263,15 @@ class Exchange:
         universal symbol. This simple approach avoids maintaining a mapping
         of sids.
 
-        This method can be overridden if an exchange offers equivalent data
+        This method can be omerridden if an exchange offers equivalent data
         via its api.
 
         """
-        symbol_map = self.fetch_symbol_map()
+        try:
+            symbol_map = self.fetch_symbol_map(is_local)
+        except ExchangeSymbolsNotFound:
+            return None
+
         for exchange_symbol in symbol_map:
             asset = symbol_map[exchange_symbol]
 
@@ -303,7 +323,10 @@ class Exchange:
                 exchange_symbol=exchange_symbol
             )
 
-            self.assets[exchange_symbol] = trading_pair
+            if is_local:
+                self.local_assets[exchange_symbol] = trading_pair
+            else:
+                self.assets[exchange_symbol] = trading_pair
 
     def check_open_orders(self):
         """
@@ -468,15 +491,14 @@ class Exchange:
 
         return series
 
-    @deprecated
+    def get_history_window(self,
-    def get_history_window_direct(self,
+                           assets,
-                                  assets,
+                           end_dt,
-                                  end_dt,
+                           bar_count,
-                                  bar_count,
+                           frequency,
-                                  frequency,
+                           field,
-                                  field,
+                           data_frequency=None,
-                                  data_frequency=None,
+                           ffill=True):
-                                  ffill=True):
 
         """
         Public API method that returns a dataframe containing the requested
@@ -514,35 +536,46 @@ class Exchange:
             A dataframe containing the requested data.
 
         """
-        start_dt = get_start_dt(end_dt, bar_count, data_frequency)
+        freq, candle_size, unit, data_frequency = get_frequency(
+            frequency, data_frequency
+        )
+        adj_bar_count = candle_size * bar_count
+        start_dt = get_start_dt(end_dt, adj_bar_count, data_frequency)
 
         # The get_history method supports multiple asset
         candles = self.get_candles(
-            data_frequency=frequency,
+            freq=freq,
             assets=assets,
             bar_count=bar_count,
             start_dt=start_dt,
             end_dt=end_dt
         )
-        candle_series = self.get_series_from_candles(
-            candles=candles,
-            start_dt=start_dt,
-            end_dt=end_dt,
-            data_frequency=frequency,
-            field=field,
-        )
 
-        df = pd.DataFrame(candle_series)
+        series = dict()
+        for asset in candles:
+            asset_series = self.get_series_from_candles(
+                candles=candles[asset],
+                start_dt=start_dt,
+                end_dt=end_dt,
+                data_frequency=frequency,
+                field=field,
+            )
+            series[asset] = asset_series
+
+        df = pd.DataFrame(series)
+        df.dropna(inplace=True)
+
         return df
 
-    def get_history_window(self,
+    def get_history_window_with_bundle(self,
-                           assets,
+                                       assets,
-                           end_dt,
+                                       end_dt,
-                           bar_count,
+                                       bar_count,
-                           frequency,
+                                       frequency,
-                           field,
+                                       field,
-                           data_frequency=None,
+                                       data_frequency=None,
-                           ffill=True):
+                                       ffill=True,
+                                       force_auto_ingest=False):
 
         """
         Public API method that returns a dataframe containing the requested
@@ -590,7 +623,8 @@ class Exchange:
                 end_dt=end_dt,
                 bar_count=adj_bar_count,
                 field=field,
-                data_frequency=data_frequency
+                data_frequency=data_frequency,
+                force_auto_ingest=force_auto_ingest
             )
         except (PricingDataNotLoadedError, NoDataAvailableOnExchange):
             series = dict()

catalyst/exchange/exchange_algorithm.py

@@ -114,9 +114,12 @@ class ExchangeTradingAlgorithmBase(TradingAlgorithm):
         else:
             exchange = self.exchanges[exchange_name]
 
+        data_frequency = self.data_frequency \
+            if self.sim_params.arena == 'backtest' else None
         return self.asset_finder.lookup_symbol(
             symbol=symbol_str,
             exchange=exchange,
+            data_frequency=data_frequency,
             as_of_date=_lookup_date
         )
 
@@ -245,19 +248,42 @@ class ExchangeTradingAlgorithmBacktest(ExchangeTradingAlgorithmBase):
         else:
             return MarketOrder()
 
+    def is_last_frame_of_day(self, data):
+        # TODO: adjust here to support more intervals
+        next_frame_dt = data.current_dt + timedelta(minutes=1)
+        if next_frame_dt.date() > data.current_dt.date():
+            return True
+        else:
+            return False
+
     def handle_data(self, data):
         super(ExchangeTradingAlgorithmBacktest, self).handle_data(data)
 
-        minute_stats = self.prepare_period_stats(
+        if self.data_frequency == 'minute':
-            data.current_dt, data.current_dt + timedelta(minutes=1))
+            frame_stats = self.prepare_period_stats(
-        self.frame_stats.append(minute_stats)
+                data.current_dt, data.current_dt + timedelta(minutes=1)
+            )
+            self.frame_stats.append(frame_stats)
 
-    def analyze(self, perf):
+    def _create_stats_df(self):
         stats = pd.DataFrame(self.frame_stats)
         stats.set_index('period_close', inplace=True, drop=False)
+        return stats
 
+    def analyze(self, perf):
+        stats = self._create_stats_df() if self.data_frequency == 'minute' \
+            else perf
         super(ExchangeTradingAlgorithmBacktest, self).analyze(stats)
 
+    def run(self, data=None, overwrite_sim_params=True):
+        perf = super(ExchangeTradingAlgorithmBacktest, self).run(
+            data, overwrite_sim_params
+        )
+        # Rebuilding the stats to support minute data
+        stats = self._create_stats_df() if self.data_frequency == 'minute' \
+            else perf
+        return stats
+
 
 class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
     def __init__(self, *args, **kwargs):
@@ -265,7 +291,7 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
         self.live_graph = kwargs.pop('live_graph', None)
 
         self._clock = None
-        self.minute_stats = deque(maxlen=60)
+        self.frame_stats = deque(maxlen=60)
 
         self.pnl_stats = get_algo_df(self.algo_namespace, 'pnl_stats')
 
@@ -534,8 +560,9 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
         )
         self.exposure_stats = pd.concat([self.exposure_stats, df])
 
-        save_algo_df(self.algo_namespace, 'exposure_stats',
+        save_algo_df(
-                     self.exposure_stats)
+            self.algo_namespace, 'exposure_stats', self.exposure_stats
+        )
 
     def handle_data(self, data):
         """
@@ -552,8 +579,11 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
         self._synchronize_portfolio()
 
         transactions = self._check_open_orders()
-        for transaction in transactions:
+        if len(transactions) > 0:
-            self.perf_tracker.process_transaction(transaction)
+            for transaction in transactions:
+                self.perf_tracker.process_transaction(transaction)
+
+            self.perf_tracker.update_performance()
 
         if self._handle_data:
             self._handle_data(self, data)
@@ -568,22 +598,22 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
             # Performance tracker and keep only minute and cumulative
             self.perf_tracker.update_performance()
 
-            minute_stats = self.prepare_period_stats(
+            frame_stats = self.prepare_period_stats(
                 data.current_dt, data.current_dt + timedelta(minutes=1))
 
             # Saving the last hour in memory
-            self.minute_stats.append(minute_stats)
+            self.frame_stats.append(frame_stats)
 
-            self.add_pnl_stats(minute_stats)
+            self.add_pnl_stats(frame_stats)
             if self.recorded_vars:
-                self.add_custom_signals_stats(minute_stats)
+                self.add_custom_signals_stats(frame_stats)
                 recorded_cols = list(self.recorded_vars.keys())
             else:
                 recorded_cols = None
 
-            self.add_exposure_stats(minute_stats)
+            self.add_exposure_stats(frame_stats)
 
-            print_df = pd.DataFrame(list(self.minute_stats))
+            print_df = pd.DataFrame(list(self.frame_stats))
             log.info(
                 'statistics for the last {stats_minutes} minutes:\n{stats}'.format(
                     stats_minutes=self.stats_minutes,

catalyst/exchange/exchange_bundle.py

@@ -1,13 +1,15 @@
 import os
+import os
 import shutil
+from datetime import datetime, timedelta
 from functools import partial
 from itertools import chain
 from operator import is_not
 
 import numpy as np
 import pandas as pd
+import pytz
 from catalyst.assets._assets import TradingPair
-from datetime import datetime, timedelta
 from logbook import Logger
 from pytz import UTC
 from six import itervalues
@@ -19,14 +21,17 @@ from catalyst.data.minute_bars import BcolzMinuteOverlappingData, \
     BcolzMinuteBarMetadata
 from catalyst.exchange.bundle_utils import range_in_bundle, \
     get_bcolz_chunk, get_month_start_end, \
-    get_year_start_end, get_df_from_arrays, get_start_dt, get_period_label
+    get_year_start_end, get_df_from_arrays, get_start_dt, get_period_label, \
+    get_delta, get_assets
 from catalyst.exchange.exchange_bcolz import BcolzExchangeBarReader, \
     BcolzExchangeBarWriter
 from catalyst.exchange.exchange_errors import EmptyValuesInBundleError, \
     TempBundleNotFoundError, \
     NoDataAvailableOnExchange, \
-    PricingDataNotLoadedError
+    PricingDataNotLoadedError, DataCorruptionError, ExchangeSymbolsNotFound, \
-from catalyst.exchange.exchange_utils import get_exchange_folder
+    PricingDataValueError
+from catalyst.exchange.exchange_utils import get_exchange_folder, \
+    get_exchange_symbols, save_exchange_symbols
 from catalyst.utils.cli import maybe_show_progress
 from catalyst.utils.paths import ensure_directory
 
@@ -40,23 +45,14 @@ def _cachpath(symbol, type_):
 
 
 class ExchangeBundle:
-    def __init__(self, exchange):
+    def __init__(self, exchange_name):
-        self.exchange = exchange
+        self.exchange_name = exchange_name
         self.minutes_per_day = 1440
         self.default_ohlc_ratio = 1000000
         self._writers = dict()
         self._readers = dict()
         self.calendar = get_calendar('OPEN')
-
+        self.exchange = None
-    def get_assets(self, include_symbols, exclude_symbols):
-        # TODO: filter exclude symbols assets
-        if include_symbols is not None:
-            include_symbols_list = include_symbols.split(',')
-
-            return self.exchange.get_assets(include_symbols_list)
-
-        else:
-            return self.exchange.get_assets()
 
     def get_reader(self, data_frequency, path=None):
         """
@@ -68,7 +64,7 @@ class ExchangeBundle:
 
         """
         if path is None:
-            root = get_exchange_folder(self.exchange.name)
+            root = get_exchange_folder(self.exchange_name)
             path = BUNDLE_NAME_TEMPLATE.format(
                 root=root,
                 frequency=data_frequency
@@ -99,7 +95,7 @@ class ExchangeBundle:
         BcolzMinuteBarWriter | BcolzDailyBarWriter
 
         """
-        root = get_exchange_folder(self.exchange.name)
+        root = get_exchange_folder(self.exchange_name)
         path = BUNDLE_NAME_TEMPLATE.format(
             root=root,
             frequency=data_frequency
@@ -157,9 +153,9 @@ class ExchangeBundle:
         ----------
         assets: list[TradingPair]
             The assets is scope.
-        start_dt: datetime
+        start_dt: pd.Timestamp
             The chunk start date.
-        end_dt: datetime
+        end_dt: pd.Timestamp
             The chunk end date.
         data_frequency: str
 
@@ -208,8 +204,8 @@ class ExchangeBundle:
 
         Parameters
         ----------
-        start_dt: datetime
+        start_dt: pd.Timestamp
-        end_dt: datetime
+        end_dt: pd.Timestamp
         data_frequency: str
 
         Returns
@@ -366,7 +362,7 @@ class ExchangeBundle:
 
         # Download and extract the bundle
         path = get_bcolz_chunk(
-            exchange_name=self.exchange.name,
+            exchange_name=self.exchange_name,
             symbol=asset.symbol,
             data_frequency=data_frequency,
             period=period
@@ -435,14 +431,14 @@ class ExchangeBundle:
 
         Parameters
         ----------
-        start: datetime
+        start: pd.Timestamp
-        end: datetime
+        end: pd.Timestamp
         assets: list[TradingPair]
         data_frequency: str
 
         Returns
         -------
-        datetime, datetime
+        pd.Timestamp, pd.Timestamp
         """
         earliest_trade = None
         last_entry = None
@@ -469,7 +465,8 @@ class ExchangeBundle:
             start = earliest_trade
 
         if end is None or (last_entry is not None and end > last_entry):
-            end = last_entry
+            end = last_entry.replace(minute=59, hour=23) \
+                if data_frequency == 'minute' else last_entry
 
         if end is None or start is None or start > end:
             raise NoDataAvailableOnExchange(
@@ -489,8 +486,8 @@ class ExchangeBundle:
         ----------
         assets: list[TradingPair]
         data_frequency: str
-        start_dt: datetime
+        start_dt: pd.Timestamp
-        end_dt: datetime
+        end_dt: pd.Timestamp
 
         Returns
         -------
@@ -573,8 +570,8 @@ class ExchangeBundle:
         ----------
         assets: list[TradingPair]
         data_frequency: str
-        start_dt: datetime
+        start_dt: pd.Timestamp
-        end_dt: datetime
+        end_dt: pd.Timestamp
         show_progress: bool
         show_breakdown: bool
 
@@ -610,7 +607,7 @@ class ExchangeBundle:
                         show_progress,
                         label='Ingesting {frequency} price data for '
                               '{symbol} on {exchange}'.format(
-                            exchange=self.exchange.name,
+                            exchange=self.exchange_name,
                             frequency=data_frequency,
                             symbol=asset.symbol
                         )) as it:
@@ -635,7 +632,7 @@ class ExchangeBundle:
                     show_progress,
                     label='Ingesting {frequency} price data on '
                           '{exchange}'.format(
-                        exchange=self.exchange.name,
+                        exchange=self.exchange_name,
                         frequency=data_frequency,
                     )) as it:
                 for chunk in it:
@@ -653,8 +650,138 @@ class ExchangeBundle:
                 '\n'.join(problems)
             ))
 
+    def ingest_csv(self, path, data_frequency, empty_rows_behavior='strip',
+                   duplicates_threshold=100):
+        """
+        Ingest price data from a CSV file.
+
+        Parameters
+        ----------
+        path: str
+        data_frequency: str
+
+        Returns
+        -------
+        list[str]
+            A list of potential problems detected during ingestion.
+
+        """
+        log.info('ingesting csv file: {}'.format(path))
+        try:
+            symbols_def = get_exchange_symbols(
+                self.exchange_name, is_local=True
+            )
+        except ExchangeSymbolsNotFound:
+            symbols_def = dict()
+
+        problems = []
+        df = pd.read_csv(
+            path,
+            header=0,
+            sep=',',
+            dtype=dict(
+                symbol=np.object_,
+                last_traded=np.object_,
+                open=np.float64,
+                high=np.float64,
+                close=np.float64,
+                volume=np.float64
+            ),
+            parse_dates=['last_traded'],
+            index_col=None
+        )
+        min_start_dt = None
+        max_end_dt = None
+
+        symbols = df['symbol'].unique()
+
+        # Apply the timezone before creating an index for simplicity
+        df['last_traded'] = df['last_traded'].dt.tz_localize(pytz.UTC)
+        df.set_index(['symbol', 'last_traded'], drop=True, inplace=True)
+
+        assets = dict()
+        for symbol in symbols:
+            start_dt = df.index.get_level_values(1).min()
+            end_dt = df.index.get_level_values(1).max()
+            end_dt_key = 'end_{}'.format(data_frequency)
+
+            if symbol is symbols_def:
+                symbol_def = symbols_def[symbol]
+
+                start_dt = symbol_def['start_date'] \
+                    if symbol_def['start_date'] < start_dt else start_dt
+
+                end_dt = symbol_def[end_dt_key] \
+                    if symbol_def[end_dt_key] > end_dt else end_dt
+
+                end_daily = end_dt \
+                    if data_frequency == 'daily' else symbol_def['end_daily']
+
+                end_minute = end_dt \
+                    if data_frequency == 'minute' else symbol_def['end_minute']
+
+            else:
+                end_daily = end_dt if data_frequency == 'daily' else 'N/A'
+                end_minute = end_dt if data_frequency == 'minute' else 'N/A'
+
+            if min_start_dt is None or start_dt < min_start_dt:
+                min_start_dt = start_dt
+
+            if max_end_dt is None or end_dt > max_end_dt:
+                max_end_dt = end_dt
+
+            asset = TradingPair(
+                symbol=symbol,
+                exchange=self.exchange_name,
+                start_date=start_dt,
+                end_date=end_dt,
+                leverage=0,  # TODO: add as an optional column
+                asset_name=symbol,
+                min_trade_size=0,  # TODO: add as an optional column
+                end_daily=end_daily,
+                end_minute=end_minute,
+                exchange_symbol=symbol
+            )
+            assets[symbol] = asset
+
+        save_exchange_symbols(self.exchange_name, assets, True)
+
+        writer = self.get_writer(
+            start_dt=min_start_dt.replace(hour=00, minute=00),
+            end_dt=max_end_dt.replace(hour=23, minute=59),
+            data_frequency=data_frequency
+        )
+
+        for symbol in assets:
+            asset = assets[symbol]
+            ohlcv_df = df.loc[
+                (df.index.get_level_values(0) == symbol)
+            ]  # type: pd.DataFrame
+            ohlcv_df.index = ohlcv_df.index.droplevel(0)
+
+            period_start = start_dt.replace(hour=00, minute=00)
+            period_end = end_dt.replace(hour=23, minute=59)
+            periods = self.get_calendar_periods_range(
+                period_start, period_end, data_frequency
+            )
+
+            # We're not really resampling but ensuring that each frame
+            # contains data
+            ohlcv_df = ohlcv_df.reindex(periods, method='ffill')
+            ohlcv_df['volume'] = ohlcv_df['volume'].fillna(0)
+
+            problems += self.ingest_df(
+                ohlcv_df=ohlcv_df,
+                data_frequency=data_frequency,
+                asset=asset,
+                writer=writer,
+                empty_rows_behavior=empty_rows_behavior,
+                duplicates_threshold=duplicates_threshold
+            )
+        return filter(partial(is_not, None), problems)
+
     def ingest(self, data_frequency, include_symbols=None,
-               exclude_symbols=None, start=None, end=None,
+               exclude_symbols=None, start=None, end=None, csv=None,
                show_progress=True, show_breakdown=True, show_report=True):
         """
         Inject data based on specified parameters.
@@ -664,17 +791,34 @@ class ExchangeBundle:
         data_frequency: str
         include_symbols: str
         exclude_symbols: str
-        start: datetime
+        start: pd.Timestamp
-        end: datetime
+        end: pd.Timestamp
         show_progress: bool
         environ:
 
         """
-        assets = self.get_assets(include_symbols, exclude_symbols)
+        if csv is not None:
+            self.ingest_csv(csv, data_frequency)
 
-        for frequency in data_frequency.split(','):
+        else:
-            self.ingest_assets(assets, frequency, start, end,
+            if self.exchange is None:
-                               show_progress, show_breakdown, show_report)
+                # Avoid circular dependencies
+                from catalyst.exchange.factory import get_exchange
+                self.exchange = get_exchange(self.exchange_name)
+
+            assets = get_assets(
+                self.exchange, include_symbols, exclude_symbols
+            )
+            for frequency in data_frequency.split(','):
+                self.ingest_assets(
+                    assets=assets,
+                    data_frequency=frequency,
+                    start_dt=start,
+                    end_dt=end,
+                    show_progress=show_progress,
+                    show_breakdown=show_breakdown,
+                    show_report=show_report
+                )
 
     def get_history_window_series_and_load(self,
                                            assets,
@@ -682,7 +826,9 @@ class ExchangeBundle:
                                            bar_count,
                                            field,
                                            data_frequency,
-                                           algo_end_dt=None
+                                           algo_end_dt=None,
+                                           trailing_bar_count=None,
+                                           force_auto_ingest=False
                                            ):
         """
         Retrieve price data history, ingest missing data.
@@ -690,25 +836,26 @@ class ExchangeBundle:
         Parameters
         ----------
         assets: list[TradingPair]
-        end_dt: datetime
+        end_dt: pd.Timestamp
         bar_count: int
         field: str
         data_frequency: str
-        algo_end_dt: datetime
+        algo_end_dt: pd.Timestamp
 
         Returns
         -------
         Series
 
         """
-        if AUTO_INGEST:
+        if AUTO_INGEST or force_auto_ingest:
             try:
                 series = self.get_history_window_series(
                     assets=assets,
                     end_dt=end_dt,
                     bar_count=bar_count,
                     field=field,
-                    data_frequency=data_frequency
+                    data_frequency=data_frequency,
+                    trailing_bar_count=trailing_bar_count,
                 )
                 return pd.DataFrame(series)
 
@@ -725,7 +872,7 @@ class ExchangeBundle:
                 self.ingest_assets(
                     assets=assets,
                     start_dt=start_dt,
-                    end_dt=algo_end_dt,
+                    end_dt=algo_end_dt,  # TODO: apply trailing bars
                     data_frequency=data_frequency,
                     show_progress=True,
                     show_breakdown=True
@@ -736,7 +883,8 @@ class ExchangeBundle:
                     bar_count=bar_count,
                     field=field,
                     data_frequency=data_frequency,
-                    reset_reader=True
+                    reset_reader=True,
+                    trailing_bar_count=trailing_bar_count,
                 )
                 return series
 
@@ -746,7 +894,8 @@ class ExchangeBundle:
                 end_dt=end_dt,
                 bar_count=bar_count,
                 field=field,
-                data_frequency=data_frequency
+                data_frequency=data_frequency,
+                trailing_bar_count=trailing_bar_count,
             )
             return pd.DataFrame(series)
 
@@ -796,7 +945,7 @@ class ExchangeBundle:
             raise PricingDataNotLoadedError(
                 field=field,
                 first_trading_day=min([asset.start_date for asset in assets]),
-                exchange=self.exchange.name,
+                exchange=self.exchange_name,
                 symbols=symbols,
                 symbol_list=','.join(symbols),
                 data_frequency=data_frequency,
@@ -810,12 +959,20 @@ class ExchangeBundle:
                                   bar_count,
                                   field,
                                   data_frequency,
+                                  trailing_bar_count=None,
                                   reset_reader=False):
         start_dt = get_start_dt(end_dt, bar_count, data_frequency, False)
-        start_dt, end_dt = self.get_adj_dates(
+        start_dt, _ = self.get_adj_dates(
             start_dt, end_dt, assets, data_frequency
         )
 
+        if trailing_bar_count:
+            delta = get_delta(trailing_bar_count, data_frequency)
+            end_dt += delta
+
+        # This is an attempt to resolve some caching with the reader
+        # when auto-ingesting data.
+        # TODO: needs more work
         reader = self.get_reader(data_frequency)
         if reset_reader:
             del self._readers[reader._rootdir]
@@ -826,7 +983,7 @@ class ExchangeBundle:
             raise PricingDataNotLoadedError(
                 field=field,
                 first_trading_day=min([asset.start_date for asset in assets]),
-                exchange=self.exchange.name,
+                exchange=self.exchange_name,
                 symbols=symbols,
                 symbol_list=','.join(symbols),
                 data_frequency=data_frequency,
@@ -834,57 +991,61 @@ class ExchangeBundle:
                 end_dt=end_dt
             )
 
+        series = dict()
         for asset in assets:
-            asset_start_dt, asset_end_dt = self.get_adj_dates(
+            asset_start_dt, _ = self.get_adj_dates(
                 start_dt, end_dt, assets, data_frequency
             )
-
             in_bundle = range_in_bundle(
-                asset, asset_start_dt, asset_end_dt, reader
+                asset, asset_start_dt, end_dt, reader
             )
             if not in_bundle:
                 raise PricingDataNotLoadedError(
                     field=field,
                     first_trading_day=asset.start_date,
-                    exchange=self.exchange.name,
+                    exchange=self.exchange_name,
                     symbols=asset.symbol,
                     symbol_list=asset.symbol,
                     data_frequency=data_frequency,
                     start_dt=asset_start_dt,
-                    end_dt=asset_end_dt
+                    end_dt=end_dt
                 )
 
-        series = dict()
+            periods = self.get_calendar_periods_range(
-        try:
+                asset_start_dt, end_dt, data_frequency
+            )
+            # This does not behave well when requesting multiple assets
+            # when the start or end date of one asset is outside of the range
+            # looking at the logic in load_raw_arrays(), we are not achieving
+            # any performance gain by requesting multiple sids at once. It's
+            # looping through the sids and making separate requests anyway.
             arrays = reader.load_raw_arrays(
-                sids=[asset.sid for asset in assets],
+                sids=[asset.sid],
                 fields=[field],
                 start_dt=start_dt,
                 end_dt=end_dt
             )
+            if len(arrays) == 0:
+                raise DataCorruptionError(
+                    exchange=self.exchange_name,
+                    symbols=asset.symbol,
+                    start_dt=asset_start_dt,
+                    end_dt=end_dt
+                )
 
-        except Exception:
+            field_values = arrays[0][:, 0]
-            symbols = [asset.symbol.encode('utf-8') for asset in assets]
-            raise PricingDataNotLoadedError(
-                field=field,
-                first_trading_day=min([asset.start_date for asset in assets]),
-                exchange=self.exchange.name,
-                symbols=symbols,
-                symbol_list=','.join(symbols),
-                data_frequency=data_frequency,
-                start_dt=start_dt,
-                end_dt=end_dt
-            )
 
-        periods = self.get_calendar_periods_range(
+            try:
-            start_dt, end_dt, data_frequency
+                value_series = pd.Series(field_values, index=periods)
-        )
+                series[asset] = value_series
-
+            except ValueError as e:
-        for asset_index, asset in enumerate(assets):
+                raise PricingDataValueError(
-            asset_values = arrays[asset_index]
+                    exchange=asset.exchange,
-
+                    symbol=asset.symbol,
-            value_series = pd.Series(asset_values.flatten(), index=periods)
+                    start_dt=asset_start_dt,
-            series[asset] = value_series
+                    end_dt=end_dt,
+                    error=e
+                )
 
         return series
 
@@ -898,14 +1059,18 @@ class ExchangeBundle:
 
         """
         log.debug('cleaning exchange {}, frequency {}'.format(
-            self.exchange.name, data_frequency
+            self.exchange_name, data_frequency
         ))
-        root = get_exchange_folder(self.exchange.name)
+        root = get_exchange_folder(self.exchange_name)
 
         symbols = os.path.join(root, 'symbols.json')
         if os.path.isfile(symbols):
             os.remove(symbols)
 
+        local_symbols = os.path.join(root, 'symbols_local.json')
+        if os.path.isfile(local_symbols):
+            os.remove(local_symbols)
+
         temp_bundles = os.path.join(root, 'temp_bundles')
 
         if os.path.isdir(temp_bundles):

catalyst/exchange/exchange_data_portal.py

@@ -21,7 +21,6 @@ log = Logger('DataPortalExchange', level=LOG_LEVEL)
 class DataPortalExchangeBase(DataPortal):
     def __init__(self, *args, **kwargs):
 
-        self.exchanges = kwargs.pop('exchanges', None)
         # TODO: put somewhere accessible by each algo
         self.retry_get_history_window = 5
         self.retry_get_spot_value = 5
@@ -49,11 +48,10 @@ class DataPortalExchangeBase(DataPortal):
             if len(exchange_assets) > 1:
                 df_list = []
                 for exchange_name in exchange_assets:
-                    exchange = self.exchanges[exchange_name]
                     assets = exchange_assets[exchange_name]
 
                     df_exchange = self.get_exchange_history_window(
-                        exchange,
+                        exchange_name,
                         assets,
                         end_dt,
                         bar_count,
@@ -68,9 +66,9 @@ class DataPortalExchangeBase(DataPortal):
                 return pd.concat(df_list)
 
             else:
-                exchange = self.exchanges[list(exchange_assets.keys())[0]]
+                exchange_name = list(exchange_assets.keys())[0]
                 return self.get_exchange_history_window(
-                    exchange,
+                    exchange_name,
                     assets,
                     end_dt,
                     bar_count,
@@ -122,7 +120,7 @@ class DataPortalExchangeBase(DataPortal):
 
     @abc.abstractmethod
     def get_exchange_history_window(self,
-                                    exchange,
+                                    exchange_name,
                                     assets,
                                     end_dt,
                                     bar_count,
@@ -136,9 +134,8 @@ class DataPortalExchangeBase(DataPortal):
                         attempt_index=0):
         try:
             if isinstance(assets, TradingPair):
-                exchange = self.exchanges[assets.exchange]
                 spot_values = self.get_exchange_spot_value(
-                    exchange, [assets], field, dt, data_frequency)
+                    assets.exchange, [assets], field, dt, data_frequency)
 
                 if not spot_values:
                     return np.nan
@@ -154,17 +151,16 @@ class DataPortalExchangeBase(DataPortal):
                     exchange_assets[asset.exchange].append(asset)
 
                 if len(list(exchange_assets.keys())) == 1:
-                    exchange = self.exchanges[list(exchange_assets.keys())[0]]
+                    exchange_name = list(exchange_assets.keys())[0]
                     return self.get_exchange_spot_value(
-                        exchange, assets, field, dt, data_frequency)
+                        exchange_name, assets, field, dt, data_frequency)
 
                 else:
                     spot_values = []
                     for exchange_name in exchange_assets:
-                        exchange = self.exchanges[exchange_name]
                         assets = exchange_assets[exchange_name]
                         exchange_spot_values = self.get_exchange_spot_value(
-                            exchange,
+                            exchange_name,
                             assets,
                             field,
                             dt,
@@ -199,7 +195,7 @@ class DataPortalExchangeBase(DataPortal):
         return self._get_spot_value(assets, field, dt, data_frequency)
 
     @abc.abstractmethod
-    def get_exchange_spot_value(self, exchange, assets, field, dt,
+    def get_exchange_spot_value(self, exchange_name, assets, field, dt,
                                 data_frequency):
         return
 
@@ -214,10 +210,11 @@ class DataPortalExchangeBase(DataPortal):
 
 class DataPortalExchangeLive(DataPortalExchangeBase):
     def __init__(self, *args, **kwargs):
+        self.exchanges = kwargs.pop('exchanges', None)
         super(DataPortalExchangeLive, self).__init__(*args, **kwargs)
 
     def get_exchange_history_window(self,
-                                    exchange,
+                                    exchange_name,
                                     assets,
                                     end_dt,
                                     bar_count,
@@ -230,7 +227,7 @@ class DataPortalExchangeLive(DataPortalExchangeBase):
 
         Parameters
         ----------
-        exchange: Exchange
+        exchange_name: Exchange
         assets: list[TradingPair]
         end_dt: datetime
         bar_count: int
@@ -244,6 +241,7 @@ class DataPortalExchangeLive(DataPortalExchangeBase):
         DataFrame
 
         """
+        exchange = self.exchanges[exchange_name]
         df = exchange.get_history_window(
             assets,
             end_dt,
@@ -254,14 +252,14 @@ class DataPortalExchangeLive(DataPortalExchangeBase):
             ffill)
         return df
 
-    def get_exchange_spot_value(self, exchange, assets, field, dt,
+    def get_exchange_spot_value(self, exchange_name, assets, field, dt,
                                 data_frequency):
         """
         A spot value for the exchange.
 
         Parameters
         ----------
-        exchange: Exchange
+        exchange_name: str
         assets: list[TradingPair]
         field: str
         dt: datetime
@@ -272,6 +270,7 @@ class DataPortalExchangeLive(DataPortalExchangeBase):
         float
 
         """
+        exchange = self.exchanges[exchange_name]
         exchange_spot_values = exchange.get_spot_value(
             assets, field, dt, data_frequency)
 
@@ -280,16 +279,16 @@ class DataPortalExchangeLive(DataPortalExchangeBase):
 
 class DataPortalExchangeBacktest(DataPortalExchangeBase):
     def __init__(self, *args, **kwargs):
+        self.exchange_names = kwargs.pop('exchange_names', None)
+
         super(DataPortalExchangeBacktest, self).__init__(*args, **kwargs)
 
         self.exchange_bundles = dict()
-
         self.history_loaders = dict()
         self.minute_history_loaders = dict()
 
-        for exchange_name in self.exchanges:
+        for name in self.exchange_names:
-            exchange = self.exchanges[exchange_name]
+            self.exchange_bundles[name] = ExchangeBundle(name)
-            self.exchange_bundles[exchange_name] = ExchangeBundle(exchange)
 
     def _get_first_trading_day(self, assets):
         first_date = None
@@ -299,7 +298,7 @@ class DataPortalExchangeBacktest(DataPortalExchangeBase):
         return first_date
 
     def get_exchange_history_window(self,
-                                    exchange,
+                                    exchange_name,
                                     assets,
                                     end_dt,
                                     bar_count,
@@ -326,12 +325,13 @@ class DataPortalExchangeBacktest(DataPortalExchangeBase):
         DataFrame
 
         """
-        bundle = self.exchange_bundles[exchange.name]  # type: ExchangeBundle
+        bundle = self.exchange_bundles[exchange_name]  # type: ExchangeBundle
 
         freq, candle_size, unit, adj_data_frequency = get_frequency(
             frequency, data_frequency
         )
         adj_bar_count = candle_size * bar_count
+        trailing_bar_count = candle_size - 1
 
         if data_frequency == 'minute' and adj_data_frequency == 'daily':
             end_dt = end_dt.floor('1D')
@@ -343,13 +343,14 @@ class DataPortalExchangeBacktest(DataPortalExchangeBase):
             field=field,
             data_frequency=adj_data_frequency,
             algo_end_dt=self._last_available_session,
+            trailing_bar_count=trailing_bar_count
         )
 
         df = resample_history_df(pd.DataFrame(series), freq, field)
         return df
 
     def get_exchange_spot_value(self,
-                                exchange,
+                                exchange_name,
                                 assets,
                                 field,
                                 dt,
@@ -361,7 +362,7 @@ class DataPortalExchangeBacktest(DataPortalExchangeBase):
 
         Parameters
         ----------
-        exchange: Exchange
+        exchange_name: str
         assets: list[TradingPair]
         field: str
         dt: datetime
@@ -372,7 +373,7 @@ class DataPortalExchangeBacktest(DataPortalExchangeBase):
         float
 
         """
-        bundle = self.exchange_bundles[exchange.name]
+        bundle = self.exchange_bundles[exchange_name]
         if data_frequency == 'daily':
             dt = dt.floor('1D')
         else:

catalyst/exchange/exchange_errors.py

@@ -217,6 +217,19 @@ class PricingDataNotLoadedError(ZiplineError):
            '{data_frequency} -i {symbol_list}`. See catalyst documentation '
            'for details.').strip()
 
+class PricingDataValueError(ZiplineError):
+    msg = ('Unable to retrieve pricing data for {exchange} {symbol} '
+           '[{start_dt} - {end_dt}]: {error}').strip()
+
+
+class DataCorruptionError(ZiplineError):
+    msg = ('Unable to validate data for {exchange} {symbols} in date range '
+           '[{start_dt} - {end_dt}]. The data is either corrupted or '
+           'unavailable. Please try deleting this bundle:'
+           '\n`catalyst clean-exchange -x {exchange}\n'
+           'Then, ingest the data again. Please contact the Catalyst team if '
+           'the issue persists.').strip()
+
 
 class ApiCandlesError(ZiplineError):
     msg = ('Unable to fetch candles from the remote API: {error}.').strip()

catalyst/exchange/exchange_utils.py

@@ -1,3 +1,4 @@
+import hashlib
 import json
 import os
 import pickle
@@ -9,13 +10,31 @@ import pandas as pd
 from catalyst.assets._assets import TradingPair
 from six.moves.urllib import request
 
+from catalyst.constants import DATE_FORMAT, SYMBOLS_URL
 from catalyst.exchange.exchange_errors import ExchangeSymbolsNotFound, \
     InvalidHistoryFrequencyError, InvalidHistoryFrequencyAlias
 from catalyst.utils.paths import data_root, ensure_directory, \
     last_modified_time
 
-SYMBOLS_URL = 'https://s3.amazonaws.com/enigmaco/catalyst-exchanges/' \
+
-              '{exchange}/symbols.json'
+def get_sid(symbol):
+    """
+    Create a sid by hashing the symbol of a currency pair.
+
+    Parameters
+    ----------
+    symbol: str
+
+    Returns
+    -------
+    int
+        The resulting sid.
+
+    """
+    sid = int(
+        hashlib.sha256(symbol.encode('utf-8')).hexdigest(), 16
+    ) % 10 ** 6
+    return sid
 
 
 def get_exchange_folder(exchange_name, environ=None):
@@ -42,7 +61,7 @@ def get_exchange_folder(exchange_name, environ=None):
     return exchange_folder
 
 
-def get_exchange_symbols_filename(exchange_name, environ=None):
+def get_exchange_symbols_filename(exchange_name, is_local=False, environ=None):
     """
     The absolute path of the exchange's symbol.json file.
 
@@ -56,8 +75,9 @@ def get_exchange_symbols_filename(exchange_name, environ=None):
     str
 
     """
+    name = 'symbols.json' if not is_local else 'symbols_local.json'
     exchange_folder = get_exchange_folder(exchange_name, environ)
-    return os.path.join(exchange_folder, 'symbols.json')
+    return os.path.join(exchange_folder, name)
 
 
 def download_exchange_symbols(exchange_name, environ=None):
@@ -80,13 +100,14 @@ def download_exchange_symbols(exchange_name, environ=None):
     return response
 
 
-def get_exchange_symbols(exchange_name, environ=None):
+def get_exchange_symbols(exchange_name, is_local=False, environ=None):
     """
     The de-serialized content of the exchange's symbols.json.
 
     Parameters
     ----------
     exchange_name: str
+    is_local: bool
     environ:
 
     Returns
@@ -94,18 +115,21 @@ def get_exchange_symbols(exchange_name, environ=None):
     Object
 
     """
-    filename = get_exchange_symbols_filename(exchange_name)
+    filename = get_exchange_symbols_filename(exchange_name, is_local)
 
-    if not os.path.isfile(filename) or \
+    if not is_local and (not os.path.isfile(filename) or pd.Timedelta(
-                    pd.Timedelta(pd.Timestamp('now',
+                pd.Timestamp('now', tz='UTC') - last_modified_time(
-                                              tz='UTC') - last_modified_time(
+                filename)).days > 1):
-                        filename)).days > 1:
         download_exchange_symbols(exchange_name, environ)
 
     if os.path.isfile(filename):
         with open(filename) as data_file:
-            data = json.load(data_file)
+            try:
-            return data
+                data = json.load(data_file)
+                return data
+
+            except ValueError:
+                return dict()
     else:
         raise ExchangeSymbolsNotFound(
             exchange=exchange_name,
@@ -113,6 +137,32 @@ def get_exchange_symbols(exchange_name, environ=None):
         )
 
 
+def save_exchange_symbols(exchange_name, assets, is_local=False, environ=None):
+    """
+    Save assets into an exchange_symbols file.
+
+    Parameters
+    ----------
+    exchange_name: str
+    assets: list[dict[str, object]]
+    is_local: bool
+    environ
+
+    Returns
+    -------
+
+    """
+    asset_dicts = dict()
+    for symbol in assets:
+        asset_dicts[symbol] = assets[symbol].to_dict()
+
+    filename = get_exchange_symbols_filename(
+        exchange_name, is_local, environ
+    )
+    with open(filename, 'wt') as handle:
+        json.dump(asset_dicts, handle, indent=4, default=symbols_serial)
+
+
 def get_symbols_string(assets):
     """
     A concatenated string of symbols from a list of assets.
@@ -363,6 +413,25 @@ def get_exchange_bundles_folder(exchange_name, environ=None):
     return temp_bundles
 
 
+def symbols_serial(obj):
+    """
+    JSON serializer for objects not serializable by default json code
+
+    Parameters
+    ----------
+    obj: Object
+
+    Returns
+    -------
+    str
+
+    """
+    if isinstance(obj, (datetime, date)):
+        return obj.floor('1D').strftime(DATE_FORMAT)
+
+    raise TypeError("Type %s not serializable" % type(obj))
+
+
 def perf_serial(obj):
     """
     JSON serializer for objects not serializable by default json code
@@ -500,4 +569,5 @@ def resample_history_df(df, freq, field):
     else:
         raise ValueError('Invalid field.')
 
-    return df.resample(freq).agg(agg)
+    resampled_df = df.resample(freq).agg(agg)
+    return resampled_df

catalyst/exchange/poloniex/poloniex.py

@@ -35,8 +35,13 @@ class Poloniex(Exchange):
     def __init__(self, key, secret, base_currency, portfolio=None):
         self.api = Poloniex_api(key=key, secret=secret)
         self.name = 'poloniex'
-        self.assets = {}
+
+        self.assets = dict()
         self.load_assets()
+
+        self.local_assets = dict()
+        self.load_assets(is_local=True)
+
         self.base_currency = base_currency
         self._portfolio = portfolio
         self.minute_writer = None
@@ -47,7 +52,7 @@ class Poloniex(Exchange):
         self.max_requests_per_minute = 60
         self.request_cpt = dict()
 
-        self.bundle = ExchangeBundle(self)
+        self.bundle = ExchangeBundle(self.name)
 
     def sanitize_curency_symbol(self, exchange_symbol):
         """

catalyst/exchange/stats_utils.py

@@ -30,14 +30,25 @@ def crossover(source, target):
     bool
 
     """
-    if source[-1] is np.nan or source[-2] is np.nan \
+    if isinstance(target, numbers.Number):
-            or target[-1] is np.nan or target[-2] is np.nan:
+        if source[-1] is np.nan or source[-2] is np.nan \
-        return False
+                or target is np.nan:
+            return False
+
+        if source[-1] >= target > source[-2]:
+            return True
+        else:
+            return False
 
-    if source[-1] > target[-1] and source[-2] < target[-2]:
-        return True
     else:
-        return False
+        if source[-1] is np.nan or source[-2] is np.nan \
+                or target[-1] is np.nan or target[-2] is np.nan:
+            return False
+
+        if source[-1] > target[-1] and source[-2] < target[-2]:
+            return True
+        else:
+            return False
 
 
 def crossunder(source, target):

catalyst/exchange/validator.py

@@ -0,0 +1,142 @@
+import os
+import tempfile
+
+import pandas as pd
+import six
+from catalyst.assets._assets import TradingPair, get_calendar
+from logbook import Logger
+from pandas.util.testing import assert_frame_equal
+
+from catalyst.constants import LOG_LEVEL
+from catalyst.exchange.asset_finder_exchange import AssetFinderExchange
+from catalyst.exchange.exchange_data_portal import DataPortalExchangeBacktest
+from catalyst.exchange.factory import get_exchanges
+from catalyst.utils.paths import ensure_directory
+
+log = Logger('Validator', level=LOG_LEVEL)
+
+
+def output_df(df, assets, name=None):
+    """
+    Outputs a price DataFrame to a temp folder.
+
+    Parameters
+    ----------
+    df: pd.DataFrame
+    assets
+    name
+
+    Returns
+    -------
+
+    """
+    if isinstance(assets, TradingPair):
+        exchange_folder = assets.exchange
+        asset_folder = assets.symbol
+    else:
+        exchange_folder = ','.join([asset.exchange for asset in assets])
+        asset_folder = ','.join([asset.symbol for asset in assets])
+
+    folder = os.path.join(
+        tempfile.gettempdir(), 'catalyst', exchange_folder, asset_folder
+    )
+    ensure_directory(folder)
+
+    if name is None:
+        name = 'output'
+
+    path = os.path.join(folder, '{}.csv'.format(name))
+    df.to_csv(path)
+
+    return path
+
+
+class Validator(object):
+    def __init__(self, data_portal):
+        self.data_portal = data_portal
+
+    def compare_bundle_with_exchange(self, exchange, assets, end_dt, bar_count,
+                                     sample_minutes):
+        """
+        Creates DataFrames from the bundle and exchange for the specified
+        data set.
+
+        Parameters
+        ----------
+        exchange: Exchange
+        assets
+        end_dt
+        bar_count
+        sample_minutes
+
+        Returns
+        -------
+
+        """
+        freq = '{}T'.format(sample_minutes)
+
+        log.info('creating data sample from bundle')
+        df1 = self.data_portal.get_history_window(
+            assets=assets,
+            end_dt=end_dt,
+            bar_count=bar_count,
+            frequency=freq,
+            field='close',
+            data_frequency='minute'
+        )
+        path = output_df(df1, assets, '{}_resampled'.format(freq))
+        log.info('saved resampled bundle candles: {}\n{}'.format(
+            path, df1.tail(10))
+        )
+
+        log.info('creating data sample from exchange api')
+        candles = exchange.get_candles(
+            end_dt=end_dt,
+            freq='{}T'.format(sample_minutes),
+            assets=assets,
+            bar_count=bar_count
+        )
+
+        series = dict()
+        for asset in assets:
+            series[asset] = pd.Series(
+                data=[candle['close'] for candle in candles[asset]],
+                index=[candle['last_traded'] for candle in candles[asset]]
+            )
+
+        df2 = pd.DataFrame(series)
+        path = output_df(df2, assets, '{}_api'.format(freq))
+        log.info('saved exchange api candles: {}\n{}'.format(
+            path, df2.tail(10))
+        )
+
+        try:
+            assert_frame_equal(df1, df2)
+            return True
+        except:
+            log.warn('differences found in dataframes')
+            return False
+
+
+if __name__ == '__main__':
+    exchanges = get_exchanges(['poloniex'])
+    exchange = six.next(six.itervalues(exchanges))
+    assets = exchange.get_assets(symbols=['eth_btc'])
+
+    open_calendar = get_calendar('OPEN')
+    asset_finder = AssetFinderExchange()
+    data_portal = DataPortalExchangeBacktest(
+        exchanges=exchanges,
+        asset_finder=asset_finder,
+        trading_calendar=open_calendar,
+        first_trading_day=None  # will set dynamically based on assets
+    )
+    validator = Validator(data_portal=data_portal)
+
+    validator.compare_bundle_with_exchange(
+        exchange=exchange,
+        assets=assets,
+        end_dt=pd.to_datetime('2017-11-10 1:00', utc=True),
+        bar_count=200,
+        sample_minutes=30
+    )

catalyst/finance/risk/cumulative.py

@@ -196,8 +196,8 @@ class RiskMetricsCumulative(object):
             self.benchmark_cumulative_returns[dt_loc] = cum_returns(
                 self.benchmark_returns
             )[-1]
-        except Exception as e:
+        except Exception:
-            log.debug('cumulative returns error: {}'.format(e))
+            self.benchmark_cumulative_returns[dt_loc] = 0
 
         benchmark_cumulative_returns_to_date = \
             self.benchmark_cumulative_returns[:dt_loc + 1]
@@ -274,12 +274,14 @@ algorithm_returns ({algo_count}) in range {start} : {end} on {dt}"
         )
 
         try:
+            risk = self.downside_risk[dt_loc]
             self.sortino[dt_loc] = sortino_ratio(
                 self.algorithm_returns,
-                _downside_risk=self.downside_risk[dt_loc]
+                _downside_risk=risk
             )
-        except Exception as e:
+        except Exception:
-            log.debug('sortino ratio error: {}'.format(e))
+            # TODO: what causes it to error out?
+            self.sortino[dt_loc] = 0
 
         self.information[dt_loc] = information_ratio(
             self.algorithm_returns,

catalyst/finance/risk/period.py

@@ -14,6 +14,7 @@
 # limitations under the License.
 
 import functools
+import warnings
 
 import logbook
 
@@ -23,7 +24,7 @@ import numpy as np
 import pandas as pd
 
 from . import risk
-from . risk import check_entry
+from .risk import check_entry
 
 from empyrical import (
     alpha_beta_aligned,
@@ -78,14 +79,20 @@ class RiskMetricsPeriod(object):
         self.calculate_metrics()
 
     def calculate_metrics(self):
-        self.benchmark_period_returns = \
+        warnings.filterwarnings('error')
-            cum_returns(self.benchmark_returns).iloc[-1]
+
+        try:
+            self.benchmark_period_returns = \
+                cum_returns(self.benchmark_returns).iloc[-1]
+        except Exception:
+            # TODO: why is there an error
+            self.benchmark_period_returns = 0
 
         self.algorithm_period_returns = \
             cum_returns(self.algorithm_returns).iloc[-1]
 
         if not self.algorithm_returns.index.equals(
-            self.benchmark_returns.index
+                self.benchmark_returns.index
         ):
             message = "Mismatch between benchmark_returns ({bm_count}) and \
             algorithm_returns ({algo_count}) in range {start} : {end}"
@@ -128,10 +135,17 @@ class RiskMetricsPeriod(object):
         self.downside_risk = downside_risk(
             self.algorithm_returns.values
         )
-        self.sortino = sortino_ratio(
+
-            self.algorithm_returns.values,
+        try:
-            _downside_risk=self.downside_risk,
+            risk = self.downside_risk
-        )
+            self.sortino = sortino_ratio(
+                self.algorithm_returns.values,
+                _downside_risk=risk,
+            )
+        except Exception:
+            # TODO: what causes it to error out?
+            self.sortino = 0
+
         self.information = information_ratio(
             self.algorithm_returns.values,
             self.benchmark_returns.values,
@@ -141,10 +155,12 @@ class RiskMetricsPeriod(object):
             self.benchmark_returns.values,
         )
         self.excess_return = self.algorithm_period_returns - \
-            self.treasury_period_return
+                             self.treasury_period_return
         self.max_drawdown = max_drawdown(self.algorithm_returns.values)
         self.max_leverage = self.calculate_max_leverage()
 
+        warnings.resetwarnings()
+
     def to_dict(self):
         """
         Creates a dictionary representing the state of the risk report.

catalyst/support/issue_47.py

@@ -1,6 +1,6 @@
 """
 Requires Catalyst version 0.3.0 or above
-Tested on Catalyst version 0.3.2
+Tested on Catalyst version 0.3.3
 
 These example aims to provide and easy way for users to learn how to collect data from the different exchanges.
 You simply need to specify the exchange and the market that you want to focus on.
@@ -27,7 +27,7 @@ from catalyst.api import (
 def initialize(context):
     context.i = -1  # counts the minutes
     context.exchange = 'poloniex'  # must match the exchange specified in run_algorithm
-    context.base_currency = 'eth'  # must match the base currency specified in run_algorithm
+    context.base_currency = 'btc'  # must match the base currency specified in run_algorithm
 
 
 def handle_data(context, data):
@@ -56,21 +56,21 @@ def handle_data(context, data):
 
             # 30 minute interval ohlcv data (the standard data required for candlestick or indicators/signals)
             # 30T means 30 minutes re-sampling of one minute data. change to your desire time interval.
-            open = fill(data.history(coin, 'open', bar_count=lookback,
+            opened = fill(data.history(coin, 'open', bar_count=lookback,
-                                     frequency='1m')).resample('30T').first()
+                                       frequency='30T')).values
             high = fill(data.history(coin, 'high', bar_count=lookback,
-                                     frequency='1m')).resample('30T').max()
+                                     frequency='30T')).values
             low = fill(data.history(coin, 'low', bar_count=lookback,
-                                    frequency='1m')).resample('30T').min()
+                                    frequency='30T')).values
             close = fill(data.history(coin, 'price', bar_count=lookback,
-                                      frequency='1m')).resample('30T').last()
+                                      frequency='30T')).values
             volume = fill(data.history(coin, 'volume', bar_count=lookback,
-                                       frequency='1m')).resample('30T').sum()
+                                       frequency='30T')).values
 
             # close[-1] is the equivalent to current price
             # displays the minute price for each pair every 30 minutes
             print(
-            today, pair, open[-1], high[-1], low[-1], close[-1], volume[-1])
+            today, pair, opened[-1], high[-1], low[-1], close[-1], volume[-1])
 
             # ----------------------------------------------------------------------------------------------------------
             # -------------------------------------- Insert Your Strategy Here -----------------------------------------
@@ -82,7 +82,7 @@ def analyze(context=None, results=None):
 
 
 # Get the universe for a given exchange and a given base_currency market
-# Example: Poloniex BTC Market
+# Example: Poloniex btc Market
 def universe(context, lookback_date, current_date):
     json_symbols = get_exchange_symbols(
         context.exchange)  # get all the pairs for the exchange
@@ -103,7 +103,6 @@ def universe(context, lookback_date, current_date):
     universe_df = universe_df[universe_df.end_daily >= current_date]
     context.coins = symbols(
         *universe_df.symbol)  # convert all the pairs to symbols
-    print(universe_df.head(), len(universe_df))
     return universe_df.symbol.tolist()
 
 
@@ -119,8 +118,8 @@ def fill(series):
 
 
 if __name__ == '__main__':
-    start_date = pd.to_datetime('2017-01-01', utc=True)
+    start_date = pd.to_datetime('2017-01-08', utc=True)
-    end_date = pd.to_datetime('2017-10-15', utc=True)
+    end_date = pd.to_datetime('2017-11-13', utc=True)
 
     performance = run_algorithm(start=start_date, end=end_date,
                                 capital_base=10000.0,
@@ -129,7 +128,7 @@ if __name__ == '__main__':
                                 analyze=analyze,
                                 exchange_name='poloniex',
                                 data_frequency='minute',
-                                base_currency='eth',
+                                base_currency='btc',
                                 live=False,
                                 live_graph=False,
                                 algo_namespace='simple_universe')

catalyst/support/issue_74.py

@@ -0,0 +1,127 @@
+from __future__ import division
+import os
+import pytz
+import numpy as np
+import pandas as pd
+from scipy.optimize import minimize
+import matplotlib.pyplot as plt
+from datetime import datetime
+
+from catalyst.api import record, symbol, symbols, order_target_percent
+from catalyst.utils.run_algo import run_algorithm
+
+np.set_printoptions(threshold='nan', suppress=True)
+
+
+def initialize(context):
+    # Portfolio assets list
+    context.assets = symbols('btc_usdt', 'eth_usdt', 'ltc_usdt', 'dash_usdt',
+                             'xmr_usdt')
+    context.nassets = len(context.assets)
+    # Set the time window that will be used to compute expected return
+    # and asset correlations
+    context.window = 180
+    # Set the number of days between each portfolio rebalancing
+    context.rebalance_period = 30
+    context.i = 0
+
+
+def handle_data(context, data):
+    # Only rebalance at the beggining of the algorithm execution and
+    # every multiple of the rebalance period
+    if context.i == 0 or context.i % context.rebalance_period == 0:
+        n = context.window
+        prices = data.history(context.assets, fields='price',
+                           bar_count=n + 1, frequency='daily')
+        pr = np.asmatrix(prices)
+        t_prices = prices.iloc[1:n + 1]
+        t_val = t_prices.values
+        tminus_prices = prices.iloc[0:n]
+        tminus_val = tminus_prices.values
+        # Compute daily returns (r)
+        r = np.asmatrix(t_val / tminus_val - 1)
+        # Compute the expected returns of each asset with the average
+        # daily return for the selected time window
+        m = np.asmatrix(np.mean(r, axis=0))
+        # ###
+        stds = np.std(r, axis=0)
+        # Compute excess returns matrix (xr)
+        xr = r - m
+        # Matrix algebra to get variance-covariance matrix
+        cov_m = np.dot(np.transpose(xr), xr) / n
+        # Compute asset correlation matrix (informative only)
+        corr_m = cov_m / np.dot(np.transpose(stds), stds)
+
+        # Define portfolio optimization parameters
+        n_portfolios = 50000
+        results_array = np.zeros((3 + context.nassets, n_portfolios))
+        for p in xrange(n_portfolios):
+            weights = np.random.random(context.nassets)
+            weights /= np.sum(weights)
+            w = np.asmatrix(weights)
+            p_r = np.sum(np.dot(w, np.transpose(m))) * 365
+            p_std = np.sqrt(
+                np.dot(np.dot(w, cov_m), np.transpose(w))) * np.sqrt(365)
+
+            # store results in results array
+            results_array[0, p] = p_r
+            results_array[1, p] = p_std
+            # store Sharpe Ratio (return / volatility) - risk free rate element
+            # excluded for simplicity
+            results_array[2, p] = results_array[0, p] / results_array[1, p]
+            i = 0
+            for iw in weights:
+                results_array[3 + i, p] = weights[i]
+                i += 1
+
+        # convert results array to Pandas DataFrame
+        results_frame = pd.DataFrame(np.transpose(results_array),
+                                     columns=['r', 'stdev',
+                                              'sharpe'] + context.assets)
+        # locate position of portfolio with highest Sharpe Ratio
+        max_sharpe_port = results_frame.iloc[results_frame['sharpe'].idxmax()]
+        # locate positon of portfolio with minimum standard deviation
+        min_vol_port = results_frame.iloc[results_frame['stdev'].idxmin()]
+
+        # order optimal weights for each asset
+        for asset in context.assets:
+            if data.can_trade(asset):
+                order_target_percent(asset, max_sharpe_port[asset])
+
+        # create scatter plot coloured by Sharpe Ratio
+        plt.scatter(results_frame.stdev, results_frame.r,
+                    c=results_frame.sharpe, cmap='RdYlGn')
+        plt.xlabel('Volatility')
+        plt.ylabel('Returns')
+        plt.colorbar()
+        # plot red star to highlight position of portfolio with highest Sharpe Ratio
+        plt.scatter(max_sharpe_port[1], max_sharpe_port[0], marker='o',
+                    color='b', s=200)
+        # plot green star to highlight position of minimum variance portfolio
+        plt.show()
+        print(max_sharpe_port)
+        record(pr=pr, r=r, m=m, stds=stds, max_sharpe_port=max_sharpe_port,
+               corr_m=corr_m)
+    context.i += 1
+
+
+def analyze(context=None, results=None):
+    # Form DataFrame with selected data
+    data = results[['pr', 'r', 'm', 'stds', 'max_sharpe_port', 'corr_m',
+                    'portfolio_value']]
+
+    # Save results in CSV file
+    filename = os.path.splitext(os.path.basename(__file__))[0]
+    data.to_csv(filename + '.csv')
+
+
+# Bitcoin data is available from 2015-3-2. Dates vary for other tokens.
+start = datetime(2017, 1, 1, 0, 0, 0, 0, pytz.utc)
+end = datetime(2017, 8, 16, 0, 0, 0, 0, pytz.utc)
+results = run_algorithm(initialize=initialize,
+                        handle_data=handle_data,
+                        analyze=analyze,
+                        start=start,
+                        end=end,
+                        exchange_name='poloniex',
+                        capital_base=100000, )

catalyst/utils/run_algo.py

@@ -1,4 +1,5 @@
 import os
+import re
 import sys
 import warnings
 from datetime import timedelta
@@ -8,6 +9,8 @@ from time import sleep
 import click
 import pandas as pd
 
+from catalyst.data.bundles import load
+from catalyst.data.data_portal import DataPortal
 from catalyst.exchange.bittrex.bittrex import Bittrex
 from catalyst.exchange.bitfinex.bitfinex import Bitfinex
 from catalyst.exchange.poloniex.poloniex import Poloniex
@@ -167,10 +170,12 @@ def _run(handle_data,
         # This corresponds to the json file containing api token info
         exchange_auth = get_exchange_auth(exchange_name)
 
-        if live and (exchange_auth['key'] == '' or exchange_auth['secret'] == ''):
+        if live and (exchange_auth['key'] == '' \
+                             or exchange_auth['secret'] == ''):
             raise ExchangeAuthEmpty(
-                    exchange=exchange_name.title(), 
+                exchange=exchange_name.title(),
-                    filename=os.path.join(get_exchange_folder(exchange_name, environ), 'auth.json') )
+                filename=os.path.join(
+                    get_exchange_folder(exchange_name, environ), 'auth.json'))
 
         if exchange_name == 'bitfinex':
             exchanges[exchange_name] = Bitfinex(
@@ -258,17 +263,35 @@ def _run(handle_data,
                     )
 
             if base_currency in balances:
-                return balances[base_currency]
+                base_currency_available = balances[base_currency]
+                log.info(
+                    'base currency available in the account: {} {}'.format(
+                        base_currency_available, base_currency
+                    )
+                )
+
+                if capital_base is not None \
+                        and capital_base < base_currency_available:
+                    log.info(
+                        'using capital base limit: {} {}'.format(
+                            capital_base, base_currency
+                        )
+                    )
+                    amount = capital_base
+                else:
+                    amount = base_currency_available
+
+                return amount
             else:
                 raise BaseCurrencyNotFoundError(
                     base_currency=base_currency,
                     exchange=exchange_name
                 )
 
-        capital_base = 0
+        combined_capital_base = 0
         for exchange_name in exchanges:
             exchange = exchanges[exchange_name]
-            capital_base += fetch_capital_base(exchange)
+            combined_capital_base += fetch_capital_base(exchange)
 
         sim_params = create_simulation_parameters(
             start=start,
@@ -287,7 +310,7 @@ def _run(handle_data,
             algo_namespace=algo_namespace,
             live_graph=live_graph
         )
-    else:
+    elif exchanges:
         # Removed the existing Poloniex fork to keep things simple
         # We can add back the complexity if required.
 
@@ -297,7 +320,7 @@ def _run(handle_data,
         # can handle this later.
 
         data = DataPortalExchangeBacktest(
-            exchanges=exchanges,
+            exchange_names=[exchange_name for exchange_name in exchanges],
             asset_finder=None,
             trading_calendar=open_calendar,
             first_trading_day=start,
@@ -317,6 +340,36 @@ def _run(handle_data,
             exchanges=exchanges
         )
 
+    elif bundle is not None:
+        bundle_data = load(
+            bundle,
+            environ,
+            bundle_timestamp,
+        )
+
+        prefix, connstr = re.split(
+            r'sqlite:///',
+            str(bundle_data.asset_finder.engine.url),
+            maxsplit=1,
+        )
+        if prefix:
+            raise ValueError(
+                "invalid url %r, must begin with 'sqlite:///'" %
+                str(bundle_data.asset_finder.engine.url),
+            )
+
+        env = TradingEnvironment(asset_db_path=connstr, environ=environ)
+        first_trading_day = \
+            bundle_data.equity_minute_bar_reader.first_trading_day
+
+        data = DataPortal(
+            env.asset_finder, open_calendar,
+            first_trading_day=first_trading_day,
+            equity_minute_reader=bundle_data.equity_minute_bar_reader,
+            equity_daily_reader=bundle_data.equity_daily_bar_reader,
+            adjustment_reader=bundle_data.adjustment_reader,
+        )
+
     perf = algorithm_class(
         namespace=namespace,
         env=env,
@@ -416,7 +469,8 @@ def run_algorithm(initialize,
                   exchange_name=None,
                   base_currency=None,
                   algo_namespace=None,
-                  live_graph=False):
+                  live_graph=False,
+                  output=os.devnull):
     """Run a trading algorithm.
 
     Parameters
@@ -486,7 +540,9 @@ def run_algorithm(initialize,
     --------
     catalyst.data.bundles.bundles : The available data bundles.
     """
-    load_extensions(default_extension, extensions, strict_extensions, environ)
+    load_extensions(
+        default_extension, extensions, strict_extensions, environ
+    )
 
     # I'm not sure that we need this since the modified DataPortal
     # does not require extensions to be explicitly loaded.
@@ -527,7 +583,7 @@ def run_algorithm(initialize,
         bundle_timestamp=bundle_timestamp,
         start=start,
         end=end,
-        output=os.devnull,
+        output=output,
         print_algo=False,
         local_namespace=False,
         environ=environ,

docs/source/beginner-tutorial.rst

@@ -5,9 +5,8 @@ Basics
 ~~~~~~
 
 Catalyst is an open-source algorithmic trading simulator for crypto
-assets written in Python.
+assets written in Python. The source code can be found at: 
-
+https://github.com/enigmampc/catalyst
-The source can be found at: https://github.com/enigmampc/catalyst
 
 Some benefits include:
 
@@ -25,8 +24,7 @@ Some benefits include:
    build profitable, data-driven investment strategies.
 
 This tutorial assumes that you have Catalyst correctly installed, see the
-:doc:`installation instructions <install>` if you haven't set up 
+:doc:`Install<install>` section if you haven't set up Catalyst yet.
-Catalyst yet.
 
 Every ``catalyst`` algorithm consists of at least two functions you have to
 define:
@@ -40,10 +38,12 @@ Before the start of the algorithm, ``catalyst`` calls the
 need to access from one algorithm iteration to the next.
 
 After the algorithm has been initialized, ``catalyst`` calls the
-``handle_data()`` function once for each event. At every call, it passes
+``handle_data()`` function on each iteration, that's one per day (daily) or 
-the same ``context`` variable and an event-frame called ``data``
+once every minute (minute), depending on the frequency we choose to run our 
-containing the current trading bar with open, high, low, and close
+simulation. On every iteration, ``handle_data()`` passes the same ``context`` 
-(OHLC) prices as well as volume for each crypto asset in your universe. 
+variable and an event-frame called ``data`` containing the current trading bar 
+with open, high, low, and close (OHLC) prices as well as volume for each 
+crypto asset in your universe. 
 
 .. For more information on these functions, see the `relevant part of the
 .. Quantopian docs <https://www.quantopian.com/help#api-toplevel>`.
@@ -51,8 +51,8 @@ containing the current trading bar with open, high, low, and close
 My first algorithm
 ~~~~~~~~~~~~~~~~~~
 
-Lets take a look at a very simple algorithm from the ``examples``
+Lets take a look at a very simple algorithm from the ``examples`` directory: 
-directory: `buy_btc_simple.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_btc_simple.py>`_:
+`buy_btc_simple.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_btc_simple.py>`_:
 
 .. code-block:: python
 
@@ -70,9 +70,9 @@ directory: `buy_btc_simple.py <https://github.com/enigmampc/catalyst/blob/master
 
 As you can see, we first have to import some functions we would like to
 use. All functions commonly used in your algorithm can be found in
-``catalyst.api``. Here we are using :func:`~catalyst.api.order()` which takes two
+``catalyst.api``. Here we are using :func:`~catalyst.api.order()` which takes 
-arguments: a cryptoasset object, and a number specifying how many assets you would
+twoarguments: a cryptoasset object, and a number specifying how many assets you 
-like to order (if negative, :func:`~catalyst.api.order()` will sell/short
+wouldlike to order (if negative, :func:`~catalyst.api.order()` will sell/short
 assets). In this case we want to order 1 bitcoin at each iteration. 
 
 .. For more documentation on ``order()``, see the `Quantopian docs
@@ -88,61 +88,98 @@ a bitcoin in the ``data`` event frame.
 
 .. (for more information see `here <https://www.quantopian.com/help#api-event-properties>`__.
 
-Running the algorithm
-~~~~~~~~~~~~~~~~~~~~~
-
-To can now test this algorithm on crypto data, ``catalyst`` provides three
-interfaces: 
-
--  A command-line interface,
--  ``IPython Notebook`` magic, 
--  and :func:`~catalyst.run_algorithm`.
-
 Ingesting data
-^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~
 
-In previous versions of Catalyst you needed to manually ingest data before running
+Before you can backtest your algorithm, you first need to load the historical 
-your algorithm to make it available at runtime. Starting with version 0.3, the
+pricing data that Catalyst needs to run your simulation through a process called
-algorithm will automagically ingest the data it needs the first time that encounters 
+``ingestion``. When you ingest data, Catalyst downloads that data in compressed 
-a data request for data that it doesn't have.
+form from the Enigma servers (which eventually will migrate to the Enigma Data 
+Marketplace), and stores it locally to make it available at runtime. 
 
-Still, we believe it is important for you to have a high-level understanding
+In order to ingest data, you need to run a command like the following:
-of how data is managed:
+
+.. code-block:: bash
+
+  catalyst ingest-exchange -x bitfinex -i btc_usd
+
+This instructs Catalyst to download pricing data from the ``Bitfinex`` exchange 
+for the ``btc_usd`` currency pair (this follows from the simple algorithm 
+presented above where we want to trade ``btc_usd``), and we're choosing to test
+our algorithm using historical pricing data from the Bitfinex exchange. By 
+default, Catalyst assumes that you want data with ``daily`` frequency (one candle
+bar per day). If you want instead ``minute`` frequency (one candle bar for every
+minute), you would need to specify it as follows:
+
+.. code-block:: bash
+
+  catalyst ingest-exchange -x bitfinex -i btc_usd -f minute
+
+.. parsed-literal::
+
+  Ingesting exchange bundle bitfinex...
+    [====================================]  Ingesting daily price data on bitfinex:  100%
+
+We believe it is important for you to have a high-level understanding of how 
+data is managed, hence the following overview:
 
 -  Pricing data is split and packaged into ``bundles``: chunks of data organized 
    as time series that are kept up to date daily on Enigma's servers. Catalyst 
-   downloads the bundles that needs at any given time, and reconstructs the whole
+   downloads the requested bundles and reconstructs the full dataset in your 
-   dataset in your hard drive.
+   hard drive.
 
--  Pricing data is provided in ``daily`` and ``minute`` resolution. Those are different
+-  Pricing data is provided in ``daily`` and ``minute`` resolution. Those are 
-   bundle datasets, and are managed separately.
+   different bundle datasets, and are managed separately.
 
--  Bundles are exchange-specific, as the pricing data is specific to the trades that
+-  Bundles are exchange-specific, as the pricing data is specific to the trades 
-   happen in each exchange. You can optionally specify which exchange you want pricing
+   that happen in each exchange. As a result, you can must specify which 
-   data from.
+   exchange you want pricing data from when ingesting data
 
--  Catalyst keeps track of all the downloaded bundles, so that it only has to download
+-  Catalyst keeps track of all the downloaded bundles, so that it only has to 
-   them once, and will do incremental updates as needed.
+   download them once, and will do incremental updates as needed.
 
--  When running in ``live trading`` mode, Catalyst will first look for historical 
+-  When running in ``live trading`` mode, Catalyst will first look for 
-   pricing data in the locally stored bundles. If there is anything missing, Catalyst will
+   historical pricing data in the locally stored bundles. If there is anything 
-   hit the exchange for the most recent data, and merge it with the local bundle to make
+   missing, Catalyst will hit the exchange for the most recent data, and merge 
-   it available for future iterations.
+   it with the local bundle to optimize the number of requests it needs to make 
+   to the exchange.
 
-If you want to learn more, check out the :ref:`ingesting data <ingesting-data>` section
+The ``ingest-exchange`` command in catalyst offers additional parameters to 
-for more detail.
+further tweak the data ingestion process. You can learn more by running the
+following from the command line:
+
+.. code-block:: bash
+
+  catalyst ingest-exchange --help
+
+Running the algorithm
+~~~~~~~~~~~~~~~~~~~~~
+
+You can now test your algorithm using cryptoassets' historical pricing data, 
+``catalyst`` provides three interfaces: 
+
+-  A command-line interface (CLI),
+-  the ``IPython Notebook`` magic,
+-  and a :func:`~catalyst.run_algorithm` that you can call from other 
+   Python scripts.
+
+We'll start with the CLI, and introduce the ``IPython Notebook`` below. Some of 
+the :doc:`example algorithms <example-algos>` provide instructions on how to run
+them both from the CLI, and using the :func:`~catalyst.run_algorithm` function.
 
 Command line interface
 ^^^^^^^^^^^^^^^^^^^^^^
 
-After you installed Catalyst you should be able to execute the following
+After you installed Catalyst, you should be able to execute the following
-from your command line (e.g. ``cmd.exe`` on Windows, or the Terminal app
+from your command line (e.g. ``cmd.exe`` or the ``Anaconda Prompt`` on Windows, 
-on OSX). Displaying here a simplified output for eductional purposes:
+or the Terminal application on MacOS). 
 
 .. code-block:: bash
 
    $ catalyst --help
 
+This is the resulting output, simplified for eductional purposes:
+
 .. parsed-literal::
 
      Usage: catalyst [OPTIONS] COMMAND [ARGS]...
@@ -158,10 +195,11 @@ on OSX). Displaying here a simplified output for eductional purposes:
        live             Trade live with the given algorithm.
        run              Run a backtest for the given algorithm.
 
-There are three main modes you can run on Catalyst. The first being ``ingest-exchange`` 
+There are three main modes you can run on Catalyst. The first being 
-for data ingestion, which we have summarized in the previous section. The second 
+``ingest-exchange`` for data ingestion, which we have covered in the previous 
-is ``live`` to use your algorithm to trade live against a given exchange, and the 
+section. The second is ``live`` to use your algorithm to trade live against a 
-third mode ``run`` is to backtest your algorithm before trading live with it.
+given exchange, and the third mode ``run`` is to backtest your algorithm before 
+trading live with it.
 
 Let's start with backtesting, so run this other command to learn more about 
 the available options:
@@ -210,22 +248,24 @@ the available options:
 
 
 As you can see there are a couple of flags that specify where to find your
-algorithm (``-f``) as well as a parameter to specify which exchange to use. 
+algorithm (``-f``) as well as a the ``-x`` flag to specify which exchange to 
-There are also arguments for the date range to run the algorithm over 
+use. There are also arguments for the date range to run the algorithm over 
-(``--start`` and ``--end``). Finally, you'll want to save the performance 
+(``--start`` and ``--end``). You also need to set the base currency for your 
-metrics of your algorithm so that you can analyze how it performed. This is 
+algorithm through the ``-c`` flag, and the ``--capital_base``. All the 
-done via the ``--output`` flag and will cause it to write the performance 
+aforementioned parameters are required. Optionally, you will want to save the 
-``DataFrame`` in the pickle Python file format. Note that you can also define 
+performance metrics of your algorithm so that you can analyze how it performed. 
-a configuration file with these parameters that you can then conveniently pass 
+This is done via the ``--output`` flag and will cause it to write the 
-to the ``-c`` option so that you don't have to supply the command line args 
+performance ``DataFrame`` in the pickle Python file format. Note that you can 
-all the time (see the .conf files in the examples directory).
+also define a configuration file with these parameters that you can then 
+conveniently pass to the ``-c`` option so that you don't have to supply the 
+command line args all the time.
 
 Thus, to execute our algorithm from above and save the results to
 ``buy_btc_simple_out.pickle`` we would call ``catalyst run`` as follows:
 
 .. code-block:: python
 
-    catalyst run -f buy_btc_simple.py -x bitfinex --start 2016-1-1 --end 2017-9-30 -o buy_btc_simple_out.pickle
+    catalyst run -f buy_btc_simple.py -x bitfinex --start 2016-1-1 --end 2017-9-30 -c usd --capital-base 100000 -o buy_btc_simple_out.pickle
 
 
 .. parsed-literal:: 
@@ -253,17 +293,25 @@ slippage model that ``catalyst`` uses).
 .. see the `Quantopian docs <https://www.quantopian.com/help#ide-slippage>`__
 .. for more information).
 
-Let's take a quick look at the performance ``DataFrame``. For this, we
+
-use ``pandas`` from inside the IPython Notebook and print the first ten
+Let's take a quick look at the performance ``DataFrame``. For this, we write 
-rows. Note that ``catalyst`` makes heavy usage of 
+different Python script--let's call it ``print_results.py``--and we make use of 
-`pandas <http://pandas.pydata.org/>`_, especially for data input and 
+the fantastic ``pandas`` library to print the first ten rows. Note that 
-outputting so it's worth spending some time to learn it.
+``catalyst`` makes heavy usage of `pandas <http://pandas.pydata.org/>`_, 
+especially for data analysis and outputting so it's worth spending some time to 
+learn it.
 
 .. code-block:: python
 
     import pandas as pd
     perf = pd.read_pickle('buy_btc_simple_out.pickle') # read in perf DataFrame
-    perf.head()
+    print(perf.head())
+
+Which we execute by running:
+
+.. code-block:: bash
+
+   $ python print_results.py
 
 .. raw:: html
 
@@ -429,30 +477,48 @@ and allows us to plot the price of bitcoin. For example, we could easily
 examine now how our portfolio value changed over time compared to the
 bitcoin price.
 
-.. code-block:: python
+Now we will run the simulation again, but this time we extend our original 
-
+algorithm with the addition of the ``analyze()`` function. Somewhat analogously 
-    %load_ext catalyst
+as how ``initialize()`` gets called once before the start of the algorith, 
+``analyze()`` gets called once at the end of the algorithm, and receives two 
+variables: ``context``, which we discussed at the very beginning, and ``perf``, 
+which is the pandas dataframe containing the performance data for our algorithm 
+that we reviewed above. Inside the ``analyze()`` function is where we can 
+analyze and visualize the results of our strategy. Here's the revised simple 
+algorithm (note the addition of Line 1, and Lines 11-18)
 
 .. code-block:: python
 
-    %pylab inline
-    figsize(12, 12)
     import matplotlib.pyplot as plt
+    from catalyst.api import order, record, symbol
 
-    ax1 = plt.subplot(211)
+    def initialize(context):
-    perf.portfolio_value.plot(ax=ax1)
+        context.asset = symbol('btc_usd')
-    ax1.set_ylabel('portfolio value')
-    ax2 = plt.subplot(212, sharex=ax1)
-    perf.btc.plot(ax=ax2)
-    ax2.set_ylabel('bitcoin price')
 
-.. parsed-literal::
+    def handle_data(context, data):
+        order(context.asset, 1)
+        record(btc = data.current(context.asset, 'price'))
 
-    Populating the interactive namespace from numpy and matplotlib
+    def analyze(context, perf):
+        ax1 = plt.subplot(211)
+        perf.portfolio_value.plot(ax=ax1)
+        ax1.set_ylabel('portfolio value')
+        ax2 = plt.subplot(212, sharex=ax1)
+        perf.btc.plot(ax=ax2)
+        ax2.set_ylabel('bitcoin price')
+        plt.show()
 
-.. parsed-literal::
+Here we make use of the external visualization library called 
+`matplotlib <https://matplotlib.org/>`_, which you might recall we installed 
+alongside enigma-catalyst (with the exception of the ``Conda`` install, where it
+was included by default inside the conda environment we created). If for any 
+reason you don't have it installed, you can add it by running:
 
-    <matplotlib.text.Text at 0x10eaeadd0>
+.. code-block:: python
+
+  (catalyst)$ pip install matplotlib
+
+If everything works well, you'll see the following chart:
 
 .. image:: https://s3.amazonaws.com/enigmaco-docs/github.io/buy_btc_simple_graph.png
 
@@ -460,6 +526,22 @@ Our algorithm performance as assessed by the ``portfolio_value`` closely
 matches that of the bitcoin price. This is not surprising as our algorithm 
 only bought bitcoin every chance it got.
 
+  If you get an error when invoking matplotlib to visualize the performance 
+  results refer to `MacOS + Matplotlib <install.html#macos-virtualenv-matplotlib>`_. 
+  Alternatively, some users have reported the following error when running an algo 
+  in a Linux environment:
+
+  .. parsed-literal::
+
+      ImportError: No module named _tkinter, please install the python-tk package
+
+  Which can easily solved by running (in Ubuntu/Debian-based systems):
+
+  .. code-block:: python
+
+      sudo apt install python-tk
+
+
 
 Access to previous prices using ``history``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/source/example-algos.rst

@@ -0,0 +1,444 @@
+|
+Example Algorithms
+==================
+
+This section documents a small number of example algorithms to complement the 
+beginner tutorial, and show how other trading algorithms can be implemented 
+using Catalyst:
+
+.. _buy_and_hodl:
+
+Buy and Hodl Algorithm
+~~~~~~~~~~~~~~~~~~~~~~
+
+source: `examples/buy_and_hodl.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_and_hodl.py>`_
+
+First ingest the historical pricing data needed to run this algorithm:
+
+.. code-block:: bash
+
+   catalyst ingest-exchange -x poloniex -f daily -i btc_usdt
+
+Then, you can run the code below with the following command:
+
+.. code-block:: bash
+
+   catalyst run -f buy_and_hodl.py --start 2015-3-1 --end 2017-10-31 --capital-base 100000 -x poloniex -c btc -o bah.pickle
+
+This command will run the trading algorithm in the specified time range and 
+plot the resulting performance using the matplotlib library. You can choose any 
+date interval with the ``--start`` and ``--end`` parameters, but bear in mind 
+that 2015-3-1 is the earliest date that Catalyst supports (if you choose an 
+earlier date, you'll get an error), and the most recent date you can choose is 
+one day prior to the current date. 
+
+
+.. code-block:: python
+
+   #!/usr/bin/env python
+   #
+   # Copyright 2017 Enigma MPC, Inc.
+   # Copyright 2015 Quantopian, Inc.
+   #
+   # Licensed under the Apache License, Version 2.0 (the "License");
+   # you may not use this file except in compliance with the License.
+   # You may obtain a copy of the License at
+   #
+   #     http://www.apache.org/licenses/LICENSE-2.0
+   #
+   # Unless required by applicable law or agreed to in writing, software
+   # distributed under the License is distributed on an "AS IS" BASIS,
+   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   # See the License for the specific language governing permissions and
+   # limitations under the License.
+   import pandas as pd
+
+   from catalyst.api import (
+       order_target_value,
+       symbol,
+       record,
+       cancel_order,
+       get_open_orders,
+   )
+
+
+   def initialize(context):
+       context.ASSET_NAME = 'btc_usdt'
+       context.TARGET_HODL_RATIO = 0.8
+       context.RESERVE_RATIO = 1.0 - context.TARGET_HODL_RATIO
+
+       context.is_buying = True
+       context.asset = symbol(context.ASSET_NAME)
+
+       context.i = 0
+
+
+   def handle_data(context, data):
+       context.i += 1
+
+       starting_cash = context.portfolio.starting_cash
+       target_hodl_value = context.TARGET_HODL_RATIO * starting_cash
+       reserve_value = context.RESERVE_RATIO * starting_cash
+
+       # Cancel any outstanding orders
+       orders = get_open_orders(context.asset) or []
+       for order in orders:
+           cancel_order(order)
+
+       # Stop buying after passing the reserve threshold
+       cash = context.portfolio.cash
+       if cash <= reserve_value:
+           context.is_buying = False
+
+       # Retrieve current asset price from pricing data
+       price = data.current(context.asset, 'price')
+
+       # Check if still buying and could (approximately) afford another purchase
+       if context.is_buying and cash > price:
+           # Place order to make position in asset equal to target_hodl_value
+           order_target_value(
+               context.asset,
+               target_hodl_value,
+               limit_price=price * 1.1,
+               stop_price=price * 0.9,
+           )
+
+       record(
+           price=price,
+           volume=data.current(context.asset, 'volume'),
+           cash=cash,
+           starting_cash=context.portfolio.starting_cash,
+           leverage=context.account.leverage,
+       )
+
+
+   def analyze(context=None, results=None):
+       import matplotlib.pyplot as plt
+
+       # Plot the portfolio and asset data.
+       ax1 = plt.subplot(611)
+       results[['portfolio_value']].plot(ax=ax1)
+       ax1.set_ylabel('Portfolio Value (USD)')
+
+       ax2 = plt.subplot(612, sharex=ax1)
+       ax2.set_ylabel('{asset} (USD)'.format(asset=context.ASSET_NAME))
+       results[['price']].plot(ax=ax2)
+
+       trans = results.ix[[t != [] for t in results.transactions]]
+       buys = trans.ix[
+           [t[0]['amount'] > 0 for t in trans.transactions]
+       ]
+       ax2.plot(
+           buys.index,
+           results.price[buys.index],
+           '^',
+           markersize=10,
+           color='g',
+       )
+
+       ax3 = plt.subplot(613, sharex=ax1)
+       results[['leverage', 'alpha', 'beta']].plot(ax=ax3)
+       ax3.set_ylabel('Leverage ')
+
+       ax4 = plt.subplot(614, sharex=ax1)
+       results[['starting_cash', 'cash']].plot(ax=ax4)
+       ax4.set_ylabel('Cash (USD)')
+
+       results[[
+           'treasury',
+           'algorithm',
+           'benchmark',
+       ]] = results[[
+           'treasury_period_return',
+           'algorithm_period_return',
+           'benchmark_period_return',
+       ]]
+
+       ax5 = plt.subplot(615, sharex=ax1)
+       results[[
+           'treasury',
+           'algorithm',
+           'benchmark',
+       ]].plot(ax=ax5)
+       ax5.set_ylabel('Percent Change')
+
+       ax6 = plt.subplot(616, sharex=ax1)
+       results[['volume']].plot(ax=ax6)
+       ax6.set_ylabel('Volume (mCoins/5min)')
+
+       plt.legend(loc=3)
+
+       # Show the plot.
+       plt.gcf().set_size_inches(18, 8)
+       plt.show()
+
+.. _mean_reversion:
+
+Mean Reversion Algorithm
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+source: `examples/mean_reversion_simple.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/mean_reversion_simple.py>`_
+
+This algorithm is based on a simple momentum strategy. When the cryptoasset goes
+up quickly, we're going to buy; when it goes down quickly, we're going to sell. 
+Hopefully, we'll ride the waves.
+
+We are choosing to run this trading algorithm with the ``neo_usd`` currency pair
+on the ``Bitfinex`` exchange. Thus, first ingest the historical pricing data
+that we need, with minute resolution:
+
+.. code-block:: bash
+
+   catalyst ingest-exchange -x bitfinex -f minute -i neo_usd
+
+To run this algorithm, we are opting for the Python interpreter, instead of the 
+command line (CLI). All of the parameters for the simulation are specified in 
+lines 218-245, so in order to run the algorithm we just type:
+
+.. code-block:: bash
+
+   python mean_reversion_simple.py
+
+.. code-block:: python
+
+   import pandas as pd
+   import talib
+   from logbook import Logger
+
+   from catalyst import run_algorithm
+   from catalyst.api import symbol, record, order_target_percent, get_open_orders
+   from catalyst.exchange.stats_utils import extract_transactions
+
+   # We give a name to the algorithm which Catalyst will use to persist its state.
+   # In this example, Catalyst will create the `.catalyst/data/live_algos`
+   # directory. If we stop and start the algorithm, Catalyst will resume its
+   # state using the files included in the folder.
+   NAMESPACE = 'mean_reversion_simple'
+   log = Logger(NAMESPACE)
+
+   # To run an algorithm in Catalyst, you need two functions: initialize and
+   # handle_data.
+
+   def initialize(context):
+       # This initialize function sets any data or variables that you'll use in
+       # your algorithm.  For instance, you'll want to define the trading pair (or
+       # trading pairs) you want to backtest.  You'll also want to define any
+       # parameters or values you're going to use.
+
+       # In our example, we're looking at Ether in USD Tether.
+       context.neo_usd = symbol('neo_usd')
+       context.base_price = None
+       context.current_day = None
+
+
+   def handle_data(context, data):
+       # This handle_data function is where the real work is done.  Our data is
+       # minute-level tick data, and each minute is called a frame.  This function
+       # runs on each frame of the data.
+
+       # We flag the first period of each day.
+       # Since cryptocurrencies trade 24/7 the `before_trading_starts` handle
+       # would only execute once. This method works with minute and daily
+       # frequencies.
+       today = data.current_dt.floor('1D')
+       if today != context.current_day:
+           context.traded_today = False
+           context.current_day = today
+
+       # We're computing the volume-weighted-average-price of the security
+       # defined above, in the context.neo_usd variable.  For this example, we're 
+       # using three bars on the 15 min bars.
+
+       # The frequency attribute determine the bar size. We use this convention
+       # for the frequency alias:
+       # http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases
+       prices = data.history(
+           context.neo_usd,
+           fields='close',
+           bar_count=50,
+           frequency='15T'
+       )
+
+       # Ta-lib calculates various technical indicator based on price and
+       # volume arrays.
+
+       # In this example, we are comp
+       rsi = talib.RSI(prices.values, timeperiod=14)
+
+       # We need a variable for the current price of the security to compare to
+       # the average. Since we are requesting two fields, data.current()
+       # returns a DataFrame with
+       current = data.current(context.neo_usd, fields=['close', 'volume'])
+       price = current['close']
+
+       # If base_price is not set, we use the current value. This is the
+       # price at the first bar which we reference to calculate price_change.
+       if context.base_price is None:
+           context.base_price = price
+
+       price_change = (price - context.base_price) / context.base_price
+       cash = context.portfolio.cash
+
+       # Now that we've collected all current data for this frame, we use
+       # the record() method to save it. This data will be available as
+       # a parameter of the analyze() function for further analysis.
+       record(
+           price=price,
+           volume=current['volume'],
+           price_change=price_change,
+           rsi=rsi[-1],
+           cash=cash
+       )
+
+       # We are trying to avoid over-trading by limiting our trades to
+       # one per day.
+       if context.traded_today:
+           return
+
+       # Since we are using limit orders, some orders may not execute immediately
+       # we wait until all orders are executed before considering more trades.
+       orders = get_open_orders(context.neo_usd)
+       if len(orders) > 0:
+           return
+
+       # Exit if we cannot trade
+       if not data.can_trade(context.neo_usd):
+           return
+
+       # Another powerful built-in feature of the Catalyst backtester is the
+       # portfolio object.  The portfolio object tracks your positions, cash,
+       # cost basis of specific holdings, and more.  In this line, we calculate
+       # how long or short our position is at this minute.   
+       pos_amount = context.portfolio.positions[context.neo_usd].amount
+
+       if rsi[-1] <= 30 and pos_amount == 0:
+           log.info(
+               '{}: buying - price: {}, rsi: {}'.format(
+                   data.current_dt, price, rsi[-1]
+               )
+           )
+           order_target_percent(context.neo_usd, 1)
+           context.traded_today = True
+
+       elif rsi[-1] >= 80 and pos_amount > 0:
+           log.info(
+               '{}: selling - price: {}, rsi: {}'.format(
+                   data.current_dt, price, rsi[-1]
+               )
+           )
+           order_target_percent(context.neo_usd, 0)
+           context.traded_today = True
+
+
+   def analyze(context=None, perf=None):
+       import matplotlib.pyplot as plt
+
+       # The base currency of the algo exchange
+       base_currency = context.exchanges.values()[0].base_currency.upper()
+
+       # Plot the portfolio value over time.
+       ax1 = plt.subplot(611)
+       perf.loc[:, 'portfolio_value'].plot(ax=ax1)
+       ax1.set_ylabel('Portfolio Value ({})'.format(base_currency))
+
+       # Plot the price increase or decrease over time.
+       ax2 = plt.subplot(612, sharex=ax1)
+       perf.loc[:, 'price'].plot(ax=ax2, label='Price')
+
+       ax2.set_ylabel('{asset} ({base})'.format(
+           asset=context.neo_usd.symbol, base=base_currency
+       ))
+
+       transaction_df = extract_transactions(perf)
+       if not transaction_df.empty:
+           buy_df = transaction_df[transaction_df['amount'] > 0]
+           sell_df = transaction_df[transaction_df['amount'] < 0]
+           ax2.scatter(
+               buy_df.index.to_pydatetime(),
+               perf.loc[buy_df.index, 'price'],
+               marker='^',
+               s=100,
+               c='green',
+               label=''
+           )
+           ax2.scatter(
+               sell_df.index.to_pydatetime(),
+               perf.loc[sell_df.index, 'price'],
+               marker='v',
+               s=100,
+               c='red',
+               label=''
+           )
+
+       ax4 = plt.subplot(613, sharex=ax1)
+       perf.loc[:, 'cash'].plot(
+           ax=ax4, label='Base Currency ({})'.format(base_currency)
+       )
+       ax4.set_ylabel('Cash ({})'.format(base_currency))
+
+       perf['algorithm'] = perf.loc[:, 'algorithm_period_return']
+
+       ax5 = plt.subplot(614, sharex=ax1)
+       perf.loc[:, ['algorithm', 'price_change']].plot(ax=ax5)
+       ax5.set_ylabel('Percent Change')
+
+       ax6 = plt.subplot(615, sharex=ax1)
+       perf.loc[:, 'rsi'].plot(ax=ax6, label='RSI')
+       ax6.axhline(70, color='darkgoldenrod')
+       ax6.axhline(30, color='darkgoldenrod')
+
+       if not transaction_df.empty:
+           ax6.scatter(
+               buy_df.index.to_pydatetime(),
+               perf.loc[buy_df.index, 'rsi'],
+               marker='^',
+               s=100,
+               c='green',
+               label=''
+           )
+           ax6.scatter(
+               sell_df.index.to_pydatetime(),
+               perf.loc[sell_df.index, 'rsi'],
+               marker='v',
+               s=100,
+               c='red',
+               label=''
+           )
+       plt.legend(loc=3)
+
+       # Show the plot.
+       plt.gcf().set_size_inches(18, 8)
+       plt.show()
+       pass
+
+
+   if __name__ == '__main__':
+       # The execution mode: backtest or live
+       MODE = 'backtest'
+
+       if MODE == 'backtest':
+           # catalyst run -f catalyst/examples/mean_reversion_simple.py -x poloniex -s 2017-10-1 -e 2017-11-10 -c usdt -n mean-reversion --data-frequency minute --capital-base 10000
+           run_algorithm(
+               capital_base=10000,
+               data_frequency='minute',
+               initialize=initialize,
+               handle_data=handle_data,
+               analyze=analyze,
+               exchange_name='bitfinex',
+               algo_namespace=NAMESPACE,
+               base_currency='usd',
+               start=pd.to_datetime('2017-10-1', utc=True),
+               end=pd.to_datetime('2017-11-10', utc=True),
+           )
+
+       elif MODE == 'live':
+           run_algorithm(
+               initialize=initialize,
+               handle_data=handle_data,
+               analyze=analyze,
+               exchange_name='bitfinex',
+               live=True,
+               algo_namespace=NAMESPACE,
+               base_currency='usd',
+               live_graph=True
+           )

docs/source/index.rst

@@ -12,6 +12,8 @@ Table of Contents
    jupyter
    live-trading
    naming-convention
+   example-algos
+   utilities
    videos
    resources
    development-guidelines

docs/source/install.rst

@@ -6,7 +6,154 @@ Like any other piece of software, Catalyst has a number of dependencies
 (other software on which it depends to run) that you will need to install, as 
 well. We recommend using a software named ``Conda`` that will manage all 
 these dependencies for you, and set up the environment needed to get you up 
-and running as easily as possible. See :ref:`Installing with Conda <conda>`.
+and running as easily as possible. This is the recommended installation method
+for Windows, MacOS and Linux. See :ref:`Installing with Conda <conda>`.
+
+What conda does is create a pre-configured environment, and inside that 
+environment install Catalyst using ``pip``, Python's package manager. Thus, 
+as an alternative installation method for MacOS and Linux, you can install 
+Catalyst directly with ``pip`` (we recommend in combination with a virtual 
+environemnt). See :ref:`Installing with pip <pip>`.
+
+Regardless of the method, each operating system (OS), has its own 
+prerequisites, make sure to review the corresponding sections for your system:
+:ref:`Linux <linux>`, :ref:`MacOS <macos>` and :ref:`Windows <windows>`.
+
+.. _conda:
+
+Installing with ``conda``
+-------------------------
+
+The preferred method to install Catalyst is via the ``conda`` package manager, 
+which comes as part of Continuum Analytics' `Anaconda
+<http://continuum.io/downloads>`_ distribution.
+
+The primary advantage of using Conda over ``pip`` is that conda natively
+understands the complex binary dependencies of packages like ``numpy`` and
+``scipy``.  This means that ``conda`` can install Catalyst and its 
+dependencies without requiring the use of a second tool to acquire Catalyst's 
+non-Python dependencies.
+
+  For Windows, you will first need to install the *Microsoft Visual C++ 
+  Compiler for Python 2.7*. Follow the instructions on the :ref:`Windows 
+  <windows>` section and come back here.
+
+For instructions on how to install ``conda``, see the `Conda Installation
+Documentation <http://conda.pydata.org/docs/download.html>`_. Alternatively, 
+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:
+
+1. Download `MiniConda <https://conda.io/miniconda.html>`_. Select Python 2.7 
+   for your Operating System.
+2. Install MiniConda. See the `Installation Instructions 
+   <https://conda.io/docs/user-guide/install/index.html>`_ if you need help.
+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 
+   <https://github.com/enigmampc/catalyst/blob/master/etc/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.
+
+   .. code-block:: bash
+
+      conda env create -f python2.7-environment.yml
+
+4. Activate the environment (which you need to do every time you start a new 
+   session to run Catalyst):
+
+   **Linux or MacOS:**
+
+   .. code-block:: bash
+
+      source activate catalyst
+
+   **Windows:**
+
+   .. code-block:: bash
+
+      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
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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. 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
+
+3. Activate the environment:
+
+   **Linux or MacOS:**
+
+   .. code-block:: bash
+
+      source activate catalyst
+
+   **Windows:**
+
+   .. code-block:: bash
+
+      activate catalyst
+
+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.
+
+.. _pip:
 
 Installing with ``pip``
 -----------------------
@@ -28,15 +175,21 @@ Because LAPACK and the CPython headers are non-Python dependencies, the
 correctway to install them varies from platform to platform.  If you'd rather 
 use a single tool to install Python and non-Python dependencies, or if you're 
 already using `Anaconda <http://continuum.io/downloads>`_ as your Python 
-distribution, you can skip to the :ref:`Installing with Conda <conda>` 
+distribution, refer to the :ref:`Installing with Conda <conda>` section.
-section.
 
-Once you've installed the necessary additional dependencies (see below for
+Once you've installed the necessary additional dependencies for your system 
-your particular platform), you should be able to simply run
+(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
+   $ 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
@@ -50,153 +203,7 @@ summarized version:
    $ pip install virtualenv
    $ virtualenv catalyst-venv
    $ source ./catalyst-venv/bin/activate
-   $ pip install enigma-catalyst
+   $ pip install enigma-catalyst matplotlib
-
-Though not required by Catalyst directly, our example algorithms use 
-matplotlib to visually display the results of the trading algorithms. If you 
-wish to run any examples or use matplotlib during development, it can be 
-installed using:
-
-.. code-block:: bash
-
-    $ pip install matplotlib
-
-GNU/Linux
-~~~~~~~~~
-
-On `Debian-derived`_ Linux distributions, you can acquire all the necessary
-binary dependencies from ``apt`` by running:
-
-.. code-block:: bash
-
-   $ sudo apt-get install libatlas-base-dev python-dev gfortran pkg-config libfreetype6-dev
-
-On recent `RHEL-derived`_ derived Linux distributions (e.g. Fedora), the
-following should be sufficient to acquire the necessary additional
-dependencies:
-
-.. code-block:: bash
-
-   $ sudo dnf install atlas-devel gcc-c++ gcc-gfortran libgfortran python-devel redhat-rep-config
-
-On `Arch Linux`_, you can acquire the additional dependencies via ``pacman``:
-
-.. code-block:: bash
-
-   $ pacman -S lapack gcc gcc-fortran pkg-config
-
-.. Commenting it out until Catalyst fully supports Python 3.X
-..
-.. There are also AUR packages available for installing `Python 3.4
-.. <https://aur.archlinux.org/packages/python34/>`_ (Arch's default python is now
-.. 3.5, but Catalyst only currently supports 3.4), and `ta-lib
-.. <https://aur.archlinux.org/packages/ta-lib/>`_, an optional Catalyst dependency.
-.. Python 2 is also installable via:
-
-.. 
-
-..   $ pacman -S python2
-
-OSX
-~~~
-
-The version of Python shipped with OSX by default is generally out of date, 
-and has a number of quirks because it's used directly by the operating system.
-For these reasons, many developers choose to install and use a separate Python
-installation. The `Hitchhiker's Guide to Python`_ provides an excellent guide
-to `Installing Python on OSX <http://docs.python-guide.org/en/latest/>`_, 
-which explains how to install Python with the `Homebrew`_ manager.
-
-Assuming you've installed Python with Homebrew, you'll also likely need the
-following brew packages:
-
-.. code-block:: bash
-
-   $ brew install freetype pkg-config gcc openssl
-
-OSX + virtualenv + matplotlib
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-A note about using matplotlib in virtual enviroments on OSX: it may be 
-necessary to run
-
-.. code-block:: bash
-
-   echo "backend: TkAgg" > ~/.matplotlib/matplotlibrc
-
-in order to override the default ``macosx`` backend for your system, which 
-may not be accessible from inside the virtual environment. This will allow 
-Catalyst to open matplotlib charts from within a virtual environment, which 
-is useful for displaying the performance of your backtests.  To learn more 
-about matplotlib backends, please refer to the
-`matplotlib backend documentation <https://matplotlib.org/faq/usage_faq.html#what-is-a-backend>`_.
-
-.. _windows:
-
-Windows
-~~~~~~~
-
-In Windows, you will need the `Microsoft Visual C++ Compiler for Python 2.7 
-<https://www.microsoft.com/en-us/download/details.aspx?id=44266>`_. 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 <conda>`.
-
-Some problems we have encountered installing the **Visual C++ Compiler** 
-mentioned above are as follows:
-
-- **The system administrator has set policies to prevent this installation**.
-  
-  In some systems, there is a default *Windows Software Restriction* policy 
-  that prevents the installation of some software packages like this one. 
-  You'll have to change the Registry to circumvent this:
-
-  - Click ``Start``, and search for ``regedit`` and launch the 
-    ``Registry Editor``
-  - Navigate to the following folder:
-    ``HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\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 
-    default you get 0 as the Value Data)
-
-|
-- **The installer has encountered an unexpected error installing this package. 
-  This may indicate a problem with this package. The error code is 2503.**
-
-  We have observed this when trying to install a package without enough 
-  administrator permissions. Even when you are logged in as an Administrator, 
-  you have to explictily install this package with administrator privileges:
-
-  - Click ``Start`` and find ``CMD`` or ``Command Prompt``
-  - Right click on it and choose ``Run as administrator``
-  - ``cd`` into the folder where you downloaded ``VCForPython27.msi``
-  - Run ``msiexec /i VCForPython27.msi``
-
-
-Amazon Linux AMI
-~~~~~~~~~~~~~~~~
-
-The packages ``pip`` and ``setuptools`` that come shipped by default are very 
-outdated. Thus, you first need to run:
-
-.. code-block:: bash
-
-   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++
-
-Then you should follow the regular installation instructions outlined at the 
-beginning of this page.
-
 
 Troubleshooting ``pip`` Install
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -287,99 +294,150 @@ Troubleshooting ``pip`` Install
       sudo apt-get install python-dev
 
 
-.. _conda:
+.. _linux:
 
-Installing with ``conda``
+GNU/Linux Requirements
--------------------------
+----------------------
 
-Another way to install Catalyst is via the ``conda`` package manager, which
+On `Debian-derived`_ Linux distributions, you can acquire all the necessary
-comes as part of Continuum Analytics' `Anaconda
+binary dependencies from ``apt`` by running:
-<http://continuum.io/downloads>`_ distribution.
 
-The primary advantage of using Conda over ``pip`` is that conda natively
+.. code-block:: bash
-understands the complex binary dependencies of packages like ``numpy`` and
-``scipy``.  This means that ``conda`` can install Catalyst and its 
-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 
+   $ sudo apt-get install libatlas-base-dev python-dev gfortran pkg-config libfreetype6-dev
-  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
+On recent `RHEL-derived`_ derived Linux distributions (e.g. Fedora), the
-Documentation <http://conda.pydata.org/docs/download.html>`_. Alternatively, 
+following should be sufficient to acquire the necessary additional
-you can install MiniConda, which is a smaller footprint (fewer packages and 
+dependencies:
-smaller size) than its big brother Anaconda, but it still contains all the 
-main packages needed. To install MiniConda, you can follow these steps:
 
-1. Download `MiniConda <https://conda.io/miniconda.html>`_. Select Python 2.7 
+.. code-block:: bash
-   for your Operating System.
-2. Install MiniConda. See the `Installation Instructions 
-   <https://conda.io/docs/user-guide/install/index.html>`_ if you need help.
-3. Ensure the correct installation by running ``conda list`` in a Terminal 
-   window, which should print the list of packages installed with Conda.
 
-Once either Conda or MiniConda has been set up you can install Catalyst:
+   $ sudo dnf install atlas-devel gcc-c++ gcc-gfortran libgfortran python-devel redhat-rep-config
 
-1. Download the file `python2.7-environment.yml 
+On `Arch Linux`_, you can acquire the additional dependencies via ``pacman``:
-   <https://github.com/enigmampc/catalyst/blob/master/etc/python2.7-environment.yml>`_.
-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.
 
-   .. code-block:: bash
+.. code-block:: bash
 
-      conda env create -f python2.7-environment.yml
+   $ pacman -S lapack gcc gcc-fortran pkg-config
 
-4. Activate the environment (which you need to do every time you start a new 
+.. Commenting it out until Catalyst fully supports Python 3.X
-   session to run Catalyst):
+..
+.. There are also AUR packages available for installing `Python 3.4
+.. <https://aur.archlinux.org/packages/python34/>`_ (Arch's default python is now
+.. 3.5, but Catalyst only currently supports 3.4), and `ta-lib
+.. <https://aur.archlinux.org/packages/ta-lib/>`_, an optional Catalyst dependency.
+.. Python 2 is also installable via:
 
-   **Linux or OSX:**
+.. 
 
-   .. code-block:: bash
+..   $ pacman -S python2
 
-      source activate catalyst
+Amazon Linux AMI Notes
+~~~~~~~~~~~~~~~~~~~~~~
 
-   **Windows:**
+The packages ``pip`` and ``setuptools`` that come shipped by default are very 
+outdated. Thus, you first need to run:
 
-   .. code-block:: bash
+.. code-block:: bash
 
-      activate catalyst
+   pip install --upgrade pip setuptools
 
-Congratulations! You now have Catalyst installed.
+The default installation is also missing the C and C++ compilers, which you 
+install by:
 
-Troubleshooting ``conda`` Install
+.. code-block:: bash
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If the command  ``conda env create -f python2.7-environment.yml`` in step 3 
+   sudo yum install gcc gcc-c++
-above failed for any reason, you can try setting up the environment manually 
-with the following steps:
 
-1. Create the environment:
+Then you should follow the regular installation instructions outlined at the 
+beginning of this page.
 
-   .. code-block:: bash
 
-      conda create --name catalyst python=2.7 scipy zlib
+.. _MacOS:
 
-2. Activate the environment:
+MacOS Requirements
+------------------
 
-   **Linux or OSX:**
+The version of Python shipped with MacOS by default is generally out of date, 
+and has a number of quirks because it's used directly by the operating system.
+For these reasons, many developers choose to install and use a separate Python
+installation. The `Hitchhiker's Guide to Python`_ provides an excellent guide
+to `Installing Python on MacOS <http://docs.python-guide.org/en/latest/>`_, 
+which explains how to install Python with the `Homebrew`_ manager.
 
-   .. code-block:: bash
+Assuming you've installed Python with Homebrew, you'll also likely need the
+following brew packages:
 
-      source activate catalyst
+.. code-block:: bash
 
-   **Windows:**
+   $ brew install freetype pkg-config gcc openssl
 
-   .. code-block:: bash
+MacOS + virtualenv + matplotlib
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-      activate catalyst
+A note about using matplotlib in virtual enviroments on MacOS: it may be 
+necessary to run
 
-3. Install the Catalyst inside the environment:
+.. code-block:: bash
 
-   .. code-block:: bash
+   echo "backend: TkAgg" > ~/.matplotlib/matplotlibrc
 
-      pip install enigma-catalyst matplotlib
+in order to override the default ``MacOS`` backend for your system, which 
+may not be accessible from inside the virtual environment. This will allow 
+Catalyst to open matplotlib charts from within a virtual environment, which 
+is useful for displaying the performance of your backtests.  To learn more 
+about matplotlib backends, please refer to the
+`matplotlib backend documentation <https://matplotlib.org/faq/usage_faq.html#what-is-a-backend>`_.
+
+.. _windows:
+
+Windows Requirements
+--------------------
+
+In Windows, you will first need to install the `Microsoft Visual C++ Compiler 
+for Python 2.7 
+<https://www.microsoft.com/en-us/download/details.aspx?id=44266>`_. 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.
+
+Once you have the above compiler installed, the easiest and best supported way 
+to install Catalyst in Windows is to use :ref:`Conda <conda>`. If you didn't 
+any problems installing the compiler, jump to the :ref:`Conda <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:
+
+- **The system administrator has set policies to prevent this installation**.
+  
+  In some systems, there is a default *Windows Software Restriction* policy 
+  that prevents the installation of some software packages like this one. 
+  You'll have to change the Registry to circumvent this:
+
+  - Click ``Start``, and search for ``regedit`` and launch the 
+    ``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 
+    default you get 0 as the Value Data)
+
+|
+- **The installer has encountered an unexpected error installing this package. 
+  This may indicate a problem with this package. The error code is 2503.**
+
+  We have observed this when trying to install a package without enough 
+  administrator permissions. Even when you are logged in as an Administrator, 
+  you have to explictily install this package with administrator privileges:
+
+  - Click ``Start`` and find ``CMD`` or ``Command Prompt``
+  - Right click on it and choose ``Run as administrator``
+  - ``cd`` into the folder where you downloaded ``VCForPython27.msi``
+  - Run ``msiexec /i VCForPython27.msi``
 
 Getting Help
 ------------

docs/source/utilities.rst

@@ -0,0 +1,149 @@
+Utilities
+=========
+
+This section covers a variety of utilites that provide complimentary 
+functionality to your trading algorithms. These are code snippets that you can
+add to any algorithm to add the desired functionality.
+
+If you are looking for example trading algorithms, see the corresponding section.
+
+Output to CSV file
+~~~~~~~~~~~~~~~~~~
+
+Add this script to the analyze method to create and save a CSV file with the 
+results from the trading algorithm. This file will include the default 
+parameters of the results DataFrame plus any recorded variables and will be 
+saved in the same location where your trading algorithm is saved. The exact 
+script that you need to use depends on the interface that you are using to run 
+your trading algorithm, which could be the CLI or a Python Interpreter.
+
+1. Script to use with CLI:
+
+   .. code-block:: python
+
+      def analyze(context=None, results=None):
+          import sys
+          import os
+          from os.path import basename
+          
+          # Save results in CSV file
+          filename = os.path.splitext(basename(sys.argv[3]))[0]
+          results.to_csv(filename + '.csv')
+
+2. Script to use with Python Interpreter:
+
+   .. code-block:: python
+
+      def analyze(context=None, results=None):
+          import os
+          from os.path import basename
+          
+          # Save results in CSV file
+          filename = os.path.splitext(os.path.basename(__file__))[0]
+          results.to_csv(filename + '.csv')
+
+Extracting market data
+~~~~~~~~~~~~~~~~~~~~~~
+
+Use this script to save the price and volume data of one cryptoasset in a CSV 
+file, which will be saved in the same location and with the same name as your 
+Python file. To get custom data, simply modify the asset's symbol and the dates. 
+Run this script directly from your development environment: python scriptname.py, 
+where the contents of 'scriptname.py' are as follows. Two different version are 
+provided as an example for daily- and minute-resolution data respectively:
+
+Simpler case for daily data
+
+.. code-block:: python
+
+   import os
+   import pytz
+   from datetime import datetime
+
+   from catalyst.api import record, symbol, symbols
+   from catalyst.utils.run_algo import run_algorithm
+
+   def initialize(context):
+      # Portfolio assets list
+      context.asset = symbol('btc_usdt') # Bitcoin on Poloniex
+                          
+   def handle_data(context, data):
+      # Variables to record for a given asset: price and volume
+      price = data.current(context.asset, 'price')
+      volume = data.current(context.asset, 'volume')
+      record(price=price, volume=volume)
+      
+   def analyze(context=None, results=None):
+      
+      # Generate DataFrame with Price and Volume only
+      data = results[['price','volume']]
+      
+      # Save results in CSV file
+      filename = os.path.splitext(os.path.basename(__file__))[0]
+      data.to_csv(filename + '.csv')
+      
+   ''' Bitcoin data is available on Poloniex since 2015-3-1. 
+       Dates vary for other tokens. In the example below, we choose the 
+       full month of July of 2017.
+   '''
+   start = datetime(2017, 1, 1, 0, 0, 0, 0, pytz.utc)
+   end = datetime(2017, 7, 31, 0, 0, 0, 0, pytz.utc) 
+   results = run_algorithm(initialize=initialize, 
+                           handle_data=handle_data, 
+                           analyze=analyze, 
+                           start=start, 
+                           end=end, 
+                           exchange_name='poloniex', 
+                           capital_base=10000, 
+                           base_currency = 'usdt')
+
+More versatile case for minute data
+
+.. code-block:: python
+
+   import os
+   import csv
+   import pytz
+   from datetime import datetime
+
+   from catalyst.api import record, symbol, symbols
+   from catalyst.utils.run_algo import run_algorithm
+
+
+   def initialize(context):
+   # Portfolio assets list
+   context.asset     = symbol('btc_usdt') # Bitcoin on Poloniex
+
+   # Creates a .CSV file with the same name as this script to store results
+   context.csvfile   = open(os.path.splitext(
+                            os.path.basename(__file__))[0]+'.csv', 'w+')
+   context.csvwriter = csv.writer(context.csvfile)
+
+   def handle_data(context, data):
+   # Variables to record for a given asset: price and volume
+   # Other options include 'open', 'high', 'open', 'close'
+   # Please note that 'price' equals 'close'
+   date   = context.blotter.current_dt     # current time in each iteration
+   price  = data.current(context.asset, 'price')
+   volume = data.current(context.asset, 'volume')
+
+   # Writes one line to CSV on each iteration with the chosen variables    
+   context.csvwriter.writerow([date,price,volume])
+
+   def analyze(context=None, results=None):
+   # Close open file properly at the end
+   context.csvfile.close()
+
+
+   # Bitcoin data is available from 2015-3-2. Dates vary for other tokens.    
+   start = datetime(2017, 7, 30, 0, 0, 0, 0, pytz.utc)
+   end = datetime(2017, 7, 31, 0, 0, 0, 0, pytz.utc) 
+   results = run_algorithm(initialize=initialize, 
+                           handle_data=handle_data,
+                           analyze=analyze, 
+                           start=start, 
+                           end=end,
+                           exchange_name='poloniex', 
+                           data_frequency='minute',
+                           base_currency ='usdt', 
+                           capital_base=10000 )

docs/source/videos.rst

@@ -22,5 +22,21 @@ Where things go smoothly:
 
 |
 Where things don't:
+
+.. raw:: html
    
-   Coming up next!
+   <iframe width="560" height="315" src="https://www.youtube.com/embed/qLkQcWlUBy8" frameborder="0" allowfullscreen></iframe>
+
+|
+|
+Backtesting a Strategy
+----------------------
+
+This algorithm is based on a simple momentum strategy. When the cryptoasset
+goes up quickly, we’re going to buy; when it goes down quickly, we’re going to 
+sell. Hopefully, we’ll ride the waves.
+
+.. raw:: html
+
+   <iframe width="560" height="315" src="https://www.youtube.com/embed/JOBRwst9jUY" frameborder="0" allowfullscreen></iframe>
+

tests/exchange/test_bundle.py

@@ -438,7 +438,7 @@ class TestExchangeBundle:
         pass
 
     def main_bundle_to_csv(self):
-        exchange_name = 'bitfinex'
+        exchange_name = 'poloniex'
         data_frequency = 'minute'
 
         exchange = get_exchange(exchange_name)
@@ -448,7 +448,7 @@ class TestExchangeBundle:
         end_dt = pd.to_datetime('2016-6-1', utc=True)
         self._bundle_to_csv(
             asset=asset,
-            exchange=exchange,
+            exchange_name=exchange.name,
             data_frequency=data_frequency,
             filename='{}_{}_{}'.format(
                 exchange_name, data_frequency, asset.symbol
@@ -460,7 +460,7 @@ class TestExchangeBundle:
     def bundle_to_csv(self):
         exchange_name = 'poloniex'
         data_frequency = 'minute'
-        period = '2017-09'
+        period = '2017-01'
         symbol = 'eth_btc'
 
         exchange = get_exchange(exchange_name)
@@ -474,16 +474,16 @@ class TestExchangeBundle:
         )
         self._bundle_to_csv(
             asset=asset,
-            exchange=exchange,
+            exchange_name=exchange.name,
             data_frequency=data_frequency,
             path=path,
             filename=period
         )
         pass
 
-    def _bundle_to_csv(self, asset, exchange, data_frequency, filename,
+    def _bundle_to_csv(self, asset, exchange_name, data_frequency, filename,
                        path=None, start_dt=None, end_dt=None):
-        bundle = ExchangeBundle(exchange)
+        bundle = ExchangeBundle(exchange_name)
         reader = bundle.get_reader(data_frequency, path=path)
 
         if start_dt is None:
@@ -514,14 +514,39 @@ class TestExchangeBundle:
         df = get_df_from_arrays(arrays, periods)
 
         folder = os.path.join(
-            tempfile.gettempdir(), 'catalyst', exchange.name, asset.symbol
+            tempfile.gettempdir(), 'catalyst', exchange_name, asset.symbol
         )
         ensure_directory(folder)
 
         path = os.path.join(folder, filename + '.csv')
 
         log.info('creating csv file: {}'.format(path))
-        print('HEAD\n{}'.format(df.head(10)))
+        print('HEAD\n{}'.format(df.head(100)))
-        print('TAIL\n{}'.format(df.tail(10)))
+        print('TAIL\n{}'.format(df.tail(100)))
         df.to_csv(path)
         pass
+
+    def test_ingest_csv(self):
+        data_frequency = 'minute'
+        exchange_name = 'bittrex'
+        path = '/Users/fredfortier/Dropbox/Enigma/Data/bittrex_bat_eth.csv'
+
+        exchange_bundle = ExchangeBundle(exchange_name)
+        exchange_bundle.ingest_csv(path, data_frequency)
+
+        exchange = get_exchange(exchange_name)
+        asset = exchange.get_asset('bat_eth')
+
+        start_dt = pd.to_datetime('2017-6-3', utc=True)
+        end_dt = pd.to_datetime('2017-8-3 19:24', utc=True)
+        self._bundle_to_csv(
+            asset=asset,
+            exchange_name=exchange.name,
+            data_frequency=data_frequency,
+            filename='{}_{}_{}'.format(
+                exchange_name, data_frequency, asset.symbol
+            ),
+            start_dt=start_dt,
+            end_dt=end_dt
+        )
+        pass

tests/exchange/test_data_portal.py

@@ -1,16 +1,13 @@
 import pandas as pd
-from catalyst.exchange.exchange_data_portal import DataPortalExchangeBacktest, \
-    DataPortalExchangeLive
 from logbook import Logger
-from test_utils import rnd_history_date_days, rnd_bar_count
 
 from catalyst import get_calendar
 from catalyst.exchange.asset_finder_exchange import AssetFinderExchange
-from catalyst.exchange.bitfinex.bitfinex import Bitfinex
+from catalyst.exchange.exchange_data_portal import DataPortalExchangeBacktest, \
-from catalyst.exchange.bittrex.bittrex import Bittrex
+    DataPortalExchangeLive
-from catalyst.exchange.exchange_utils import get_exchange_auth, \
+from catalyst.exchange.exchange_utils import get_common_assets
-    get_common_assets
 from catalyst.exchange.factory import get_exchange, get_exchanges
+from test_utils import rnd_history_date_days, rnd_bar_count, output_df
 
 log = Logger('test_bitfinex')
 
@@ -115,38 +112,4 @@ class TestExchangeDataPortal:
         log.info('found history window: {}'.format(data))
 
     def test_validate_resample(self):
-        symbol = ['eth_btc']
-        exchange_name = 'poloniex'
-        exchange = get_exchange(exchange_name, base_currency=symbol)
-
-        assets = exchange.get_assets(symbols=symbol)
-
-        date = rnd_history_date_days(
-            max_days=10,
-            last_dt=pd.to_datetime('2017-11-1', utc=True)
-        )
-        bar_count = rnd_bar_count(max_bars=10)
-        sample_minutes = 15
-        sample_data = self.data_portal_backtest.get_history_window(
-            assets=assets,
-            end_dt=date,
-            bar_count=bar_count,
-            frequency='{}T'.format(sample_minutes),
-            field='close',
-            data_frequency='daily'
-        )
-        minute_data = self.data_portal_backtest.get_history_window(
-            assets=assets,
-            end_dt=date,
-            bar_count=bar_count * sample_minutes,
-            frequency='1T',
-            field='close',
-            data_frequency='daily'
-        )
-        resampled_minute_data = minute_data.resample(
-            '{}T'.format(sample_minutes))
-
-        print(sample_data.tail(10))
-        print(resampled_minute_data.tail(10))
-        print(minute_data.tail(10))
         pass

tests/exchange/test_poloniex.py

@@ -54,8 +54,9 @@ class TestPoloniex(BaseExchangeTestCase):
         log.info('retrieving candles')
         assets = self.exchange.get_asset('eth_btc')
         ohlcv = self.exchange.get_candles(
-            end_dt=pd.to_datetime('2017-11-01', utc=True),
+            # end_dt=pd.to_datetime('2017-11-01', utc=True),
-            freq='30T',
+            end_dt=None,
+            freq='5T',
             assets=assets,
             bar_count=200
         )
@@ -63,7 +64,7 @@ class TestPoloniex(BaseExchangeTestCase):
         df.set_index('last_traded', drop=True, inplace=True)
         log.info(df.tail(25))
 
-        path = output_df(df, assets, 'candles')
+        path = output_df(df, assets, '5min_candles')
         log.info('saved candles: {}'.format(path))
         pass
 

tests/exchange/test_utils.py

@@ -1,7 +1,12 @@
+import os
+import tempfile
 from datetime import timedelta
 from random import randint
 
 import pandas as pd
+from catalyst.assets._assets import TradingPair
+
+from catalyst.utils.paths import ensure_directory
 
 
 def rnd_history_date_days(max_days=30, last_dt=None):
@@ -24,3 +29,38 @@ def rnd_bar_count(max_bars=21):
     now = pd.Timestamp.utcnow()
 
     return randint(0, max_bars)
+
+
+def output_df(df, assets, name=None):
+    """
+    Outputs a price DataFrame to a temp folder.
+
+    Parameters
+    ----------
+    df: pd.DataFrame
+    assets
+    name
+
+    Returns
+    -------
+
+    """
+    if isinstance(assets, TradingPair):
+        exchange_folder = assets.exchange
+        asset_folder = assets.symbol
+    else:
+        exchange_folder = ','.join([asset.exchange for asset in assets])
+        asset_folder = ','.join([asset.symbol for asset in assets])
+
+    folder = os.path.join(
+        tempfile.gettempdir(), 'catalyst', exchange_folder, asset_folder
+    )
+    ensure_directory(folder)
+
+    if name is None:
+        name = 'output'
+
+    path = os.path.join(folder, '{}.csv'.format(name))
+    df.to_csv(path)
+
+    return path