diff --git a/catalyst/__main__.py b/catalyst/__main__.py index b11e7d04..36593bab 100644 --- a/catalyst/__main__.py +++ b/catalyst/__main__.py @@ -206,8 +206,8 @@ def ipython_only(option): ) @click.option( '-c', - '--reference-currency', - help='The reference currency used to calculate statistics ' + '--base-currency', + help='The base currency used to calculate statistics ' '(e.g. usd, btc, eth).', ) @click.pass_context @@ -239,7 +239,7 @@ def run(ctx, ctx.fail("must specify an algorithm name '-n' in live execution " "mode '--live'") if base_currency is None: - ctx.fail("must specify a reference currency '-c' in live " + ctx.fail("must specify a base currency '-c' in live " "execution mode '--live'") else: # check that the start and end dates are passed correctly diff --git a/catalyst/examples/buy_low_sell_high_live.py b/catalyst/examples/buy_low_sell_high_live.py index e3469079..702471a3 100644 --- a/catalyst/examples/buy_low_sell_high_live.py +++ b/catalyst/examples/buy_low_sell_high_live.py @@ -1,3 +1,14 @@ +''' +This algorithm requires an additional library (ta-lib) beyond those required by catalyst. +Install it first by running: +$ pip install TA-Lib + +If you get build errors like "fatal error: ta-lib/ta_libc.h: No such file or directory" +it typically means that it can't find the underlying TA-Lib library and needs to be installed. +See https://mrjbq7.github.io/ta-lib/install.html for instructions on how to install +the required dependencies. +''' + import talib from logbook import Logger diff --git a/docs/live-trading-wiki.md b/docs/live-trading-wiki.md index 2d127ea2..a7dbd9f1 100644 --- a/docs/live-trading-wiki.md +++ b/docs/live-trading-wiki.md @@ -72,7 +72,7 @@ error will occur if the specified trading pair is not trading on the exchange.

Trading an Algorithm

-There are no special convention to follow when writing an +There is no special convention to follow when writing an algorithm for live trading. The same algorithm should work in backtest and live execution mode without modification. @@ -97,7 +97,7 @@ Here is the breakdown of the new arguments: (supported values: *bitfinex*, *bittrex*). * algo_namespace: A arbitrary label assigned to your algorithm for data storage purposes. -* base_currency: The reference currency used to calculate the +* base_currency: The base currency used to calculate the statistics of your algorithm. Currently, the base currency of all trading pairs of your algorithm must match this value.