Compare commits

...
212 Commits
Author SHA1 Message Date
avishaiw ca76d7271f DEV: encoding compatible to unix as well 2018-03-21 13:06:14 +02:00
AvishaiW d0abc8eac0 DEV: minor change in order to get log tail from server (WIP) 2018-03-14 09:40:45 +02:00
AvishaiW 4712db4f4f DEV: receiving a log from the cloud (WIP) 2018-03-12 10:53:53 +02:00
AvishaiW 8a812ea455 DEV: modified to the instance url (WIP) 2018-03-08 17:08:10 +02:00
AvishaiW e4933ee48e DEV: split client and server- added some docs (WIP) 2018-03-07 09:48:56 +02:00
AvishaiW b172f6b7b0 DEV: able to run locally through api- added backtesting as well (WIP) 2018-03-06 16:02:02 +02:00
AvishaiW 3335ef16a4 BLD: adding changes done in order to add the option to call the instance (WIP) 2018-03-05 22:19:46 +02:00
AvishaiW 71b246b9f1 DOC: added parameter to doc on exchange_bundle 2018-03-04 17:55:17 +02:00
AvishaiW aa520d5a8b STY: pep8 change in exchange_blotter 2018-03-04 17:24:22 +02:00
lenak25 e59f46dfd6 BLD: improve periods calculation 2018-03-04 13:47:08 +02:00
Victor Grau Serrat 5197ab6cc2 BUG: isolated Python3 depedency to the marketplace 2018-03-02 12:50:46 -07:00
Victor Grau Serrat d7b6cb8490 BUG: marketplace typo 2018-03-02 12:18:48 -07:00
Victor Grau Serrat fa0e9332bf MAINT: CLI info on marketplace cmds 2018-03-02 11:43:59 -07:00
VictorandGitHub d9d6a4e52d Merge pull request #257 from mattbornski/master
fix incompatibility with web3==4.0.0b11 from prior web3 versions
2018-03-02 11:38:52 -07:00
VictorandGitHub b4e5b699bd BUG: fix2 incompatibility with web3==4.0.0b11 2018-03-02 11:37:22 -07:00
VictorandGitHub f990ecf14d BUG: fix incompatibility with web3==4.0.0b11 2018-03-02 11:34:18 -07:00
lenak25 5d3a1c2f8b BLD: cosmetics 2018-03-02 00:39:28 +02:00
lenak25 3159ec7dc2 BLD: fix periods calculations and bundle unit-test 2018-03-02 00:36:13 +02:00
lenak25 8be0626fc9 BLD:refine unit-test 2018-03-01 18:16:57 +02:00
lenak25 868f17fd9d BLD:flake fixes 2018-03-01 16:39:42 +02:00
lenak25 b95cf465fc BLD:updating the forward fill to set volume to zero and others values to the previous close value 2018-03-01 16:09:09 +02:00
AvishaiW c4b10bae39 DOC: added- creating a virtual env for 3.6 2018-03-01 09:47:18 +02:00
AvishaiW 6c4f7afaea BUG: fixed removing files- check the path, not the file 2018-03-01 09:42:07 +02:00
Victor Grau Serrat b85219d5b4 MAINT: undoing last 2 unwanted commits 2018-02-28 18:06:36 -07:00
AvishaiW 082b342d02 Merge remote-tracking branch 'origin/develop' into cloud_conn 2018-03-01 01:11:46 +02:00
AvishaiW 37c1057ab6 BLD: added a cmd for running on the cloud (WIP) 2018-03-01 01:09:35 +02:00
Avishai WeingartenandGitHub 46e1a87a3d DOC: added troubleshooting for python3 2018-02-27 18:47:43 +02:00
Avishai WeingartenandGitHub cfafafb8fc BUG #252 fixed utc time and file erased 2018-02-27 09:47:02 +02:00
Matt Bornski 497212383a Python 3 returns bytes, the parsing functions are looking for strings 2018-02-26 15:44:32 -08:00
AvishaiW e5870ea60a BUG: fix #252 #253 and split state into paper and live 2018-02-26 09:21:00 +02:00
AvishaiW 8587fee0ce BUG: revert previous changes #249 2018-02-25 11:29:26 +02:00
Victor Grau Serrat 388535b09c BUG: reverts changed introduced in 00f232e2d7 2018-02-22 22:14:03 -07:00
Victor Grau Serrat 25e9f0f58f BUG: reverts changed introduced in 00f232e2d7 2018-02-22 22:09:51 -07:00
AvishaiW b4bd557273 BUG: fixes for issues #204 #237
-modified parameters for cancel_orders
-update portfolio after any change in
 the orders before sync
2018-02-23 00:38:51 +02:00
Victor Grau Serrat 2577b53518 MAINT: conda environment updates 2018-02-22 12:55:19 -07:00
Victor Grau Serrat 8fe3ab344e MAINT: conda environment updates 2018-02-22 12:54:36 -07:00
Victor bfd7e4b2dd Update python3.6-environment.yml 2018-02-22 12:54:36 -07:00
lenak25 50310576f9 BUG:fix an issue with wrong timestamps seen at tests.exchange.test_suites.test_suite_bundle.TestSuiteBundle#test_validate_bundles (which issue #230 uncovered) 2018-02-22 17:42:14 +02:00
lenak25 fea2ed104e BUG: fix issue #236: handle properly empty candles received from exchanges 2018-02-22 16:50:48 +02:00
embaral 127878413e DOC: added an option "catalyst live --help" to the documentation. 2018-02-22 14:45:14 +02:00
embaral 6a6ccf5595 Merge remote-tracking branch 'origin/develop' into develop 2018-02-22 14:37:46 +02:00
embaral d40585f56e DOC: added an option "catalyst live --help" to the documentation. 2018-02-22 14:34:00 +02:00
Victor Grau Serrat 4337abd60a DOC: linking example_algo to their sources 2018-02-21 15:51:34 -07:00
AvishaiW 92e0a7bb88 Merge branch 'develop' of https://github.com/enigmampc/catalyst into develop 2018-02-21 20:45:39 +02:00
AvishaiW 20f8a75f4a BUG: for issue #237, update positions before checking balances 2018-02-21 20:42:39 +02:00
Frederic Fortier 634d22fb06 Merge remote-tracking branch 'origin/develop' into develop 2018-02-21 13:07:23 -05:00
Frederic Fortier 7ee875ee70 BLD: adjusted sample algo 2018-02-21 13:06:57 -05:00
Victor Grau Serrat 9936b38e09 DOC: updated Visual C++ instructions for Windows & Python 3 2018-02-21 08:52:19 -07:00
AvishaiW 7e22674d40 Merge branch 'develop' of https://github.com/enigmampc/catalyst into develop 2018-02-20 19:18:10 +02:00
AvishaiW ab644bd732 BUG: modified dual_moving_average example
modified long_window to be larger than short_window
2018-02-20 19:17:03 +02:00
lenak25 2becc4157a MAINT: cosmetics 2018-02-20 14:51:25 +02:00
Victor Grau Serrat ec5fdecf91 DOC: marketplace code examples 2018-02-16 11:50:16 -07:00
Victor Grau Serrat bd88ba2277 DOC: marketplace code examples 2018-02-16 11:49:07 -07:00
AvishaiW a61857b37d BUG: changed the data, analyze gets in live
- fixed the bug following #229
- at the end of each day the stores the daily stats to local directory
- removes the stats folder at the begining of each run to avoid overloading the disk.
- removes old data (over a month) during the run to avoid overloading the disk
2018-02-15 20:22:15 +02:00
Frederic Fortier 866b0a215c BUG: for issue #227, made more mappings for hourly frequency 2018-02-14 23:30:53 -05:00
Frederic Fortier 2ba825db9b BUG: for issue #227, made more mappings for hourly frequency 2018-02-14 20:26:41 -05:00
Frederic Fortier 041665dee1 BUG: fixed issue with incremental ingestion 2018-02-14 13:37:51 -05:00
Frederic Fortier 8072ded532 BLD: clarified open order message 2018-02-14 12:25:44 -05:00
VictorandGitHub 9956b5462d Update python3.6-environment.yml 2018-02-14 09:27:53 -07:00
Victor Grau Serrat 92d3b98448 MAINT: updated conda install instructions for Python3 2018-02-13 12:14:11 -07:00
Victor Grau Serrat 46f34d64a0 MAINT: conda env for Python3 2018-02-13 12:06:06 -07:00
Victor Grau Serrat d494de7551 MAINT: conda env for Python3 2018-02-13 12:05:01 -07:00
AvishaiW 129778945f Merge branch 'develop' of https://github.com/enigmampc/catalyst into develop 2018-02-13 19:41:52 +02:00
AvishaiW f3183b267a BLD: added password into credentials
needed for exchanges such as 'gdax'
2018-02-13 19:41:37 +02:00
AvishaiW 6812aa0c5b BLD: added password into credentials
needed for exchanges such as 'gdax'
2018-02-13 19:39:38 +02:00
lenak25 89bf6742e3 MAINT: remove unnecessary Binance exclusion code 2018-02-13 16:57:03 +02:00
Frederic Fortier f45d673d94 BUG: fixed issue #227 by allowing H frequency 2018-02-13 00:11:20 -05:00
Frederic Fortier 67400f048b BLD: fix issue with removing extra candle in resampling 2018-02-12 22:39:03 -05:00
Frederic Fortier d64d6f191f BLD: upgraded CCXT 2018-02-12 16:44:25 -05:00
Frederic Fortier 5345bfc43d BLD: remove extra candle at the beginning of history bars after resampling 2018-02-12 13:59:19 -05:00
AvishaiW e9745be0e8 DOC: added use of end_date & start_date in live mode.
issues #225 & #213
2018-02-11 13:53:39 +02:00
Victor Grau Serrat bc8bf6941d MAINT: contract+abi pointing to master, not develop 2018-02-09 16:08:22 -08:00
Victor Grau Serrat f35444fabc DOC: updated algo as per #201 2018-02-09 15:16:14 -08:00
Victor Grau Serrat 2c1f810163 DOC: pycharm: improved upon #195 2018-02-09 11:10:32 -08:00
VictorandGitHub 77570f03eb Merge pull request #195 from izokay/develop
PyCharm Documentation
2018-02-09 11:17:16 -07:00
Victor Grau Serrat a8cfcead70 DOC: live-trading: improved upon #221 2018-02-09 10:13:52 -08:00
VictorandGitHub 00f579c729 Merge pull request #221 from westurner/feature/live-trading-doc-newline
DOC: live-trading.rst: add newline before ul
2018-02-09 11:10:14 -07:00
Frederic Fortier 49b6792399 Merge branch 'develop' 2018-02-09 12:01:57 -05:00
Frederic Fortier 6b1982274e DOC: updated release notes for 0.5.3 2018-02-09 02:44:45 -05:00
Frederic Fortier bc58640a3a Merge remote-tracking branch 'origin/develop' into develop 2018-02-09 02:41:08 -05:00
Frederic Fortier 511af7946e BUG: for issue #219, created another unit test which compares current price against last candle 2018-02-09 02:40:53 -05:00
Victor Grau Serrat dcdb3d9d7a MAINT: removing many warnings from building docs 2018-02-09 00:07:38 -07:00
westurner 262dffd4bf DOC: live-trading.rst: add newline before ul 2018-02-09 01:46:44 -05:00
Frederic Fortier 5c77cfc68d BUG: for issue #219, fixed a resampling issue 2018-02-09 01:38:22 -05:00
Frederic Fortier 11f8e36ff0 Merge remote-tracking branch 'origin/develop' into develop 2018-02-09 00:56:45 -05:00
Frederic Fortier 44e4e66f5c BLD: adding more log messages 2018-02-09 00:56:35 -05:00
Victor Grau Serrat 3c4c6c3dfd DOC: small edits, eliminating sphinx warnings 2018-02-08 22:10:57 -07:00
Victor Grau Serrat bebebc46dc DOC: small edits, eliminating sphinx warnings 2018-02-08 22:07:58 -07:00
Frederic Fortier 403d7f9c29 Merge branch 'develop' 2018-02-08 17:32:47 -05:00
Frederic Fortier 09ad397ee6 DOC: adjusted the release notes 2018-02-08 17:31:09 -05:00
Frederic Fortier e56e1f8e21 BUG: fixed an issue with open orders 2018-02-08 17:26:48 -05:00
Frederic Fortier 00f232e2d7 BUG: fixed sample algo 2018-02-08 17:10:41 -05:00
Frederic Fortier a820f66bdc BLD: adjusted unit test 2018-02-08 16:57:23 -05:00
Frederic Fortier 82d318a1c0 BUG: fixed issue #216 with bad candle data 2018-02-08 15:51:55 -05:00
Frederic Fortier 97afbf781e Merge branch 'master' into develop 2018-02-08 01:13:29 -05:00
Frederic Fortier 43a5f8858b DOC: updated release number 2018-02-08 01:11:09 -05:00
Frederic Fortier dc04cd8781 Merge branch 'master' into develop 2018-02-08 00:59:46 -05:00
Frederic Fortier 793b6e92d8 BLD: included marketplace dependencies 2018-02-08 00:47:25 -05:00
Frederic Fortier c0b9939580 Merge branch 'develop' 2018-02-08 00:33:55 -05:00
Frederic Fortier e248831719 BLD: adjusted sample algo 2018-02-08 00:27:56 -05:00
Frederic Fortier 25f1f6e641 BLD: upgraded CCXT 2018-02-08 00:18:48 -05:00
Frederic Fortier d2f9762fbf BLD: adjusting the marketplace sample algo 2018-02-08 00:02:40 -05:00
Victor Grau Serrat 7a89cfc02b BUG: marketplace: balance returns different types 2018-02-07 21:01:21 -07:00
Frederic Fortier 64e22ba27d BLD: Updated release notes for 5.0 2018-02-07 22:28:08 -05:00
Frederic Fortier 8c58916bb1 Merge remote-tracking branch 'origin/develop' into develop 2018-02-07 22:17:05 -05:00
Frederic Fortier 18cdd51680 BUG: fixed issue with order processing 2018-02-07 22:16:32 -05:00
Victor Grau Serrat db7b7639a0 MAINT: not listing test datasets 2018-02-07 17:34:11 -07:00
Frederic Fortier 1ad26b0c39 BLD: trying to format a line 2018-02-07 19:29:38 -05:00
Victor Grau Serrat e1abecb556 MAINT: updated catalyst logo 2018-02-07 17:09:49 -07:00
Victor Grau Serrat 6e642f45d8 MAINT: marketplace prompts 2018-02-07 14:44:11 -07:00
Frederic Fortier 9f9bfc9df0 BLD: dropping dataset index cols to avoid duplicates 2018-02-07 16:40:43 -05:00
Frederic Fortier 866b92910f BLD: fixed the marketplace api in the algo runtime 2018-02-07 13:10:07 -05:00
Victor Grau Serrat e071f6ec8d BLD: implemented grains, catch JSON malformed in addresses.json 2018-02-07 10:57:07 -07:00
lenak25 3eff58fcf9 Merge branch 'develop' of github.com:enigmampc/catalyst into develop 2018-02-07 12:49:12 +02:00
lenak25 540358d0f9 BLD: new marketplace contract address 2018-02-07 12:48:24 +02:00
Victor Grau Serrat 0e3be98d24 BLD: mmarketplace: switched encoding to Web3.toHex() 2018-02-07 01:44:16 -07:00
Victor Grau Serrat c39e075766 MAINT: constants points to contract address/abi in develop branch 2018-02-06 23:50:24 -07:00
Frederic Fortier 54935dd6f6 Merge remote-tracking branch 'origin/develop' into develop 2018-02-07 01:46:45 -05:00
Frederic Fortier 093660ab1a BLD: simplified unit tests until the next release 2018-02-07 01:46:33 -05:00
Victor Grau Serrat fb65839032 BLD: marketplace: getkeysecret is authenticated 2018-02-06 23:33:42 -07:00
Frederic Fortier 461a5942fb BUG: fixed Python 2 issue EXPERIMENTAL 2018-02-07 01:17:00 -05:00
Frederic Fortier eee2e1be88 BUG: fixed Python 2 issue 2018-02-07 00:48:17 -05:00
Frederic Fortier 2d43955abf BUG: fixed Python 2 issue 2018-02-07 00:45:33 -05:00
Frederic Fortier c5bed6e8c4 BLD: made some adjustments during testing 2018-02-06 21:15:30 -05:00
Frederic Fortier 2320a1432a BLD: Merge remote-tracking branch 'remotes/origin/data-marketplace' into develop 2018-02-06 14:34:07 -05:00
Frederic Fortier 5d74cd6f89 BLD: Merge remote-tracking branch 'remotes/origin/data-marketplace' into develop 2018-02-06 14:32:59 -05:00
Frederic Fortier 273408e9ed Merge remote-tracking branch 'origin/data-marketplace' into data-marketplace 2018-02-06 14:18:00 -05:00
Frederic Fortier 5ccddf6d21 BLD: removed dummy smart contract 2018-02-06 14:17:48 -05:00
Victor Grau Serrat d97890fc4e BLD: marketplace: moving AUTH_SERVER paths to /marketplace/* 2018-02-06 11:43:41 -07:00
Victor Grau Serrat 4c1a9b1dd7 BLD: marketplace added listing of datasets 2018-02-05 22:58:40 -07:00
Victor Grau Serrat 2168fb0d5b BUG: address json initialized with array of 1 dict, instead of dict 2018-02-05 22:17:21 -07:00
Frederic Fortier 3bc54a6c2e BLD: finalized the register implementation 2018-02-05 23:46:09 -05:00
Frederic Fortier 444fcbb2b3 BLD: adjustments for the new contract and developing register 2018-02-05 23:04:23 -05:00
Isan-Rivkin 881e3e5953 REV:constants.py revert 2018-02-04 08:51:27 -08:00
Isan-Rivkin 5889f4c74b BLD: added smart contract addresses 2018-02-04 08:45:06 -08:00
Isan-Rivkin ee93b16558 BLD:Solidity contract addressed added to constants 2018-02-04 08:42:42 -08:00
lenak25 e94c9db2ec Updated contract 2018-02-04 18:29:11 +02:00
Frederic Fortier 9f88e7a003 BUG: for issue #183, added more logic to catch order amount adjustments 2018-02-03 18:24:28 -05:00
Frederic Fortier b9bedfda21 BLD: enhancing registration features 2018-02-02 17:23:13 -05:00
Frederic Fortier d1529afeb3 BLD: enhancing registration features 2018-02-02 17:10:10 -05:00
Frederic Fortier 99dece953f BLD: ingesting marketplace bundles 2018-02-02 16:20:33 -05:00
Victor Grau Serrat 9ef000e529 BUG: balance returns different types 2018-02-02 12:06:57 -07:00
Victor Grau Serrat db4ee4c01e BLD: check for existence of dataset in ingestion & subscription 2018-02-01 23:42:40 -07:00
Victor Grau Serrat 0decdf5aab BLD: check for name duplicates when registering dataset 2018-02-01 22:30:24 -07:00
Victor Grau Serrat e460290056 BLD: better exception handling for failed multipart download 2018-02-01 21:59:30 -07:00
Frederic Fortier b9130fd968 BLD: added missing requirement 2018-02-01 22:03:16 -05:00
Frederic Fortier 37980f3580 BLD: working on marketplace integration 2018-02-01 20:43:48 -05:00
Victor Grau Serrat 56bd3db7a2 BLD: marketplace - ingestion downloads multiple files 2018-02-01 16:54:24 -07:00
Victor Grau Serrat 18123d7f7e BLD: marketplace constants in constants.py 2018-02-01 11:47:25 -07:00
Victor Grau Serrat a04a99373d BLD: marketplace: subscription to dataset 2018-02-01 08:07:17 -07:00
Victor Grau Serrat e906315969 BLD: marketplace: enigma contract files 2018-01-31 22:06:52 -07:00
Frederic Fortier a360a5fe3a Housekeeping 2018-01-31 23:57:22 -05:00
Frederic Fortier fcbdc131ec BLD: trying to catch as many trades as possible 2018-01-31 22:51:41 -05:00
Frederic Fortier 857a5d8a91 BUG: for issue #178, modified logic to track adjusted order amount 2018-01-31 21:57:33 -05:00
Frederic Fortier e914481325 BLD: minor adjustment 2018-01-31 17:19:09 -05:00
Frederic Fortier c0ba8b2ebb BUG: for issue #178, adjusted the fallback processing of orders for exchanges lacking a "my trades" api 2018-01-31 17:12:05 -05:00
Frederic Fortier 69507d1b00 BLD: for issue #178, fixed the "set" issue when fetching a ticker from positions 2018-01-31 16:32:22 -05:00
Frederic Fortier 311e357451 BLD: updated CCXT 2018-01-31 16:10:39 -05:00
Victor Grau Serrat d1cd95c492 BLD: marketplace subscribe + refactoring 2018-01-31 13:39:59 -07:00
Victor Grau Serrat 0f55f0e9a6 BLD: passing dataset to marketplace publish request 2018-01-31 10:50:10 -07:00
Victor Grau Serrat c26d78cf05 BLD: set AUTH_SERVER as a Catalyst constant 2018-01-30 11:20:06 -07:00
Avishai WeingartenandGitHub c3662443e4 Merge pull request #180 from gthouret/jupyter-allow-root-docker
Allow jupyter to run as root inside Docker image
2018-01-30 17:22:47 +02:00
Frederic Fortier 18c96303a6 BLD: improved unit test 2018-01-29 19:20:55 -05:00
Frederic Fortier 5c236a65f7 BUG: for issue #178, checking the order status instead of relying on the open amount 2018-01-29 19:20:34 -05:00
izokayandGitHub 1f29f7fdf1 Update beginner-tutorial.rst 2018-01-29 17:31:32 -05:00
izokayandGitHub cbae2465d2 Update beginner-tutorial.rst 2018-01-29 17:27:58 -05:00
izokayandGitHub 4a4e32846b Update beginner-tutorial.rst 2018-01-29 17:27:14 -05:00
izokayandGitHub 426fde40b1 Update beginner-tutorial.rst 2018-01-29 17:24:21 -05:00
izokayandGitHub e9a3bcf3e9 Update beginner-tutorial.rst 2018-01-29 17:23:22 -05:00
izokayandGitHub 5b77f5eeba Update beginner-tutorial.rst 2018-01-29 17:23:00 -05:00
izokayandGitHub 5417881a72 Update beginner-tutorial.rst 2018-01-29 17:21:53 -05:00
izokayandGitHub 1cadaf1ed0 Update beginner-tutorial.rst 2018-01-29 17:19:44 -05:00
izokayandGitHub 929e0a9a01 Update beginner-tutorial.rst 2018-01-29 17:18:16 -05:00
izokayandGitHub 15aadbb101 documentation for PyCharm 2018-01-29 17:14:15 -05:00
Frederic Fortier 7f021acb2e BUG: fixed catalyst import 2018-01-29 15:58:34 -05:00
Victor Grau Serrat 68faad4098 BLD: publish dataset in marketplace 2018-01-26 15:32:53 -07:00
Victor Grau Serrat ff989ba524 BLD: register dataset in marketplace 2018-01-25 22:39:54 -07:00
Frederic Fortier fa60457a0f BLD: misc adjustments to fetch all candles on the Binance exchange 2018-01-25 23:38:37 -05:00
Frederic Fortier 43737a9730 Merge branch 'alexiri-patch-1' into develop 2018-01-25 17:52:41 -05:00
Frederic Fortier e6fb708c1c Merge branch 'patch-1' of https://github.com/alexiri/catalyst into alexiri-patch-1 2018-01-25 17:52:22 -05:00
Frederic Fortier 8ff8e6458e BUG: fixed stats output issue #171 by adding orders and transactions in the header 2018-01-25 17:43:00 -05:00
Frederic Fortier 7d24433a42 Merge remote-tracking branch 'origin/develop' into develop 2018-01-25 17:41:02 -05:00
Frederic Fortier 7ae23e2340 BLD: conditionally fetching single or multi tickers for performance reasons 2018-01-25 17:40:45 -05:00
Avishai WeingartenandVictor Grau Serrat 940f625ec1 fix for click.echo
added sys.stdout to click.echo to prevent errors on jupyter
2018-01-25 12:46:27 -07:00
Victor Grau Serrat 2ec9aa2ca9 BLD: CLI implementation for the marketplace 2018-01-25 11:55:25 -07:00
Avishai WeingartenandGitHub c6dfd502d2 fix for click.echo
added sys.stdout to click.echo to prevent errors on jupyter
2018-01-25 16:02:44 +02:00
Frederic Fortier 0aa8c91577 BLD: for issue #174, re-implemented the fetch_tickers approach 2018-01-24 22:43:08 -05:00
Frederic Fortier c09f53449a BUG: fixed issue #176 with ignoring ticker errors instead of raising 2018-01-24 22:26:20 -05:00
Frederic Fortier f34a66e9c6 BUG: trying to fix issue #178 with Binance lot sizes 2018-01-24 21:54:05 -05:00
Victor Grau Serrat 04fed4140c BLD: sourcing contract address+abi from github 2018-01-24 14:12:59 -07:00
Victor Grau Serrat 76e183b5f7 BLD: contract address+abi on testnet 2018-01-24 12:48:42 -07:00
Frederic Fortier 911fb6e934 Merge branch 'gthouret-echo-usage-for-jupyter' 2018-01-24 00:33:52 -05:00
Frederic Fortier e8f98825e0 Merge branch 'treethought-empyrical-errors' into develop 2018-01-24 00:31:59 -05:00
Frederic Fortier 5619f6f451 Merge branch 'empyrical-errors' of https://github.com/treethought/catalyst into treethought-empyrical-errors 2018-01-24 00:31:49 -05:00
Cam Sweeney 8223d06d98 BUG: Use empyrical patches for persisting issue #126
The referenced issue was addressed via importing a set of patches
for empyrical. However the same error occurs occasionally when calling
the empyrical functions inside "/catalyst/finance/risk/period.py".

This PR simply applies 2 of the same patches in period.py.
I have only experienced problems with cum_returns and max_drawdown
thus far, but it is likely the other patches may be needed.
2018-01-23 02:42:55 -08:00
Frederic Fortier b47884a504 BLD: code formatting 2018-01-22 17:27:59 -05:00
Guy Thouret afa2af3014 Add sys.stdout as second paramter to click.echo calls to prevent 'not writable' when running catalyst from Jupyter
Related to #179

Signed-off-by: Guy Thouret <guy@thouret.uk>
2018-01-22 12:54:48 +00:00
Guy Thouret 55521b87b9 Allow jupyter to run as root inside Docker image
Signed-off-by: Guy Thouret <guy@thouret.uk>
2018-01-22 11:11:37 +00:00
Alex IribarrenandGitHub df4dd0f5a4 Update example-algos.rst
exchange_utils was moved.
2018-01-14 13:55:16 +01:00
Frederic Fortier 70b9fd8e03 BLD: completed data market place first integration and created an algo to test it 2018-01-12 00:39:14 -05:00
Frederic Fortier 21ad753fcf Merge remote-tracking branch 'origin/data-marketplace' into data-marketplace 2018-01-11 20:05:01 -05:00
Frederic Fortier 88aa7154db BLD: ingesting and cleaning marketplace data sources 2018-01-11 20:04:53 -05:00
VictorandGitHub b1d63c9a5b Update README.md 2018-01-11 12:15:49 -07:00
Frederic Fortier 3ea00e783c DOC: improved code comments 2018-01-11 14:08:52 -05:00
Frederic Fortier 9361570895 DOC: improved code comments 2018-01-11 14:08:02 -05:00
Frederic Fortier 50ded59c3c DOC: documented the marketplace structure 2018-01-11 14:01:00 -05:00
Frederic Fortier 354e422be8 BLD: working on ingesting alt data sources 2018-01-10 21:54:09 -05:00
Frederic Fortier 1e4af12e3d BLD: improved smart contract and catalyst commands 2018-01-10 13:31:08 -05:00
Frederic Fortier e0c8178932 BLD: improved smart contract and catalyst commands 2018-01-09 22:42:09 -05:00
Frederic Fortier 22a850ab14 BLD: testing basic smart contract 2018-01-09 20:41:03 -05:00
Frederic Fortier aab501aa17 BLD: first test of the marketplace smart contract 2018-01-09 19:08:53 -05:00
Frederic Fortier 94d5b4a4d5 BLD: defined first version of commands and marketplace class 2018-01-09 17:16:54 -05:00
61 changed files with 4314 additions and 1584 deletions
+2 -4
View File
@@ -1,4 +1,4 @@
.. image:: https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.jpg .. image:: https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.png
:target: https://enigmampc.github.io/catalyst :target: https://enigmampc.github.io/catalyst
:align: center :align: center
:alt: Enigma | Catalyst :alt: Enigma | Catalyst
@@ -17,9 +17,7 @@ insights regarding a particular strategy's performance. Catalyst also supports
live-trading of crypto-assets starting with three exchanges (Bitfinex, Bittrex, live-trading of crypto-assets starting with three exchanges (Bitfinex, Bittrex,
and Poloniex) with more being added over time. Catalyst empowers users to share and Poloniex) with more being added over time. Catalyst empowers users to share
and curate data and build profitable, data-driven investment strategies. Please and curate data and build profitable, data-driven investment strategies. Please
visit `enigma.co <https://www.enigma.co>`_ to learn more about Catalyst, or visit `enigma.co <https://www.enigma.co>`_ to learn more about Catalyst.
refer to the `whitepaper <https://www.enigma.co/enigma_catalyst.pdf>`_ for
further technical details.
Catalyst builds on top of the well-established Catalyst builds on top of the well-established
`Zipline <https://github.com/quantopian/zipline>`_ project. We did our best to `Zipline <https://github.com/quantopian/zipline>`_ project. We did our best to
+505 -11
View File
@@ -3,8 +3,10 @@ import os
from functools import wraps from functools import wraps
import click import click
import sys
import logbook import logbook
import pandas as pd import pandas as pd
from catalyst.marketplace.marketplace import Marketplace
from six import text_type from six import text_type
from catalyst.data import bundles as bundles_module from catalyst.data import bundles as bundles_module
@@ -12,6 +14,7 @@ from catalyst.exchange.exchange_bundle import ExchangeBundle
from catalyst.exchange.utils.exchange_utils import delete_algo_folder from catalyst.exchange.utils.exchange_utils import delete_algo_folder
from catalyst.utils.cli import Date, Timestamp from catalyst.utils.cli import Date, Timestamp
from catalyst.utils.run_algo import _run, load_extensions from catalyst.utils.run_algo import _run, load_extensions
from catalyst.utils.run_server import run_server
try: try:
__IPYTHON__ __IPYTHON__
@@ -257,7 +260,7 @@ def run(ctx,
if capital_base is None: if capital_base is None:
ctx.fail("must specify a capital base with '--capital-base'") ctx.fail("must specify a capital base with '--capital-base'")
click.echo('Running in backtesting mode.') click.echo('Running in backtesting mode.', sys.stdout)
perf = _run( perf = _run(
initialize=None, initialize=None,
@@ -290,7 +293,7 @@ def run(ctx,
) )
if output == '-': if output == '-':
click.echo(str(perf)) click.echo(str(perf), sys.stdout)
elif output != os.devnull: # make the catalyst magic not write any data elif output != os.devnull: # make the catalyst magic not write any data
perf.to_pickle(output) perf.to_pickle(output)
@@ -460,10 +463,10 @@ def live(ctx,
ctx.fail("must specify a capital base with '--capital-base'") ctx.fail("must specify a capital base with '--capital-base'")
if simulate_orders: if simulate_orders:
click.echo('Running in paper trading mode.') click.echo('Running in paper trading mode.', sys.stdout)
else: else:
click.echo('Running in live trading mode.') click.echo('Running in live trading mode.', sys.stdout)
perf = _run( perf = _run(
initialize=None, initialize=None,
@@ -496,7 +499,371 @@ def live(ctx,
) )
if output == '-': if output == '-':
click.echo(str(perf)) click.echo(str(perf), sys.stdout)
elif output != os.devnull: # make the catalyst magic not write any data
perf.to_pickle(output)
return perf
@main.command(name='serve')
@click.option(
'-f',
'--algofile',
default=None,
type=click.File('r'),
help='The file that contains the algorithm to run.',
)
@click.option(
'-t',
'--algotext',
help='The algorithm script to run.',
)
@click.option(
'-D',
'--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 expression. These are evaluated in order so they"
" may refer to previously defined names.",
)
@click.option(
'--data-frequency',
type=click.Choice({'daily', 'minute'}),
default='daily',
show_default=True,
help='The data frequency of the simulation.',
)
@click.option(
'--capital-base',
type=float,
show_default=True,
help='The starting capital for the simulation.',
)
@click.option(
'-b',
'--bundle',
default='poloniex',
metavar='BUNDLE-NAME',
show_default=True,
help='The data bundle to use for the simulation.',
)
@click.option(
'--bundle-timestamp',
type=Timestamp(),
default=pd.Timestamp.utcnow(),
show_default=False,
help='The date to lookup data on or before.\n'
'[default: <current-time>]'
)
@click.option(
'-s',
'--start',
type=Date(tz='utc', as_timestamp=True),
help='The start date of the simulation.',
)
@click.option(
'-e',
'--end',
type=Date(tz='utc', as_timestamp=True),
help='The end date of the simulation.',
)
@click.option(
'-o',
'--output',
default='-',
metavar='FILENAME',
show_default=True,
help="The location to write the perf data. If this is '-' the perf"
" will be written to stdout.",
)
@click.option(
'--print-algo/--no-print-algo',
is_flag=True,
default=False,
help='Print the algorithm to stdout.',
)
@ipython_only(click.option(
'--local-namespace/--no-local-namespace',
is_flag=True,
default=None,
help='Should the algorithm methods be resolved in the local namespace.'
))
@click.option(
'-x',
'--exchange-name',
help='The name of the targeted exchange.',
)
@click.option(
'-n',
'--algo-namespace',
help='A label assigned to the algorithm for data storage purposes.'
)
@click.option(
'-c',
'--base-currency',
help='The base currency used to calculate statistics '
'(e.g. usd, btc, eth).',
)
@click.pass_context
def run(ctx,
algofile,
algotext,
define,
data_frequency,
capital_base,
bundle,
bundle_timestamp,
start,
end,
output,
print_algo,
local_namespace,
exchange_name,
algo_namespace,
base_currency):
"""Run a backtest for the given algorithm on the server.
"""
if (algotext is not None) == (algofile is not None):
ctx.fail(
"must specify exactly one of '-f' / '--algofile' or"
" '-t' / '--algotext'",
)
# check that the start and end dates are passed correctly
if start is None and end is None:
# check both at the same time to avoid the case where a user
# 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'"
" in backtest mode",
)
if start is None:
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'"
" 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'")
click.echo('Running in backtesting mode.', sys.stdout)
perf = run_server(
initialize=None,
handle_data=None,
before_trading_start=None,
analyze=None,
algofile=algofile,
algotext=algotext,
defines=define,
data_frequency=data_frequency,
capital_base=capital_base,
data=None,
bundle=bundle,
bundle_timestamp=bundle_timestamp,
start=start,
end=end,
output=output,
print_algo=print_algo,
local_namespace=local_namespace,
environ=os.environ,
live=False,
exchange=exchange_name,
algo_namespace=algo_namespace,
base_currency=base_currency,
analyze_live=None,
live_graph=False,
simulate_orders=True,
auth_aliases=None,
stats_output=None,
)
if output == '-':
click.echo(str(perf), sys.stdout)
elif output != os.devnull: # make the catalyst magic not write any data
perf.to_pickle(output)
return perf
@main.command(name='serve-live')
@click.option(
'-f',
'--algofile',
default=None,
type=click.File('r'),
help='The file that contains the algorithm to run.',
)
@click.option(
'--capital-base',
type=float,
show_default=True,
help='The amount of capital (in base_currency) allocated to trading.',
)
@click.option(
'-t',
'--algotext',
help='The algorithm script to run.',
)
@click.option(
'-D',
'--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 expression. These are evaluated in order so they"
" may refer to previously defined names.",
)
@click.option(
'-o',
'--output',
default='-',
metavar='FILENAME',
show_default=True,
help="The location to write the perf data. If this is '-' the perf will"
" be written to stdout.",
)
@click.option(
'--print-algo/--no-print-algo',
is_flag=True,
default=False,
help='Print the algorithm to stdout.',
)
@ipython_only(click.option(
'--local-namespace/--no-local-namespace',
is_flag=True,
default=None,
help='Should the algorithm methods be resolved in the local namespace.'
))
@click.option(
'-x',
'--exchange-name',
help='The name of the targeted exchange.',
)
@click.option(
'-n',
'--algo-namespace',
help='A label assigned to the algorithm for data storage purposes.'
)
@click.option(
'-c',
'--base-currency',
help='The base currency used to calculate statistics '
'(e.g. usd, btc, eth).',
)
@click.option(
'-e',
'--end',
type=Date(tz='utc', as_timestamp=True),
help='An optional end date at which to stop the execution.',
)
@click.option(
'--live-graph/--no-live-graph',
is_flag=True,
default=False,
help='Display live graph.',
)
@click.option(
'--simulate-orders/--no-simulate-orders',
is_flag=True,
default=True,
help='Simulating orders enable the paper trading mode. No orders will be '
'sent to the exchange unless set to false.',
)
@click.option(
'--auth-aliases',
default=None,
help='Authentication file aliases for the specified exchanges. By default,'
'each exchange uses the "auth.json" file in the exchange folder. '
'Specifying an "auth2" alias would use "auth2.json". It should be '
'specified like this: "[exchange_name],[alias],..." For example, '
'"binance,auth2" or "binance,auth2,bittrex,auth2".',
)
@click.pass_context
def serve_live(ctx,
algofile,
capital_base,
algotext,
define,
output,
print_algo,
local_namespace,
exchange_name,
algo_namespace,
base_currency,
end,
live_graph,
auth_aliases,
simulate_orders):
"""Trade live with the given algorithm on the server.
"""
if (algotext is not None) == (algofile is not None):
ctx.fail(
"must specify exactly one of '-f' / '--algofile' or"
" '-t' / '--algotext'",
)
if exchange_name is None:
ctx.fail("must specify an exchange name '-x'")
if algo_namespace is None:
ctx.fail("must specify an algorithm name '-n' in live execution mode")
if base_currency is None:
ctx.fail("must specify a base currency '-c' in live execution mode")
if capital_base is None:
ctx.fail("must specify a capital base with '--capital-base'")
if simulate_orders:
click.echo('Running in paper trading mode.', sys.stdout)
else:
click.echo('Running in live trading mode.', sys.stdout)
perf = run_server(
initialize=None,
handle_data=None,
before_trading_start=None,
analyze=None,
algofile=algofile,
algotext=algotext,
defines=define,
data_frequency=None,
capital_base=capital_base,
data=None,
bundle=None,
bundle_timestamp=None,
start=None,
end=end,
output=output,
print_algo=print_algo,
local_namespace=local_namespace,
environ=os.environ,
live=True,
exchange=exchange_name,
algo_namespace=algo_namespace,
base_currency=base_currency,
live_graph=live_graph,
analyze_live=None,
simulate_orders=simulate_orders,
auth_aliases=auth_aliases,
stats_output=None,
)
if output == '-':
click.echo(str(perf), sys.stdout)
elif output != os.devnull: # make the catalyst magic not write any data elif output != os.devnull: # make the catalyst magic not write any data
perf.to_pickle(output) perf.to_pickle(output)
@@ -578,7 +945,8 @@ def ingest_exchange(ctx, exchange_name, data_frequency, start, end,
exchange_bundle = ExchangeBundle(exchange_name) exchange_bundle = ExchangeBundle(exchange_name)
click.echo('Ingesting exchange bundle {}...'.format(exchange_name)) click.echo('Ingesting exchange bundle {}...'.format(exchange_name),
sys.stdout)
exchange_bundle.ingest( exchange_bundle.ingest(
data_frequency=data_frequency, data_frequency=data_frequency,
include_symbols=include_symbols, include_symbols=include_symbols,
@@ -601,10 +969,11 @@ def ingest_exchange(ctx, exchange_name, data_frequency, start, end,
@click.pass_context @click.pass_context
def clean_algo(ctx, algo_namespace): def clean_algo(ctx, algo_namespace):
click.echo( click.echo(
'Cleaning algo state: {}'.format(algo_namespace) 'Cleaning algo state: {}'.format(algo_namespace),
sys.stdout
) )
delete_algo_folder(algo_namespace) delete_algo_folder(algo_namespace)
click.echo('Done') click.echo('Done', sys.stdout)
@main.command(name='clean-exchange') @main.command(name='clean-exchange')
@@ -631,11 +1000,12 @@ def clean_exchange(ctx, exchange_name, data_frequency):
exchange_bundle = ExchangeBundle(exchange_name) exchange_bundle = ExchangeBundle(exchange_name)
click.echo('Cleaning exchange bundle {}...'.format(exchange_name)) click.echo('Cleaning exchange bundle {}...'.format(exchange_name),
sys.stdout)
exchange_bundle.clean( exchange_bundle.clean(
data_frequency=data_frequency, data_frequency=data_frequency,
) )
click.echo('Done') click.echo('Done', sys.stdout)
@main.command() @main.command()
@@ -756,7 +1126,131 @@ def bundles():
# because there were no entries, print a single message indicating that # because there were no entries, print a single message indicating that
# no ingestions have yet been made. # no ingestions have yet been made.
for timestamp in ingestions or ["<no ingestions>"]: for timestamp in ingestions or ["<no ingestions>"]:
click.echo("%s %s" % (bundle, timestamp)) click.echo("%s %s" % (bundle, timestamp), sys.stdout)
@main.group()
@click.pass_context
def marketplace(ctx):
pass
@marketplace.command()
@click.pass_context
def ls(ctx):
click.echo('Listing of available data sources on the marketplace:',
sys.stdout)
marketplace = Marketplace()
marketplace.list()
@marketplace.command()
@click.option(
'--dataset',
default=None,
help='The name of the dataset to ingest from the Data Marketplace.',
)
@click.pass_context
def subscribe(ctx, dataset):
if dataset is None:
ctx.fail("must specify a dataset to subscribe to with '--dataset'\n"
"List available dataset on the marketplace with "
"'catalyst marketplace ls'")
marketplace = Marketplace()
marketplace.subscribe(dataset)
@marketplace.command()
@click.option(
'--dataset',
default=None,
help='The name of the dataset to ingest from the Data Marketplace.',
)
@click.option(
'-f',
'--data-frequency',
type=click.Choice({'daily', 'minute', 'daily,minute', 'minute,daily'}),
default='daily',
show_default=True,
help='The data frequency of the desired OHLCV bars.',
)
@click.option(
'-s',
'--start',
default=None,
type=Date(tz='utc', as_timestamp=True),
help='The start date of the data range. (default: one year from end date)',
)
@click.option(
'-e',
'--end',
default=None,
type=Date(tz='utc', as_timestamp=True),
help='The end date of the data range. (default: today)',
)
@click.pass_context
def ingest(ctx, dataset, data_frequency, start, end):
if dataset is None:
ctx.fail("must specify a dataset to clean with '--dataset'\n"
"List available dataset on the marketplace with "
"'catalyst marketplace ls'")
click.echo('Ingesting data: {}'.format(dataset), sys.stdout)
marketplace = Marketplace()
marketplace.ingest(dataset, data_frequency, start, end)
@marketplace.command()
@click.option(
'--dataset',
default=None,
help='The name of the dataset to ingest from the Data Marketplace.',
)
@click.pass_context
def clean(ctx, dataset):
if dataset is None:
ctx.fail("must specify a dataset to ingest with '--dataset'\n"
"List available dataset on the marketplace with "
"'catalyst marketplace ls'")
click.echo('Cleaning data source: {}'.format(dataset), sys.stdout)
marketplace = Marketplace()
marketplace.clean(dataset)
click.echo('Done', sys.stdout)
@marketplace.command()
@click.pass_context
def register(ctx):
marketplace = Marketplace()
marketplace.register()
@marketplace.command()
@click.option(
'--dataset',
default=None,
help='The name of the Marketplace dataset to publish data for.',
)
@click.option(
'--datadir',
default=None,
help='The folder that contains the CSV data files to publish.',
)
@click.option(
'--watch/--no-watch',
is_flag=True,
default=False,
help='Whether to watch the datadir for live data.',
)
@click.pass_context
def publish(ctx, dataset, datadir, watch):
marketplace = Marketplace()
if dataset is None:
ctx.fail("must specify a dataset to publish data for "
" with '--dataset'\n")
if datadir is None:
ctx.fail("must specify a datadir where to find the files to publish "
" with '--datadir'\n")
marketplace.publish(dataset, datadir, watch)
if __name__ == '__main__': if __name__ == '__main__':
+5 -5
View File
@@ -939,7 +939,7 @@ class TradingAlgorithm(object):
The field to query. The options have the following meanings: The field to query. The options have the following meanings:
arena : str arena : str
The arena from the simulation parameters. This will normally The arena from the simulation parameters. This will normally
be ``'backtest'`` but some systems may use this distinguish be ``backtest`` but some systems may use this distinguish
live trading from backtesting. live trading from backtesting.
data_frequency : {'daily', 'minute'} data_frequency : {'daily', 'minute'}
data_frequency tells the algorithm if it is running with data_frequency tells the algorithm if it is running with
@@ -954,7 +954,7 @@ class TradingAlgorithm(object):
The platform that the code is running on. By default this The platform that the code is running on. By default this
will be the string 'catalyst'. This can allow algorithms to will be the string 'catalyst'. This can allow algorithms to
know if they are running on the Quantopian platform instead. know if they are running on the Quantopian platform instead.
* : dict[str -> any] \* : dict[str -> any]
Returns all of the fields in a dictionary. Returns all of the fields in a dictionary.
Returns Returns
@@ -1032,7 +1032,7 @@ class TradingAlgorithm(object):
argument is the name of the column in the preprocessed dataframe argument is the name of the column in the preprocessed dataframe
containing the symbols. This will be used along with the date containing the symbols. This will be used along with the date
information to map the sids in the asset finder. information to map the sids in the asset finder.
**kwargs \*\*kwargs
Forwarded to :func:`pandas.read_csv`. Forwarded to :func:`pandas.read_csv`.
Returns Returns
@@ -1156,7 +1156,7 @@ class TradingAlgorithm(object):
Parameters Parameters
---------- ----------
**kwargs \*\*kwargs
The names and values to record. The names and values to record.
Notes Notes
@@ -1273,7 +1273,7 @@ class TradingAlgorithm(object):
Parameters Parameters
---------- ----------
*args : iterable[str] \*args : iterable[str]
The ticker symbols to lookup. The ticker symbols to lookup.
Returns Returns
+65 -8
View File
@@ -34,6 +34,7 @@ def attach_pipeline(pipeline, name, chunks=None):
:func:`catalyst.api.pipeline_output` :func:`catalyst.api.pipeline_output`
""" """
def batch_market_order(share_counts): def batch_market_order(share_counts):
"""Place a batch market order for multiple assets. """Place a batch market order for multiple assets.
@@ -48,6 +49,7 @@ def batch_market_order(share_counts):
Index of ids for newly-created orders. Index of ids for newly-created orders.
""" """
def cancel_order(order_param): def cancel_order(order_param):
"""Cancel an open order. """Cancel an open order.
@@ -57,7 +59,9 @@ def cancel_order(order_param):
The order_id or order object to cancel. The order_id or order object to cancel.
""" """
def continuous_future(root_symbol_str, offset=0, roll='volume', adjustment='mul'):
def continuous_future(root_symbol_str, offset=0, roll='volume',
adjustment='mul'):
"""Create a specifier for a continuous contract. """Create a specifier for a continuous contract.
Parameters Parameters
@@ -81,7 +85,10 @@ def continuous_future(root_symbol_str, offset=0, roll='volume', adjustment='mul'
The continuous future specifier. The continuous future specifier.
""" """
def fetch_csv(url, pre_func=None, post_func=None, date_column='date', date_format=None, timezone='UTC', symbol=None, mask=True, symbol_column=None, special_params_checker=None, **kwargs):
def fetch_csv(url, pre_func=None, post_func=None, date_column='date',
date_format=None, timezone='UTC', symbol=None, mask=True,
symbol_column=None, special_params_checker=None, **kwargs):
"""Fetch a csv from a remote url and register the data so that it is """Fetch a csv from a remote url and register the data so that it is
queryable from the ``data`` object. queryable from the ``data`` object.
@@ -125,6 +132,7 @@ def fetch_csv(url, pre_func=None, post_func=None, date_column='date', date_forma
A requests source that will pull data from the url specified. A requests source that will pull data from the url specified.
""" """
def future_symbol(symbol): def future_symbol(symbol):
"""Lookup a futures contract with a given symbol. """Lookup a futures contract with a given symbol.
@@ -144,6 +152,7 @@ def future_symbol(symbol):
Raised when no contract named 'symbol' is found. Raised when no contract named 'symbol' is found.
""" """
def get_datetime(tz=None): def get_datetime(tz=None):
""" """
Returns the current simulation datetime. Returns the current simulation datetime.
@@ -159,6 +168,7 @@ dt : datetime
The current simulation datetime converted to ``tz``. The current simulation datetime converted to ``tz``.
""" """
def get_environment(field='platform'): def get_environment(field='platform'):
"""Query the execution environment. """Query the execution environment.
@@ -198,6 +208,7 @@ def get_environment(field='platform'):
Raised when ``field`` is not a valid option. Raised when ``field`` is not a valid option.
""" """
def get_order(order_id): def get_order(order_id):
"""Lookup an order based on the order id returned from one of the """Lookup an order based on the order id returned from one of the
order functions. order functions.
@@ -213,10 +224,12 @@ def get_order(order_id):
The order object. The order object.
""" """
def history(bar_count, frequency, field, ffill=True): def history(bar_count, frequency, field, ffill=True):
"""DEPRECATED: use ``data.history`` instead. """DEPRECATED: use ``data.history`` instead.
""" """
def order(asset, amount, limit_price=None, stop_price=None, style=None): def order(asset, amount, limit_price=None, stop_price=None, style=None):
"""Place an order. """Place an order.
@@ -258,7 +271,9 @@ def order(asset, amount, limit_price=None, stop_price=None, style=None):
:func:`catalyst.api.order_percent` :func:`catalyst.api.order_percent`
""" """
def order_percent(asset, percent, limit_price=None, stop_price=None, style=None):
def order_percent(asset, percent, limit_price=None, stop_price=None,
style=None):
"""Place an order in the specified asset corresponding to the given """Place an order in the specified asset corresponding to the given
percent of the current portfolio value. percent of the current portfolio value.
@@ -293,6 +308,7 @@ def order_percent(asset, percent, limit_price=None, stop_price=None, style=None)
:func:`catalyst.api.order_value` :func:`catalyst.api.order_value`
""" """
def order_target(asset, target, limit_price=None, stop_price=None, style=None): def order_target(asset, target, limit_price=None, stop_price=None, style=None):
"""Place an order to adjust a position to a target number of shares. If """Place an order to adjust a position to a target number of shares. If
the position doesn't already exist, this is equivalent to placing a new the position doesn't already exist, this is equivalent to placing a new
@@ -344,7 +360,9 @@ def order_target(asset, target, limit_price=None, stop_price=None, style=None):
:func:`catalyst.api.order_target_value` :func:`catalyst.api.order_target_value`
""" """
def order_target_percent(asset, target, limit_price=None, stop_price=None, style=None):
def order_target_percent(asset, target, limit_price=None, stop_price=None,
style=None):
"""Place an order to adjust a position to a target percent of the """Place an order to adjust a position to a target percent of the
current portfolio value. If the position doesn't already exist, this is current portfolio value. If the position doesn't already exist, this is
equivalent to placing a new order. If the position does exist, this is equivalent to placing a new order. If the position does exist, this is
@@ -396,7 +414,9 @@ def order_target_percent(asset, target, limit_price=None, stop_price=None, style
:func:`catalyst.api.order_target_value` :func:`catalyst.api.order_target_value`
""" """
def order_target_value(asset, target, limit_price=None, stop_price=None, style=None):
def order_target_value(asset, target, limit_price=None, stop_price=None,
style=None):
"""Place an order to adjust a position to a target value. If """Place an order to adjust a position to a target value. If
the position doesn't already exist, this is equivalent to placing a new the position doesn't already exist, this is equivalent to placing a new
order. If the position does exist, this is equivalent to placing an order. If the position does exist, this is equivalent to placing an
@@ -448,6 +468,7 @@ def order_target_value(asset, target, limit_price=None, stop_price=None, style=N
:func:`catalyst.api.order_target_percent` :func:`catalyst.api.order_target_percent`
""" """
def order_value(asset, value, limit_price=None, stop_price=None, style=None): def order_value(asset, value, limit_price=None, stop_price=None, style=None):
"""Place an order by desired value rather than desired number of """Place an order by desired value rather than desired number of
shares. shares.
@@ -488,6 +509,7 @@ def order_value(asset, value, limit_price=None, stop_price=None, style=None):
:func:`catalyst.api.order_percent` :func:`catalyst.api.order_percent`
""" """
def pipeline_output(name): def pipeline_output(name):
"""Get the results of the pipeline that was attached with the name: """Get the results of the pipeline that was attached with the name:
``name``. ``name``.
@@ -514,6 +536,7 @@ def pipeline_output(name):
:meth:`catalyst.pipeline.engine.PipelineEngine.run_pipeline` :meth:`catalyst.pipeline.engine.PipelineEngine.run_pipeline`
""" """
def record(*args, **kwargs): def record(*args, **kwargs):
"""Track and record values each day. """Track and record values each day.
@@ -529,7 +552,9 @@ def record(*args, **kwargs):
:func:`~catalyst.run_algorithm`. :func:`~catalyst.run_algorithm`.
""" """
def schedule_function(func, date_rule=None, time_rule=None, half_days=True, calendar=None):
def schedule_function(func, date_rule=None, time_rule=None, half_days=True,
calendar=None):
"""Schedules a function to be called according to some timed rules. """Schedules a function to be called according to some timed rules.
Parameters Parameters
@@ -549,6 +574,7 @@ def schedule_function(func, date_rule=None, time_rule=None, half_days=True, cale
:class:`catalyst.api.time_rules` :class:`catalyst.api.time_rules`
""" """
def set_asset_restrictions(restrictions, on_error='fail'): def set_asset_restrictions(restrictions, on_error='fail'):
"""Set a restriction on which assets can be ordered. """Set a restriction on which assets can be ordered.
@@ -562,6 +588,7 @@ def set_asset_restrictions(restrictions, on_error='fail'):
catalyst.finance.asset_restrictions.Restrictions catalyst.finance.asset_restrictions.Restrictions
""" """
def set_benchmark(benchmark): def set_benchmark(benchmark):
"""Set the benchmark asset. """Set the benchmark asset.
@@ -576,6 +603,7 @@ def set_benchmark(benchmark):
automatically reinvested. automatically reinvested.
""" """
def set_cancel_policy(cancel_policy): def set_cancel_policy(cancel_policy):
"""Sets the order cancellation policy for the simulation. """Sets the order cancellation policy for the simulation.
@@ -590,6 +618,7 @@ def set_cancel_policy(cancel_policy):
:class:`catalyst.api.NeverCancel` :class:`catalyst.api.NeverCancel`
""" """
def set_commission(commission): def set_commission(commission):
"""Sets the commission model for the simulation. """Sets the commission model for the simulation.
@@ -605,6 +634,7 @@ def set_commission(commission):
:class:`catalyst.finance.commission.PerDollar` :class:`catalyst.finance.commission.PerDollar`
""" """
def set_do_not_order_list(restricted_list, on_error='fail'): def set_do_not_order_list(restricted_list, on_error='fail'):
"""Set a restriction on which assets can be ordered. """Set a restriction on which assets can be ordered.
@@ -614,11 +644,13 @@ def set_do_not_order_list(restricted_list, on_error='fail'):
The assets that cannot be ordered. The assets that cannot be ordered.
""" """
def set_long_only(on_error='fail'): def set_long_only(on_error='fail'):
"""Set a rule specifying that this algorithm cannot take short """Set a rule specifying that this algorithm cannot take short
positions. positions.
""" """
def set_max_leverage(max_leverage): def set_max_leverage(max_leverage):
"""Set a limit on the maximum leverage of the algorithm. """Set a limit on the maximum leverage of the algorithm.
@@ -629,6 +661,7 @@ def set_max_leverage(max_leverage):
be no maximum. be no maximum.
""" """
def set_max_order_count(max_count, on_error='fail'): def set_max_order_count(max_count, on_error='fail'):
"""Set a limit on the number of orders that can be placed in a single """Set a limit on the number of orders that can be placed in a single
day. day.
@@ -639,7 +672,9 @@ def set_max_order_count(max_count, on_error='fail'):
The maximum number of orders that can be placed on any single day. The maximum number of orders that can be placed on any single day.
""" """
def set_max_order_size(asset=None, max_shares=None, max_notional=None, on_error='fail'):
def set_max_order_size(asset=None, max_shares=None, max_notional=None,
on_error='fail'):
"""Set a limit on the number of shares and/or dollar value of any single """Set a limit on the number of shares and/or dollar value of any single
order placed for sid. Limits are treated as absolute values and are order placed for sid. Limits are treated as absolute values and are
enforced at the time that the algo attempts to place an order for sid. enforced at the time that the algo attempts to place an order for sid.
@@ -658,7 +693,9 @@ def set_max_order_size(asset=None, max_shares=None, max_notional=None, on_error=
The maximum value that can be ordered at one time. The maximum value that can be ordered at one time.
""" """
def set_max_position_size(asset=None, max_shares=None, max_notional=None, on_error='fail'):
def set_max_position_size(asset=None, max_shares=None, max_notional=None,
on_error='fail'):
"""Set a limit on the number of shares and/or dollar value held for the """Set a limit on the number of shares and/or dollar value held for the
given sid. Limits are treated as absolute values and are enforced at given sid. Limits are treated as absolute values and are enforced at
the time that the algo attempts to place an order for sid. This means the time that the algo attempts to place an order for sid. This means
@@ -681,6 +718,7 @@ def set_max_position_size(asset=None, max_shares=None, max_notional=None, on_err
The maximum value to hold for an asset. The maximum value to hold for an asset.
""" """
def set_slippage(slippage): def set_slippage(slippage):
"""Set the slippage model for the simulation. """Set the slippage model for the simulation.
@@ -694,6 +732,7 @@ def set_slippage(slippage):
:class:`catalyst.finance.slippage.SlippageModel` :class:`catalyst.finance.slippage.SlippageModel`
""" """
def set_symbol_lookup_date(dt): def set_symbol_lookup_date(dt):
"""Set the date for which symbols will be resolved to their assets """Set the date for which symbols will be resolved to their assets
(symbols may map to different firms or underlying assets at (symbols may map to different firms or underlying assets at
@@ -705,6 +744,7 @@ def set_symbol_lookup_date(dt):
The new symbol lookup date. The new symbol lookup date.
""" """
def sid(sid): def sid(sid):
"""Lookup an Asset by its unique asset identifier. """Lookup an Asset by its unique asset identifier.
@@ -724,6 +764,7 @@ def sid(sid):
When a requested ``sid`` does not map to any asset. When a requested ``sid`` does not map to any asset.
""" """
def symbol(symbol_str): def symbol(symbol_str):
"""Lookup an Equity by its ticker symbol. """Lookup an Equity by its ticker symbol.
@@ -748,6 +789,7 @@ def symbol(symbol_str):
:func:`catalyst.api.set_symbol_lookup_date` :func:`catalyst.api.set_symbol_lookup_date`
""" """
def symbols(*args): def symbols(*args):
"""Lookup multuple Equities as a list. """Lookup multuple Equities as a list.
@@ -773,3 +815,18 @@ def symbols(*args):
:func:`catalyst.api.set_symbol_lookup_date` :func:`catalyst.api.set_symbol_lookup_date`
""" """
def get_dataset(ds_name, start=None, end=None):
"""
Lookup a data source from the marketplace
Parameters
----------
ds_name: str
start: pd.Timestamp
end: pd.Timestamp
Returns
-------
"""
+28
View File
@@ -15,4 +15,32 @@ SYMBOLS_URL = 'https://s3.amazonaws.com/enigmaco/catalyst-exchanges/' \
DATE_TIME_FORMAT = '%Y-%m-%d %H:%M' DATE_TIME_FORMAT = '%Y-%m-%d %H:%M'
DATE_FORMAT = '%Y-%m-%d' DATE_FORMAT = '%Y-%m-%d'
try:
ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
except Exception as e:
print('unable to get catalyst path: {}'.format(e))
AUTO_INGEST = False AUTO_INGEST = False
AUTH_SERVER = 'https://data.enigma.co'
# TODO: switch to mainnet
ETH_REMOTE_NODE = 'https://ropsten.infura.io/'
MARKETPLACE_CONTRACT = 'https://raw.githubusercontent.com/enigmampc/' \
'catalyst/master/catalyst/marketplace/' \
'contract_marketplace_address.txt'
MARKETPLACE_CONTRACT_ABI = 'https://raw.githubusercontent.com/enigmampc/' \
'catalyst/master/catalyst/marketplace/' \
'contract_marketplace_abi.json'
# TODO: switch to mainnet
ENIGMA_CONTRACT = 'https://raw.githubusercontent.com/enigmampc/catalyst/' \
'master/catalyst/marketplace/' \
'contract_enigma_address.txt'
ENIGMA_CONTRACT_ABI = 'https://raw.githubusercontent.com/enigmampc/' \
'catalyst/master/catalyst/marketplace/' \
'contract_enigma_abi.json'
+3 -3
View File
@@ -60,7 +60,7 @@ def _handle_data(context, data):
rsi=rsi, rsi=rsi,
) )
orders = get_open_orders(context.asset) orders = context.blotter.open_orders
if orders: if orders:
log.info('skipping bar until all open orders execute') log.info('skipping bar until all open orders execute')
return return
@@ -146,11 +146,11 @@ if __name__ == '__main__':
live = True live = True
if live: if live:
run_algorithm( run_algorithm(
capital_base=0.001, capital_base=1000,
initialize=initialize, initialize=initialize,
handle_data=handle_data, handle_data=handle_data,
analyze=analyze, analyze=analyze,
exchange_name='binance', exchange_name='bittrex',
live=True, live=True,
algo_namespace=algo_namespace, algo_namespace=algo_namespace,
base_currency='btc', base_currency='btc',
+16 -15
View File
@@ -4,8 +4,7 @@ import pandas as pd
from logbook import Logger from logbook import Logger
from catalyst import run_algorithm from catalyst import run_algorithm
from catalyst.api import (record, symbol, order_target_percent, from catalyst.api import (record, symbol, order_target_percent,)
get_open_orders)
from catalyst.exchange.utils.stats_utils import extract_transactions from catalyst.exchange.utils.stats_utils import extract_transactions
NAMESPACE = 'dual_moving_average' NAMESPACE = 'dual_moving_average'
@@ -32,16 +31,18 @@ def handle_data(context, data):
# moving average with the appropriate parameters. We choose to use # moving average with the appropriate parameters. We choose to use
# minute bars for this simulation -> freq="1m" # minute bars for this simulation -> freq="1m"
# Returns a pandas dataframe. # Returns a pandas dataframe.
short_mavg = data.history(context.asset, short_data = data.history(context.asset,
'price', 'price',
bar_count=short_window, bar_count=short_window,
frequency="1m", frequency="1T",
).mean() )
long_mavg = data.history(context.asset, short_mavg = short_data.mean()
long_data = data.history(context.asset,
'price', 'price',
bar_count=long_window, bar_count=long_window,
frequency="1m", frequency="1T",
).mean() )
long_mavg = long_data.mean()
# Let's keep the price of our asset in a more handy variable # Let's keep the price of our asset in a more handy variable
price = data.current(context.asset, 'price') price = data.current(context.asset, 'price')
@@ -61,7 +62,7 @@ def handle_data(context, data):
# Since we are using limit orders, some orders may not execute immediately # Since we are using limit orders, some orders may not execute immediately
# we wait until all orders are executed before considering more trades. # we wait until all orders are executed before considering more trades.
orders = get_open_orders(context.asset) orders = context.blotter.open_orders
if len(orders) > 0: if len(orders) > 0:
return return
@@ -82,7 +83,6 @@ def handle_data(context, data):
def analyze(context, perf): def analyze(context, perf):
# Get the base_currency that was passed as a parameter to the simulation # Get the base_currency that was passed as a parameter to the simulation
exchange = list(context.exchanges.values())[0] exchange = list(context.exchanges.values())[0]
base_currency = exchange.base_currency.upper() base_currency = exchange.base_currency.upper()
@@ -93,7 +93,7 @@ def analyze(context, perf):
ax1.legend_.remove() ax1.legend_.remove()
ax1.set_ylabel('Portfolio Value\n({})'.format(base_currency)) ax1.set_ylabel('Portfolio Value\n({})'.format(base_currency))
start, end = ax1.get_ylim() start, end = ax1.get_ylim()
ax1.yaxis.set_ticks(np.arange(start, end, (end-start)/5)) ax1.yaxis.set_ticks(np.arange(start, end, (end - start) / 5))
# Second chart: Plot asset price, moving averages and buys/sells # Second chart: Plot asset price, moving averages and buys/sells
ax2 = plt.subplot(412, sharex=ax1) ax2 = plt.subplot(412, sharex=ax1)
@@ -104,9 +104,9 @@ def analyze(context, perf):
ax2.set_ylabel('{asset}\n({base})'.format( ax2.set_ylabel('{asset}\n({base})'.format(
asset=context.asset.symbol, asset=context.asset.symbol,
base=base_currency base=base_currency
)) ))
start, end = ax2.get_ylim() start, end = ax2.get_ylim()
ax2.yaxis.set_ticks(np.arange(start, end, (end-start)/5)) ax2.yaxis.set_ticks(np.arange(start, end, (end - start) / 5))
transaction_df = extract_transactions(perf) transaction_df = extract_transactions(perf)
if not transaction_df.empty: if not transaction_df.empty:
@@ -136,19 +136,20 @@ def analyze(context, perf):
ax3.legend_.remove() ax3.legend_.remove()
ax3.set_ylabel('Percent Change') ax3.set_ylabel('Percent Change')
start, end = ax3.get_ylim() start, end = ax3.get_ylim()
ax3.yaxis.set_ticks(np.arange(start, end, (end-start)/5)) ax3.yaxis.set_ticks(np.arange(start, end, (end - start) / 5))
# Fourth chart: Plot our cash # Fourth chart: Plot our cash
ax4 = plt.subplot(414, sharex=ax1) ax4 = plt.subplot(414, sharex=ax1)
perf.cash.plot(ax=ax4) perf.cash.plot(ax=ax4)
ax4.set_ylabel('Cash\n({})'.format(base_currency)) ax4.set_ylabel('Cash\n({})'.format(base_currency))
start, end = ax4.get_ylim() start, end = ax4.get_ylim()
ax4.yaxis.set_ticks(np.arange(0, end, end/5)) ax4.yaxis.set_ticks(np.arange(0, end, end / 5))
plt.show() plt.show()
if __name__ == '__main__': if __name__ == '__main__':
run_algorithm( run_algorithm(
capital_base=1000, capital_base=1000,
data_frequency='minute', data_frequency='minute',
@@ -0,0 +1,70 @@
import pandas as pd
import matplotlib.pyplot as plt
from catalyst import run_algorithm
from catalyst.api import symbol, get_dataset
START = '2017-01-01'
END = '2017-12-31'
def initialize(context):
pass
def handle_data(context, data):
context.github = get_dataset('github')
context.github.sort_index(level=0, inplace=True)
context.zec = data.history(symbol('zec_usdt'),
['price', ],
bar_count=365,
frequency="1d")
context.xmr = data.history(symbol('xmr_usdt'),
['price', ],
bar_count=365,
frequency="1d")
def analyze(context=None, results=None):
ax1 = plt.subplot(211)
idx = pd.IndexSlice
df = context.github.loc[START:END].loc[
idx[:, [b'ZEC']], ['commits']].reset_index(
level='symbol', drop=True)
df.plot(ax=ax1, color='blue')
ax1.legend(loc=2)
ax1.set_title('Zcash')
ax2 = ax1.twinx()
context.zec['price'].loc[START:END].plot(ax=ax2, color='green')
ax2.legend(loc=1)
ax3 = plt.subplot(212)
idx = pd.IndexSlice
df = context.github.loc[START:END].loc[
idx[:, [b'XMR']], ['commits']].reset_index(
level='symbol', drop=True)
df.plot(ax=ax3, color='blue')
ax3.legend(loc=2)
ax3.set_title('Monero')
ax4 = ax3.twinx()
context.xmr['price'].loc[START:END].plot(ax=ax4, color='green')
ax4.legend(loc=1)
plt.show()
if __name__ == '__main__':
run_algorithm(
capital_base=1000,
data_frequency='daily',
initialize=initialize,
handle_data=handle_data,
analyze=analyze,
exchange_name='poloniex',
algo_namespace='algo-github',
base_currency='usdt',
live=False,
start=pd.to_datetime(END, utc=True),
end=pd.to_datetime(END, utc=True),
)
@@ -0,0 +1,237 @@
# 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.
import os
import tempfile
import time
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_dataset
from catalyst.exchange.utils.stats_utils import set_print_settings, \
get_pretty_stats
# 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.utils.paths import ensure_directory
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 Neo in Ether.
df = get_dataset('testmarketcap2') # type: pd.DataFrame
# Picking a specific date in our DataFrame
first_dt = df.index.get_level_values(0)[0]
# Since we use a MultiIndex with date / symbol, picking a date will
# result in a new DataFrame for the selected date with a single
# symbol index
df = df.xs(first_dt, level=0)
# Keep only the top coins by market cap
df = df.loc[df['market_cap_usd'].isin(df['market_cap_usd'].nlargest(100))]
set_print_settings()
df.sort_values(by=['market_cap_usd'], ascending=True, inplace=True)
print('the marketplace data:\n{}'.format(df))
# Pick the 5 assets with the lowest market cap for trading
quote_currency = 'eth'
exchange = context.exchanges[next(iter(context.exchanges))]
symbols = [a.symbol for a in exchange.assets
if a.start_date < context.datetime]
context.assets = []
for currency, price in df['market_cap_usd'].iteritems():
if len(context.assets) >= 5:
break
s = '{}_{}'.format(currency.decode('utf-8'), quote_currency)
if s in symbols:
context.assets.append(symbol(s))
context.base_price = None
context.current_day = None
context.RSI_OVERSOLD = 55
context.RSI_OVERBOUGHT = 60
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
# 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 = dict()
context.current_day = today
# Preparing dictionaries for asset-level data points
volumes = dict()
rsis = dict()
price_values = dict()
cash = context.portfolio.cash
for asset in context.assets:
# We're computing the volume-weighted-average-price of the security
# defined above, in the context.assets 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(
asset,
fields='close',
bar_count=50,
frequency=context.CANDLE_SIZE
)
# 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(asset, 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 asset not in context.base_price:
# context.base_price[asset] = price
#
# base_price = context.base_price[asset]
# price_change = (price - base_price) / base_price
# Tracking the relevant data
volumes[asset] = current['volume']
rsis[asset] = rsi[-1]
price_values[asset] = price
# price_changes[asset] = price_change
# We are trying to avoid over-trading by limiting our trades to
# one per day.
if asset in context.traded_today:
continue
# Exit if we cannot trade
if not data.can_trade(asset):
continue
# 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[asset].amount
if rsi[-1] <= context.RSI_OVERSOLD and pos_amount == 0:
log.info(
'{}: buying - price: {}, rsi: {}'.format(
data.current_dt, price, rsi[-1]
)
)
# Set a style for limit orders,
limit_price = price * 1.005
target = 1.0 / len(context.assets)
order_target_percent(
asset, target, limit_price=limit_price
)
context.traded_today[asset] = True
elif rsi[-1] >= context.RSI_OVERBOUGHT and pos_amount > 0:
log.info(
'{}: selling - price: {}, rsi: {}'.format(
data.current_dt, price, rsi[-1]
)
)
limit_price = price * 0.995
order_target_percent(
asset, 0, limit_price=limit_price
)
context.traded_today[asset] = True
# 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(
current_price=price_values,
volume=volumes,
rsi=rsis,
cash=cash,
)
def analyze(context=None, perf=None):
stats = get_pretty_stats(perf)
print('the algo stats:\n{}'.format(stats))
pass
if __name__ == '__main__':
# The execution mode: backtest or live
live = False
if live:
run_algorithm(
capital_base=0.1,
initialize=initialize,
handle_data=handle_data,
analyze=analyze,
exchange_name='poloniex',
live=True,
algo_namespace=NAMESPACE,
base_currency='btc',
live_graph=False,
simulate_orders=False,
stats_output=None,
)
else:
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 bitfinex -s 2017-10-1 -e 2017-11-10 -c usdt -n mean-reversion \
# --data-frequency minute --capital-base 10000
run_algorithm(
capital_base=100,
data_frequency='minute',
initialize=initialize,
handle_data=handle_data,
analyze=analyze,
exchange_name='poloniex',
algo_namespace=NAMESPACE,
base_currency='eth',
start=pd.to_datetime('2017-10-01', utc=True),
end=pd.to_datetime('2017-10-15', utc=True),
)
log.info('saved perf stats: {}'.format(out))
+7 -7
View File
@@ -33,12 +33,12 @@ def initialize(context):
# parameters or values you're going to use. # parameters or values you're going to use.
# In our example, we're looking at Neo in Ether. # In our example, we're looking at Neo in Ether.
context.market = symbol('eth_btc') context.market = symbol('bnb_eth')
context.base_price = None context.base_price = None
context.current_day = None context.current_day = None
context.RSI_OVERSOLD = 55 context.RSI_OVERSOLD = 60
context.RSI_OVERBOUGHT = 60 context.RSI_OVERBOUGHT = 70
context.CANDLE_SIZE = '15T' context.CANDLE_SIZE = '15T'
context.start_time = time.time() context.start_time = time.time()
@@ -248,14 +248,14 @@ if __name__ == '__main__':
if live: if live:
run_algorithm( run_algorithm(
capital_base=0.01, capital_base=0.1,
initialize=initialize, initialize=initialize,
handle_data=handle_data, handle_data=handle_data,
analyze=analyze, analyze=analyze,
exchange_name='poloniex', exchange_name='binance',
live=True, live=True,
algo_namespace=NAMESPACE, algo_namespace=NAMESPACE,
base_currency='btc', base_currency='eth',
live_graph=False, live_graph=False,
simulate_orders=False, simulate_orders=False,
stats_output=None, stats_output=None,
@@ -274,7 +274,7 @@ if __name__ == '__main__':
# -x bitfinex -s 2017-10-1 -e 2017-11-10 -c usdt -n mean-reversion \ # -x bitfinex -s 2017-10-1 -e 2017-11-10 -c usdt -n mean-reversion \
# --data-frequency minute --capital-base 10000 # --data-frequency minute --capital-base 10000
run_algorithm( run_algorithm(
capital_base=0.1, capital_base=0.035,
data_frequency='minute', data_frequency='minute',
initialize=initialize, initialize=initialize,
handle_data=handle_data, handle_data=handle_data,
+2 -1
View File
@@ -146,4 +146,5 @@ if __name__ == '__main__':
start=start, start=start,
end=end, end=end,
exchange_name='poloniex', exchange_name='poloniex',
capital_base=100000, ) capital_base=100000,
base_currency='usdt', )
+2 -2
View File
@@ -26,7 +26,7 @@ def handle_data(context, data):
context.asset, context.asset,
fields='price', fields='price',
bar_count=20, bar_count=20,
frequency='30T' frequency='2H'
) )
last_traded = prices.index[-1] last_traded = prices.index[-1]
log.info('last candle date: {}'.format(last_traded)) log.info('last candle date: {}'.format(last_traded))
@@ -114,7 +114,7 @@ def analyze(context, perf):
if __name__ == '__main__': if __name__ == '__main__':
mode = 'backtest' mode = 'live'
if mode == 'backtest': if mode == 'backtest':
run_algorithm( run_algorithm(
+111 -68
View File
@@ -43,7 +43,8 @@ SUPPORTED_EXCHANGES = dict(
class CCXT(Exchange): class CCXT(Exchange):
def __init__(self, exchange_name, key, secret, base_currency): def __init__(self, exchange_name, key,
secret, password, base_currency):
log.debug( log.debug(
'finding {} in CCXT exchanges:\n{}'.format( 'finding {} in CCXT exchanges:\n{}'.format(
exchange_name, ccxt.exchanges exchange_name, ccxt.exchanges
@@ -60,6 +61,7 @@ class CCXT(Exchange):
self.api = exchange_attr({ self.api = exchange_attr({
'apiKey': key, 'apiKey': key,
'secret': secret, 'secret': secret,
'password': password,
}) })
self.api.enableRateLimit = True self.api.enableRateLimit = True
@@ -425,26 +427,19 @@ class CCXT(Exchange):
'Please provide either start_dt or end_dt, not both.' 'Please provide either start_dt or end_dt, not both.'
) )
elif end_dt is not None: if start_dt is None:
# Make sure that end_dt really wants data in the past if end_dt is None:
# if it's close to now, we skip the 'since' parameters to end_dt = pd.Timestamp.utcnow()
# lower the probability of error
bars_to_now = pd.date_range(
end_dt, pd.Timestamp.utcnow(), freq=freq
)
# See: https://github.com/ccxt/ccxt/issues/1360
if len(bars_to_now) > 1 or self.name in ['poloniex']:
dt_range = get_periods_range(
end_dt=end_dt,
periods=bar_count,
freq=freq,
)
start_dt = dt_range[0]
since = None dt_range = get_periods_range(
if start_dt is not None: end_dt=end_dt,
delta = start_dt - get_epoch() periods=bar_count,
since = int(delta.total_seconds()) * 1000 freq=freq,
)
start_dt = dt_range[0]
delta = start_dt - get_epoch()
since = int(delta.total_seconds()) * 1000
candles = dict() candles = dict()
for index, asset in enumerate(assets): for index, asset in enumerate(assets):
@@ -760,24 +755,23 @@ class CCXT(Exchange):
side = 'buy' if amount > 0 else 'sell' side = 'buy' if amount > 0 else 'sell'
if hasattr(self.api, 'amount_to_lots'): if hasattr(self.api, 'amount_to_lots'):
adj_amount = self.api.amount_to_lots( # TODO: is this right?
symbol=symbol, if self.api.markets is None:
amount=abs(amount), self.api.load_markets()
)
if adj_amount != abs(amount): # https://github.com/ccxt/ccxt/issues/1483
log.info( adj_amount = round(abs(amount), asset.decimals)
'adjusted order amount {} to {} based on lot size'.format( market = self.api.markets[symbol]
abs(amount), adj_amount, if 'lots' in market and market['lots'] > amount:
raise CreateOrderError(
exchange=self.name,
e='order amount lower than the smallest lot: {}'.format(
amount
) )
) )
else:
adj_amount = abs(amount)
if adj_amount == 0: else:
raise CreateOrderError( adj_amount = round(abs(amount), asset.decimals)
exchange=self.name,
e='order amount lower than the smallest lot: {}'.format(amount)
)
try: try:
result = self.api.create_order( result = self.api.create_order(
@@ -799,6 +793,22 @@ class CCXT(Exchange):
) )
raise ExchangeRequestError(error=e) raise ExchangeRequestError(error=e)
exchange_amount = None
if 'amount' in result and result['amount'] != adj_amount:
exchange_amount = result['amount']
elif 'info' in result:
if 'origQty' in result['info']:
exchange_amount = float(result['info']['origQty'])
if exchange_amount:
log.info(
'order amount adjusted by {} from {} to {}'.format(
self.name, adj_amount, exchange_amount
)
)
adj_amount = exchange_amount
if 'info' not in result: if 'info' not in result:
raise ValueError('cannot use order without info attribute') raise ValueError('cannot use order without info attribute')
@@ -859,31 +869,38 @@ class CCXT(Exchange):
order.id, order.asset, return_price=True order.id, order.asset, return_price=True
) )
order.status = exc_order.status order.status = exc_order.status
order.commission = exc_order.commission order.commission = exc_order.commission
if order.amount != exc_order.amount: order.filled = exc_order.amount
log.warn(
'executed order amount {} differs '
'from original'.format(
exc_order.amount, order.amount
)
)
order.amount = exc_order.amount
if order.status == ORDER_STATUS.FILLED: transactions = []
if exc_order.status == ORDER_STATUS.FILLED:
if order.amount > exc_order.amount:
log.warn(
'executed order amount {} differs '
'from original'.format(
exc_order.amount, order.amount
)
)
order.check_triggers(
price=price,
dt=exc_order.dt,
)
transaction = Transaction( transaction = Transaction(
asset=order.asset, asset=order.asset,
amount=order.amount, amount=order.amount,
dt=pd.Timestamp.utcnow(), dt=pd.Timestamp.utcnow(),
price=price, price=price,
order_id=order.id, order_id=order.id,
commission=order.commission commission=order.commission,
) )
return [transaction] transactions.append(transaction)
return transactions
def process_order(self, order): def process_order(self, order):
# TODO: move to parent class after tracking features in the parent # TODO: move to parent class after tracking features in the parent
if not self.api.hasFetchMyTrades: if not self.api.has['fetchMyTrades']:
return self._process_order_fallback(order) return self._process_order_fallback(order)
try: try:
@@ -963,7 +980,8 @@ class CCXT(Exchange):
) )
raise ExchangeRequestError(error=e) raise ExchangeRequestError(error=e)
def cancel_order(self, order_param, asset_or_symbol=None): def cancel_order(self, order_param,
asset_or_symbol=None, params={}):
order_id = order_param.id \ order_id = order_param.id \
if isinstance(order_param, Order) else order_param if isinstance(order_param, Order) else order_param
@@ -975,7 +993,8 @@ class CCXT(Exchange):
try: try:
symbol = self.get_symbol(asset_or_symbol) \ symbol = self.get_symbol(asset_or_symbol) \
if asset_or_symbol is not None else None if asset_or_symbol is not None else None
self.api.cancel_order(id=order_id, symbol=symbol) self.api.cancel_order(id=order_id,
symbol=symbol, params= params)
except (ExchangeError, NetworkError) as e: except (ExchangeError, NetworkError) as e:
log.warn( log.warn(
@@ -985,7 +1004,7 @@ class CCXT(Exchange):
) )
raise ExchangeRequestError(error=e) raise ExchangeRequestError(error=e)
def tickers(self, assets): def tickers(self, assets, on_ticker_error='raise'):
""" """
Retrieve current tick data for the given assets Retrieve current tick data for the given assets
@@ -998,27 +1017,51 @@ class CCXT(Exchange):
list[dict[str, float] list[dict[str, float]
""" """
tickers = {} if len(assets) == 1:
for asset in assets:
symbol = self.get_symbol(asset)
# Test the CCXT throttling further to see if we need this
self.ask_request()
# TODO: use fetch_tickers() for efficiency
# I tried using fetch_tickers() but noticed some
# inconsistencies, see issue:
# https://github.com/ccxt/ccxt/issues/870
try: try:
ticker = self.api.fetch_ticker(symbol=symbol) symbol = self.get_symbol(assets[0])
except (ExchangeError, NetworkError) as e: log.debug('fetching single ticker: {}'.format(symbol))
results = dict()
results[symbol] = self.api.fetch_ticker(symbol=symbol)
except (ExchangeError, NetworkError,) as e:
log.warn( log.warn(
'unable to fetch ticker {} / {}: {}'.format( 'unable to fetch ticker {} / {}: {}'.format(
self.name, asset.symbol, e self.name, symbol, e
) )
) )
continue raise ExchangeRequestError(error=e)
elif len(assets) > 1:
symbols = self.get_symbols(assets)
try:
log.debug('fetching multiple tickers: {}'.format(symbols))
results = self.api.fetch_tickers(symbols=symbols)
except (ExchangeError, NetworkError) as e:
log.warn(
'unable to fetch tickers {} / {}: {}'.format(
self.name, symbols, e
)
)
raise ExchangeRequestError(error=e)
else:
raise ValueError('Cannot request tickers with not assets.')
tickers = dict()
for asset in assets:
symbol = self.get_symbol(asset)
if symbol not in results:
msg = 'ticker not found {} / {}'.format(
self.name, symbol
)
log.warn(msg)
if on_ticker_error == 'warn':
continue
else:
raise ExchangeRequestError(error=msg)
ticker = results[symbol]
ticker['last_traded'] = from_ms_timestamp(ticker['timestamp']) ticker['last_traded'] = from_ms_timestamp(ticker['timestamp'])
if 'last_price' not in ticker: if 'last_price' not in ticker:
@@ -1030,7 +1073,7 @@ class CCXT(Exchange):
ticker['volume'] = ticker['baseVolume'] ticker['volume'] = ticker['baseVolume']
elif 'info' in ticker and 'bidQty' in ticker['info'] \ elif 'info' in ticker and 'bidQty' in ticker['info'] \
and 'askQty' in ticker['info']: and 'askQty' in ticker['info']:
ticker['volume'] = float(ticker['info']['bidQty']) + \ ticker['volume'] = float(ticker['info']['bidQty']) + \
float(ticker['info']['askQty']) float(ticker['info']['askQty'])
@@ -1068,7 +1111,7 @@ class CCXT(Exchange):
return result return result
def get_trades(self, asset, my_trades=True, start_dt=None, limit=None): def get_trades(self, asset, my_trades=True, start_dt=None, limit=100):
if not my_trades: if not my_trades:
raise NotImplemented( raise NotImplemented(
'get_trades only supports "my trades"' 'get_trades only supports "my trades"'
+39 -26
View File
@@ -1,4 +1,5 @@
import abc import abc
import pytz
from abc import ABCMeta, abstractmethod, abstractproperty from abc import ABCMeta, abstractmethod, abstractproperty
from datetime import timedelta from datetime import timedelta
from time import sleep from time import sleep
@@ -178,6 +179,7 @@ class Exchange:
if symbols is None: if symbols is None:
# Make a distinct list of all symbols # Make a distinct list of all symbols
symbols = list(set([asset.symbol for asset in self.assets])) symbols = list(set([asset.symbol for asset in self.assets]))
symbols.sort()
if quote_currency is not None: if quote_currency is not None:
for symbol in symbols[:]: for symbol in symbols[:]:
@@ -501,7 +503,7 @@ class Exchange:
""" """
freq, candle_size, unit, data_frequency = get_frequency( freq, candle_size, unit, data_frequency = get_frequency(
frequency, data_frequency frequency, data_frequency, supported_freqs=['T', 'D', 'H']
) )
# The get_history method supports multiple asset # The get_history method supports multiple asset
candles = self.get_candles( candles = self.get_candles(
@@ -513,31 +515,37 @@ class Exchange:
series = dict() series = dict()
for asset in candles: for asset in candles:
first_candle = candles[asset][0] if candles[asset]:
asset_series = self.get_series_from_candles( first_candle = candles[asset][0]
candles=candles[asset], asset_series = self.get_series_from_candles(
start_dt=first_candle['last_traded'], candles=candles[asset],
end_dt=end_dt, start_dt=first_candle['last_traded'],
data_frequency=frequency, end_dt=end_dt,
field=field, data_frequency=frequency,
) field=field,
# Checking to make sure that the dates match
delta = get_delta(candle_size, data_frequency)
adj_end_dt = end_dt - delta
last_traded = asset_series.index[-1]
if last_traded < adj_end_dt:
raise LastCandleTooEarlyError(
last_traded=last_traded,
end_dt=adj_end_dt,
exchange=self.name,
) )
delta_candle_size = candle_size * 60 if unit == 'H' else candle_size
# Checking to make sure that the dates match
delta = get_delta(delta_candle_size, data_frequency)
adj_end_dt = end_dt - delta
last_traded = asset_series.index[-1]
if last_traded < adj_end_dt:
raise LastCandleTooEarlyError(
last_traded=last_traded,
end_dt=adj_end_dt,
exchange=self.name,
)
else: # empty candle received
# because other assets are tz-aware, we need its tz to be set as well
asset_series = pd.Series([], index=pd.DatetimeIndex([], tz=pytz.utc))
series[asset] = asset_series series[asset] = asset_series
df = pd.DataFrame(series) df = pd.DataFrame(series)
df.dropna(inplace=True) #df.dropna(inplace=True) # commented out due to issue 236
return df return df
@@ -663,7 +671,8 @@ class Exchange:
else: else:
return free, False return free, False
def sync_positions(self, positions, cash=None, check_balances=False): def sync_positions(self, positions, cash=None,
check_balances=False):
""" """
Update the portfolio cash and position balances based on the Update the portfolio cash and position balances based on the
latest ticker prices. latest ticker prices.
@@ -701,8 +710,8 @@ class Exchange:
) )
positions_value = 0.0 positions_value = 0.0
if positions is not None: if positions:
assets = set([position.asset for position in positions]) assets = list(set([position.asset for position in positions]))
tickers = self.tickers(assets) tickers = self.tickers(assets)
for position in positions: for position in positions:
@@ -919,7 +928,8 @@ class Exchange:
""" """
@abstractmethod @abstractmethod
def cancel_order(self, order_param, symbol_or_asset=None): def cancel_order(self, order_param,
symbol_or_asset=None, params={}):
"""Cancel an open order. """Cancel an open order.
Parameters Parameters
@@ -928,6 +938,7 @@ class Exchange:
The order_id or order object to cancel. The order_id or order object to cancel.
symbol_or_asset: str|TradingPair symbol_or_asset: str|TradingPair
The catalyst symbol, some exchanges need this The catalyst symbol, some exchanges need this
params:
""" """
pass pass
@@ -972,13 +983,15 @@ class Exchange:
pass pass
@abc.abstractmethod @abc.abstractmethod
def tickers(self, assets): def tickers(self, assets, on_ticker_error='raise'):
""" """
Retrieve current tick data for the given assets Retrieve current tick data for the given assets
Parameters Parameters
---------- ----------
assets: list[TradingPair] assets: list[TradingPair]
on_ticker_error: str [raise|warn]
How to handle an error when retrieving a single ticker.
Returns Returns
------- -------
+156 -43
View File
@@ -16,7 +16,7 @@ import signal
import sys import sys
from datetime import timedelta from datetime import timedelta
from os import listdir from os import listdir
from os.path import isfile, join from os.path import isfile, join, exists
import catalyst.protocol as zp import catalyst.protocol as zp
import logbook import logbook
@@ -36,13 +36,16 @@ from catalyst.exchange.utils.exchange_utils import (
get_algo_folder, get_algo_folder,
get_algo_df, get_algo_df,
save_algo_df, save_algo_df,
clear_frame_stats_directory,
remove_old_files,
group_assets_by_exchange, ) group_assets_by_exchange, )
from catalyst.exchange.utils.stats_utils import get_pretty_stats, stats_to_s3, \ from catalyst.exchange.utils.stats_utils import \
stats_to_algo_folder get_pretty_stats, stats_to_s3, stats_to_algo_folder
from catalyst.finance.execution import MarketOrder from catalyst.finance.execution import MarketOrder
from catalyst.finance.performance import PerformanceTracker from catalyst.finance.performance import PerformanceTracker
from catalyst.finance.performance.period import calc_period_stats from catalyst.finance.performance.period import calc_period_stats
from catalyst.gens.tradesimulation import AlgorithmSimulator from catalyst.gens.tradesimulation import AlgorithmSimulator
from catalyst.marketplace.marketplace import Marketplace
from catalyst.utils.api_support import api_method from catalyst.utils.api_support import api_method
from catalyst.utils.input_validation import error_keywords, ensure_upper_case from catalyst.utils.input_validation import error_keywords, ensure_upper_case
from catalyst.utils.math_utils import round_nearest from catalyst.utils.math_utils import round_nearest
@@ -66,8 +69,8 @@ class ExchangeTradingAlgorithmBase(TradingAlgorithm):
self.current_day = None self.current_day = None
if self.simulate_orders is None \ if self.simulate_orders is None and \
and self.sim_params.arena == 'backtest': self.sim_params.arena == 'backtest':
self.simulate_orders = True self.simulate_orders = True
# Operations with retry features # Operations with retry features
@@ -92,6 +95,8 @@ class ExchangeTradingAlgorithmBase(TradingAlgorithm):
attempts=self.attempts, attempts=self.attempts,
) )
self._marketplace = None
@staticmethod @staticmethod
def __convert_order_params_for_blotter(limit_price, stop_price, style): def __convert_order_params_for_blotter(limit_price, stop_price, style):
""" """
@@ -167,6 +172,15 @@ class ExchangeTradingAlgorithmBase(TradingAlgorithm):
""" """
return round_nearest(amount, asset.min_trade_size) return round_nearest(amount, asset.min_trade_size)
@api_method
def get_dataset(self, data_source_name, start=None, end=None):
if self._marketplace is None:
self._marketplace = Marketplace()
return self._marketplace.get_dataset(
data_source_name, start, end,
)
@api_method @api_method
@preprocess(symbol_str=ensure_upper_case) @preprocess(symbol_str=ensure_upper_case)
def symbol(self, symbol_str, exchange_name=None): def symbol(self, symbol_str, exchange_name=None):
@@ -356,19 +370,35 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
self._clock = None self._clock = None
self.frame_stats = list() self.frame_stats = list()
self.pnl_stats = get_algo_df(self.algo_namespace, 'pnl_stats') # erase the frame_stats folder to avoid overloading the disk
error = clear_frame_stats_directory(self.algo_namespace)
if error:
log.warning(error)
self.custom_signals_stats = \ # in order to save paper & live files separately
get_algo_df(self.algo_namespace, 'custom_signals_stats') self.mode_name = 'paper' if kwargs['simulate_orders'] else 'live'
self.exposure_stats = \ self.pnl_stats = get_algo_df(
get_algo_df(self.algo_namespace, 'exposure_stats') self.algo_namespace,
'pnl_stats_{}'.format(self.mode_name),
)
self.custom_signals_stats = get_algo_df(
self.algo_namespace,
'custom_signals_stats_{}'.format(self.mode_name)
)
self.exposure_stats = get_algo_df(
self.algo_namespace,
'exposure_stats_{}'.format(self.mode_name)
)
self.is_running = True self.is_running = True
self.stats_minutes = 1 self.stats_minutes = 1
self._last_orders = [] self._last_orders = []
self._last_open_orders = []
self.trading_client = None self.trading_client = None
super(ExchangeTradingAlgorithmLive, self).__init__(*args, **kwargs) super(ExchangeTradingAlgorithmLive, self).__init__(*args, **kwargs)
@@ -379,9 +409,20 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
log.warn("Can't initialize signal handler inside another thread." log.warn("Can't initialize signal handler inside another thread."
"Exit should be handled by the user.") "Exit should be handled by the user.")
log.info('initialized trading algorithm in live mode')
def interrupt_algorithm(self): def interrupt_algorithm(self):
"""
when algorithm comes to an end this function is called.
extracts the stats and calls analyze.
after finishing, it exits the run.
Parameters
----------
Returns
-------
"""
self.is_running = False self.is_running = False
if self._analyze is None: if self._analyze is None:
@@ -391,21 +432,31 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
log.info('Exiting the algorithm. Calling `analyze()` ' log.info('Exiting the algorithm. Calling `analyze()` '
'before exiting the algorithm.') 'before exiting the algorithm.')
# add the last day stats which is not saved in the directory
current_stats = pd.DataFrame(self.frame_stats)
current_stats.set_index('period_close', drop=False, inplace=True)
# get the location of the directory
algo_folder = get_algo_folder(self.algo_namespace) algo_folder = get_algo_folder(self.algo_namespace)
folder = join(algo_folder, 'daily_performance') folder = join(algo_folder, 'frame_stats')
files = [f for f in listdir(folder) if isfile(join(folder, f))]
daily_perf_list = [] if exists(folder):
for item in files: files = [f for f in listdir(folder) if isfile(join(folder, f))]
filename = join(folder, item)
with open(filename, 'rb') as handle: period_stats_list = []
perf_period = pickle.load(handle) for item in files:
perf_period_dict = perf_period.to_dict() filename = join(folder, item)
daily_perf_list.append(perf_period_dict)
stats = pd.DataFrame(daily_perf_list) with open(filename, 'rb') as handle:
stats.set_index('period_close', drop=False, inplace=True) perf_period = pickle.load(handle)
period_stats_list.extend(perf_period)
stats = pd.DataFrame(period_stats_list)
stats.set_index('period_close', drop=False, inplace=True)
stats = pd.concat([stats, current_stats])
else:
stats = current_stats
self.analyze(stats) self.analyze(stats)
@@ -474,7 +525,7 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
""" """
self.state = get_algo_object( self.state = get_algo_object(
algo_name=self.algo_namespace, algo_name=self.algo_namespace,
key='context.state', key='context.state_{}'.format(self.mode_name),
) )
if self.state is None: if self.state is None:
self.state = {} self.state = {}
@@ -497,7 +548,7 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
# Unpacking the perf_tracker and positions if available # Unpacking the perf_tracker and positions if available
cum_perf = get_algo_object( cum_perf = get_algo_object(
algo_name=self.algo_namespace, algo_name=self.algo_namespace,
key='cumulative_performance', key='cumulative_performance_{}'.format(self.mode_name),
) )
if cum_perf is not None: if cum_perf is not None:
tracker.cumulative_performance = cum_perf tracker.cumulative_performance = cum_perf
@@ -508,7 +559,7 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
todays_perf = get_algo_object( todays_perf = get_algo_object(
algo_name=self.algo_namespace, algo_name=self.algo_namespace,
key=today.strftime('%Y-%m-%d'), key=today.strftime('%Y-%m-%d'),
rel_path='daily_performance', rel_path='daily_performance_{}'.format(self.mode_name),
) )
if todays_perf is not None: if todays_perf is not None:
# Ensure single common position tracker # Ensure single common position tracker
@@ -591,8 +642,6 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
if base_currency is None: if base_currency is None:
base_currency = exchange.base_currency base_currency = exchange.base_currency
# Don't check the cash if there are open orders. This could
# results in false positives.
orders = [] orders = []
for asset in self.blotter.open_orders: for asset in self.blotter.open_orders:
asset_orders = self.blotter.open_orders[asset] asset_orders = self.blotter.open_orders[asset]
@@ -647,7 +696,11 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
) )
self.pnl_stats = pd.concat([self.pnl_stats, df]) self.pnl_stats = pd.concat([self.pnl_stats, df])
save_algo_df(self.algo_namespace, 'pnl_stats', self.pnl_stats) save_algo_df(
self.algo_namespace,
'pnl_stats_{}'.format(self.mode_name),
self.pnl_stats,
)
def add_custom_signals_stats(self, period_stats): def add_custom_signals_stats(self, period_stats):
""" """
@@ -668,8 +721,11 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
) )
self.custom_signals_stats = pd.concat([self.custom_signals_stats, df]) self.custom_signals_stats = pd.concat([self.custom_signals_stats, df])
save_algo_df(self.algo_namespace, 'custom_signals_stats', save_algo_df(
self.custom_signals_stats) self.algo_namespace,
'custom_signals_stats_{}'.format(self.mode_name),
self.custom_signals_stats,
)
def add_exposure_stats(self, period_stats): def add_exposure_stats(self, period_stats):
""" """
@@ -696,9 +752,43 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
self.exposure_stats = pd.concat([self.exposure_stats, df]) self.exposure_stats = pd.concat([self.exposure_stats, df])
save_algo_df( save_algo_df(
self.algo_namespace, 'exposure_stats', self.exposure_stats self.algo_namespace,
'exposure_stats_{}'.format(self.mode_name),
self.exposure_stats
) )
def nullify_frame_stats(self, now):
"""
Save all period_stats to local directory
erase old files from the folder and nullify
self.frame_stats
Parameters
----------
now: Timestamp
Returns
-------
"""
save_algo_object(
algo_name=self.algo_namespace,
key=now.floor('1D').strftime('%Y-%m-%d'),
obj=self.frame_stats,
rel_path='frame_stats'
)
error = remove_old_files(
algo_name=self.algo_namespace,
today=now,
rel_path='frame_stats'
)
if error:
log.warning(error)
self.frame_stats = list()
def handle_data(self, data): def handle_data(self, data):
""" """
Wrapper around the handle_data method of each algo. Wrapper around the handle_data method of each algo.
@@ -718,15 +808,20 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
# Resetting the frame stats every day to minimize memory footprint # Resetting the frame stats every day to minimize memory footprint
today = data.current_dt.floor('1D') today = data.current_dt.floor('1D')
if self.current_day is not None and today > self.current_day: if self.current_day is not None and today > self.current_day:
self.frame_stats = list() self.nullify_frame_stats(now=data.current_dt)
self.performance_needs_update = False self.performance_needs_update = False
orders = list(self.perf_tracker.todays_performance.orders_by_id.keys()) last_orders_list = list(self.blotter.orders.keys())
if orders != self._last_orders: open_orders_list = list(self.blotter.open_orders.keys())
if last_orders_list != self._last_orders or \
open_orders_list != self._last_open_orders:
self.performance_needs_update = True self.performance_needs_update = True
# Saving current orders to detect changes in the next frame # Saving current order positions
self._last_orders = copy.deepcopy(orders) # to detect changes in the next frame
self._last_orders = copy.deepcopy(last_orders_list)
self._last_open_orders = copy.deepcopy(open_orders_list)
if self.performance_needs_update: if self.performance_needs_update:
self.perf_tracker.update_performance() self.perf_tracker.update_performance()
@@ -768,7 +863,7 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
log.debug('saving cumulative performance object') log.debug('saving cumulative performance object')
save_algo_object( save_algo_object(
algo_name=self.algo_namespace, algo_name=self.algo_namespace,
key='cumulative_performance', key='cumulative_performance_{}'.format(self.mode_name),
obj=self.perf_tracker.cumulative_performance, obj=self.perf_tracker.cumulative_performance,
) )
log.debug('saving todays performance object') log.debug('saving todays performance object')
@@ -776,12 +871,12 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
algo_name=self.algo_namespace, algo_name=self.algo_namespace,
key=today.strftime('%Y-%m-%d'), key=today.strftime('%Y-%m-%d'),
obj=self.perf_tracker.todays_performance, obj=self.perf_tracker.todays_performance,
rel_path='daily_performance' rel_path='daily_performance_{}'.format(self.mode_name)
) )
log.debug('saving context.state object') log.debug('saving context.state object')
save_algo_object( save_algo_object(
algo_name=self.algo_namespace, algo_name=self.algo_namespace,
key='context.state', key='context.state_{}'.format(self.mode_name),
obj=self.state) obj=self.state)
def _process_stats(self, data): def _process_stats(self, data):
@@ -798,6 +893,8 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
# Saving the last hour in memory # Saving the last hour in memory
self.frame_stats.append(frame_stats) self.frame_stats.append(frame_stats)
# creating and saving the pnl_stats into the local
# directory
self.add_pnl_stats(frame_stats) self.add_pnl_stats(frame_stats)
if self.recorded_vars: if self.recorded_vars:
self.add_custom_signals_stats(frame_stats) self.add_custom_signals_stats(frame_stats)
@@ -835,6 +932,7 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
csv_bytes = stats_to_algo_folder( csv_bytes = stats_to_algo_folder(
stats=self.frame_stats, stats=self.frame_stats,
algo_namespace=self.algo_namespace, algo_namespace=self.algo_namespace,
folder_name='stats_{}'.format(self.mode_name),
recorded_cols=recorded_cols, recorded_cols=recorded_cols,
) )
except Exception as e: except Exception as e:
@@ -862,6 +960,13 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
raise NotImplementedError() raise NotImplementedError()
def _get_open_orders(self, asset=None): def _get_open_orders(self, asset=None):
if self.simulate_orders:
raise ValueError(
'The get_open_orders() method only works in live mode. '
'The purpose is to list open orders on the exchange '
'regardless who placed them. To list the open orders of '
'this algo, use `context.blotter.open_orders`.'
)
if asset: if asset:
exchange = self.exchanges[asset.exchange] exchange = self.exchanges[asset.exchange]
return exchange.get_open_orders(asset) return exchange.get_open_orders(asset)
@@ -895,13 +1000,15 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
If an asset is passed then this will return a list of the open If an asset is passed then this will return a list of the open
orders for this asset. orders for this asset.
""" """
# TODO: should this be a shortcut to the open orders in the blotter?
return retry( return retry(
action=self._get_open_orders, action=self._get_open_orders,
attempts=self.attempts['get_open_orders_attempts'], attempts=self.attempts['get_open_orders_attempts'],
sleeptime=self.attempts['retry_sleeptime'], sleeptime=self.attempts['retry_sleeptime'],
retry_exceptions=(ExchangeRequestError,), retry_exceptions=(ExchangeRequestError,),
cleanup=lambda: log.warn('Fetching open orders again.'), cleanup=lambda: log.warn('Fetching open orders again.'),
args=(asset,)) args=(asset,)
)
@api_method @api_method
def get_order(self, order_id, exchange_name): def get_order(self, order_id, exchange_name):
@@ -930,13 +1037,19 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
args=(order_id,)) args=(order_id,))
@api_method @api_method
def cancel_order(self, order_param, exchange_name): def cancel_order(self, order_param, exchange_name,
symbol=None, params={}):
"""Cancel an open order. """Cancel an open order.
Parameters Parameters
---------- ----------
order_param : str or Order order_param : str or Order
The order_id or order object to cancel. The order_id or order object to cancel.
exchange_name: name of exchange from
which you want to cancel the order
symbol:
params:
""" """
exchange = self.exchanges[exchange_name] exchange = self.exchanges[exchange_name]
@@ -950,4 +1063,4 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
sleeptime=self.attempts['retry_sleeptime'], sleeptime=self.attempts['retry_sleeptime'],
retry_exceptions=(ExchangeRequestError,), retry_exceptions=(ExchangeRequestError,),
cleanup=lambda: log.warn('cancelling order again.'), cleanup=lambda: log.warn('cancelling order again.'),
args=(order_id,)) args=(order_id, symbol, params))
+7 -4
View File
@@ -68,7 +68,7 @@ class TradingPairFeeSchedule(CommissionModel):
multiplier = maker \ multiplier = maker \
if ((order.amount > 0 and order.limit < transaction.price) if ((order.amount > 0 and order.limit < transaction.price)
or (order.amount < 0 and order.limit > transaction.price)) \ or (order.amount < 0 and order.limit > transaction.price)) \
and order.limit_reached else taker and order.limit_reached else taker
fee = cost * multiplier fee = cost * multiplier
return fee return fee
@@ -214,7 +214,7 @@ class ExchangeBlotter(Blotter):
# that this is safer until we have a robust way to track # that this is safer until we have a robust way to track
# the trades already processed by the algo. We can't loose # the trades already processed by the algo. We can't loose
# them if the algo shuts down. # them if the algo shuts down.
if transactions and order.open_amount == 0: if transactions and order.status == ORDER_STATUS.FILLED:
avg_price = np.average( avg_price = np.average(
a=[t.price for t in transactions], a=[t.price for t in transactions],
weights=[t.amount for t in transactions], weights=[t.amount for t in transactions],
@@ -238,9 +238,12 @@ class ExchangeBlotter(Blotter):
else: else:
delta = pd.Timestamp.utcnow() - order.dt delta = pd.Timestamp.utcnow() - order.dt
log.info( log.info(
'order {order_id} still open after {delta}'.format( '{exchange} order {order_id} for {symbol} still open '
'after {delta}'.format(
exchange=exchange.name,
order_id=order.id, order_id=order.id,
delta=delta delta=delta,
symbol=order.asset.symbol,
) )
) )
+17 -25
View File
@@ -458,7 +458,7 @@ class ExchangeBundle:
last_entry = None last_entry = None
if start is None or \ if start is None or \
(earliest_trade is not None and earliest_trade > start): (earliest_trade is not None and earliest_trade > start):
start = earliest_trade start = earliest_trade
if last_entry is not None and (end is None or end > last_entry): if last_entry is not None and (end is None or end > last_entry):
@@ -600,14 +600,14 @@ class ExchangeBundle:
if show_breakdown: if show_breakdown:
for asset in chunks: for asset in chunks:
with maybe_show_progress( with maybe_show_progress(
chunks[asset], chunks[asset],
show_progress, show_progress,
label='Ingesting {frequency} price data for ' label='Ingesting {frequency} price data for '
'{symbol} on {exchange}'.format( '{symbol} on {exchange}'.format(
exchange=self.exchange_name, exchange=self.exchange_name,
frequency=data_frequency, frequency=data_frequency,
symbol=asset.symbol symbol=asset.symbol
)) as it: )) as it:
for chunk in it: for chunk in it:
problems += self.ingest_ctable( problems += self.ingest_ctable(
asset=chunk['asset'], asset=chunk['asset'],
@@ -625,13 +625,13 @@ class ExchangeBundle:
key=lambda chunk: pd.to_datetime(chunk['period']) key=lambda chunk: pd.to_datetime(chunk['period'])
) )
with maybe_show_progress( with maybe_show_progress(
all_chunks, all_chunks,
show_progress, show_progress,
label='Ingesting {frequency} price data on ' label='Ingesting {frequency} price data on '
'{exchange}'.format( '{exchange}'.format(
exchange=self.exchange_name, exchange=self.exchange_name,
frequency=data_frequency, frequency=data_frequency,
)) as it: )) as it:
for chunk in it: for chunk in it:
problems += self.ingest_ctable( problems += self.ingest_ctable(
asset=chunk['asset'], asset=chunk['asset'],
@@ -830,7 +830,6 @@ class ExchangeBundle:
field, field,
data_frequency, data_frequency,
algo_end_dt=None, algo_end_dt=None,
trailing_bar_count=None,
force_auto_ingest=False force_auto_ingest=False
): ):
""" """
@@ -844,6 +843,7 @@ class ExchangeBundle:
field: str field: str
data_frequency: str data_frequency: str
algo_end_dt: pd.Timestamp algo_end_dt: pd.Timestamp
force_auto_ingest:
Returns Returns
------- -------
@@ -858,7 +858,6 @@ class ExchangeBundle:
bar_count=bar_count, bar_count=bar_count,
field=field, field=field,
data_frequency=data_frequency, data_frequency=data_frequency,
trailing_bar_count=trailing_bar_count,
) )
return pd.DataFrame(series) return pd.DataFrame(series)
@@ -887,7 +886,6 @@ class ExchangeBundle:
field=field, field=field,
data_frequency=data_frequency, data_frequency=data_frequency,
reset_reader=True, reset_reader=True,
trailing_bar_count=trailing_bar_count,
) )
return series return series
@@ -898,7 +896,6 @@ class ExchangeBundle:
bar_count=bar_count, bar_count=bar_count,
field=field, field=field,
data_frequency=data_frequency, data_frequency=data_frequency,
trailing_bar_count=trailing_bar_count,
) )
return pd.DataFrame(series) return pd.DataFrame(series)
@@ -962,12 +959,7 @@ class ExchangeBundle:
bar_count, bar_count,
field, field,
data_frequency, data_frequency,
trailing_bar_count=None,
reset_reader=False): reset_reader=False):
if trailing_bar_count:
delta = get_delta(trailing_bar_count, data_frequency)
end_dt += delta
start_dt = get_start_dt(end_dt, bar_count, data_frequency, False) start_dt = get_start_dt(end_dt, bar_count, data_frequency, False)
start_dt, _ = self.get_adj_dates( start_dt, _ = self.get_adj_dates(
start_dt, end_dt, assets, data_frequency start_dt, end_dt, assets, data_frequency
+5 -5
View File
@@ -9,8 +9,9 @@ from catalyst.exchange.exchange_bundle import ExchangeBundle
from catalyst.exchange.exchange_errors import ( from catalyst.exchange.exchange_errors import (
ExchangeRequestError, ExchangeRequestError,
PricingDataNotLoadedError) PricingDataNotLoadedError)
from catalyst.exchange.utils.exchange_utils import resample_history_df, group_assets_by_exchange from catalyst.exchange.utils.exchange_utils import resample_history_df, \
from catalyst.exchange.utils.datetime_utils import get_frequency group_assets_by_exchange
from catalyst.exchange.utils.datetime_utils import get_frequency, get_start_dt
from logbook import Logger from logbook import Logger
from redo import retry from redo import retry
@@ -298,7 +299,6 @@ class DataPortalExchangeBacktest(DataPortalExchangeBase):
frequency, data_frequency frequency, data_frequency
) )
adj_bar_count = candle_size * bar_count adj_bar_count = candle_size * bar_count
trailing_bar_count = candle_size - 1
if data_frequency == 'minute' and adj_data_frequency == 'daily': if data_frequency == 'minute' and adj_data_frequency == 'daily':
end_dt = end_dt.floor('1D') end_dt = end_dt.floor('1D')
@@ -310,10 +310,10 @@ class DataPortalExchangeBacktest(DataPortalExchangeBase):
field=field, field=field,
data_frequency=adj_data_frequency, data_frequency=adj_data_frequency,
algo_end_dt=self._last_available_session, algo_end_dt=self._last_available_session,
trailing_bar_count=trailing_bar_count,
) )
df = resample_history_df(pd.DataFrame(series), freq, field) start_dt = get_start_dt(end_dt, adj_bar_count, data_frequency)
df = resample_history_df(pd.DataFrame(series), freq, field, start_dt)
return df return df
def get_exchange_spot_value(self, def get_exchange_spot_value(self,
+11 -10
View File
@@ -92,7 +92,7 @@ def get_periods_range(freq, start_dt=None, end_dt=None, periods=None):
adj_periods = periods * unit_periods adj_periods = periods * unit_periods
# TODO: standardize time aliases to avoid any mapping # TODO: standardize time aliases to avoid any mapping
unit = 'd' if unit == 'D' else 'm' unit = 'd' if unit == 'D' else 'h' if unit == 'H' else 'm'
delta = pd.Timedelta(adj_periods, unit) delta = pd.Timedelta(adj_periods, unit)
if start_dt is not None: if start_dt is not None:
@@ -248,7 +248,7 @@ def get_year_start_end(dt, first_day=None, last_day=None):
return year_start, year_end return year_start, year_end
def get_frequency(freq, data_frequency=None): def get_frequency(freq, data_frequency=None, supported_freqs=['D', 'T']):
""" """
Get the frequency parameters. Get the frequency parameters.
@@ -302,17 +302,18 @@ def get_frequency(freq, data_frequency=None):
elif unit.lower() == 'm' or unit == 'T': elif unit.lower() == 'm' or unit == 'T':
unit = 'T' unit = 'T'
alias = '{}T'.format(candle_size) alias = '{}T'.format(candle_size)
data_frequency = 'minute'
if data_frequency == 'daily': elif unit.lower() == 'h':
if 'H' in supported_freqs:
unit = 'H'
alias = '{}H'.format(candle_size)
else:
candle_size = candle_size * 60
alias = '{}T'.format(candle_size)
data_frequency = 'minute' data_frequency = 'minute'
# elif unit.lower() == 'h':
# candle_size = candle_size * 60
#
# alias = '{}T'.format(candle_size)
# if data_frequency == 'daily':
# data_frequency = 'minute'
else: else:
raise InvalidHistoryFrequencyAlias(freq=freq) raise InvalidHistoryFrequencyAlias(freq=freq)
+111 -21
View File
@@ -126,11 +126,11 @@ def get_exchange_symbols(exchange_name, is_local=False, environ=None):
filename = get_exchange_symbols_filename(exchange_name, is_local) filename = get_exchange_symbols_filename(exchange_name, is_local)
if not is_local and (not os.path.isfile(filename) or pd.Timedelta( if not is_local and (not os.path.isfile(filename) or pd.Timedelta(
pd.Timestamp('now', tz='UTC') - last_modified_time( pd.Timestamp('now', tz='UTC') - last_modified_time(
filename)).days > 1): filename)).days > 1):
try: try:
download_exchange_symbols(exchange_name, environ) download_exchange_symbols(exchange_name, environ)
except Exception as e: except Exception:
pass pass
if os.path.isfile(filename): if os.path.isfile(filename):
@@ -273,6 +273,7 @@ def get_algo_object(algo_name, key, environ=None, rel_path=None, how='pickle'):
key: str key: str
environ: environ:
rel_path: str rel_path: str
how: str
Returns Returns
------- -------
@@ -316,6 +317,7 @@ def save_algo_object(algo_name, key, obj, environ=None, rel_path=None,
obj: Object obj: Object
environ: environ:
rel_path: str rel_path: str
how: str
""" """
folder = get_algo_folder(algo_name, environ) folder = get_algo_folder(algo_name, environ)
@@ -392,6 +394,71 @@ def save_algo_df(algo_name, key, df, environ=None, rel_path=None):
df.to_csv(handle, encoding='UTF_8') df.to_csv(handle, encoding='UTF_8')
def clear_frame_stats_directory(algo_name):
"""
remove the outdated directory
to avoid overloading the disk
Parameters
----------
algo_name: str
Returns
-------
error: str
"""
error = None
algo_folder = get_algo_folder(algo_name)
folder = os.path.join(algo_folder, 'frame_stats')
if os.path.exists(folder):
try:
shutil.rmtree(folder)
except OSError:
error = 'unable to remove {}, the analyze ' \
'data will be inconsistent'.format(folder)
return error
def remove_old_files(algo_name, today, rel_path, environ=None):
"""
remove old files from a directory
to avoid overloading the disk
Parameters
----------
algo_name: str
today: Timestamp
rel_path: str
environ:
Returns
-------
error: str
"""
error = None
algo_folder = get_algo_folder(algo_name, environ)
folder = os.path.join(algo_folder, rel_path)
ensure_directory(folder)
# run on all files in the folder
for f in os.listdir(folder):
try:
file_path = os.path.join(folder, f)
creation_unix = os.path.getctime(file_path)
creation_time = pd.to_datetime(creation_unix, unit='s', utc=True)
# if the file is older than 30 days erase it
if today - pd.DateOffset(30) > creation_time:
os.unlink(file_path)
except OSError:
error = 'unable to erase files in {}'.format(folder)
return error
def get_exchange_minute_writer_root(exchange_name, environ=None): def get_exchange_minute_writer_root(exchange_name, environ=None):
""" """
The minute writer folder for the exchange. The minute writer folder for the exchange.
@@ -512,7 +579,7 @@ def get_common_assets(exchanges):
return assets return assets
def resample_history_df(df, freq, field): def resample_history_df(df, freq, field, start_dt=None):
""" """
Resample the OHCLV DataFrame using the specified frequency. Resample the OHCLV DataFrame using the specified frequency.
@@ -540,7 +607,16 @@ def resample_history_df(df, freq, field):
else: else:
raise ValueError('Invalid field.') raise ValueError('Invalid field.')
resampled_df = df.resample(freq).agg(agg) resampled_df = df.resample(
freq, closed='left', label='left'
).agg(agg) # type: pd.DataFrame
# Because the samples are closed left, we get one more candle at
# the beginning then the requested number for bars. Removing this
# candle to avoid confusion.
if start_dt and not resampled_df.empty:
resampled_df = resampled_df[resampled_df.index >= start_dt]
return resampled_df return resampled_df
@@ -566,8 +642,9 @@ def mixin_market_params(exchange_name, params, market):
params['maker'] = 0.001 params['maker'] = 0.001
params['taker'] = 0.002 params['taker'] = 0.002
elif 'maker' in market and 'taker' in market \ elif 'maker' in market and 'taker' in market and \
and market['maker'] is not None and market['taker'] is not None: market['maker'] is not None and market['taker'] is not None:
params['maker'] = market['maker'] params['maker'] = market['maker']
params['taker'] = market['taker'] params['taker'] = market['taker']
@@ -639,23 +716,36 @@ def save_asset_data(folder, df, decimals=8):
) )
def get_candles_df(candles, field, freq, bar_count, end_dt, def forward_fill_df_if_needed(df, periods):
previous_value=None): df = df.reindex(periods)
# volume should always be 0 (if there were no trades in this interval)
df['volume'] = df['volume'].fillna(0.0)
# ie pull the last close into this close
df['close'] = df.fillna(method='pad')
# now copy the close that was pulled down from the last timestep
# into this row, across into o/h/l
df['open'] = df['open'].fillna(df['close'])
df['low'] = df['low'].fillna(df['close'])
df['high'] = df['high'].fillna(df['close'])
return df
def transform_candles_to_df(candles):
return pd.DataFrame(candles).set_index('last_traded')
def get_candles_df(candles, field, freq, bar_count, end_dt=None):
all_series = dict() all_series = dict()
for asset in candles: for asset in candles:
periods = pd.date_range(end=end_dt, periods=bar_count, freq=freq) asset_df = transform_candles_to_df(candles[asset])
rounded_end_dt = end_dt.floor(freq)
periods = pd.date_range(end=rounded_end_dt,
periods=bar_count,
freq=freq)
asset_df = forward_fill_df_if_needed(asset_df, periods)
dates = [candle['last_traded'] for candle in candles[asset]] all_series[asset] = pd.Series(asset_df[field])
values = [candle[field] for candle in candles[asset]]
series = pd.Series(values, index=dates)
series = series.reindex(
periods,
method='ffill',
fill_value=previous_value,
)
series.sort_index(inplace=True)
all_series[asset] = series
df = pd.DataFrame(all_series) df = pd.DataFrame(all_series)
df.dropna(inplace=True) df.dropna(inplace=True)
+2
View File
@@ -33,6 +33,8 @@ def get_exchange(exchange_name, base_currency=None, must_authenticate=False,
exchange_name=exchange_name, exchange_name=exchange_name,
key=exchange_auth['key'], key=exchange_auth['key'],
secret=exchange_auth['secret'], secret=exchange_auth['secret'],
password=exchange_auth['password'] if 'password'
in exchange_auth.keys() else '',
base_currency=base_currency, base_currency=base_currency,
) )
exchange_cache[key] = exchange exchange_cache[key] = exchange
+12 -12
View File
@@ -44,7 +44,7 @@ def crossover(source, target):
""" """
if isinstance(target, numbers.Number): if isinstance(target, numbers.Number):
if source[-1] is np.nan or source[-2] is np.nan \ if source[-1] is np.nan or source[-2] is np.nan \
or target is np.nan: or target is np.nan:
return False return False
if source[-1] >= target > source[-2]: if source[-1] >= target > source[-2]:
@@ -54,7 +54,7 @@ def crossover(source, target):
else: else:
if source[-1] is np.nan or source[-2] is np.nan \ if source[-1] is np.nan or source[-2] is np.nan \
or target[-1] is np.nan or target[-2] is np.nan: or target[-1] is np.nan or target[-2] is np.nan:
return False return False
if source[-1] > target[-1] and source[-2] < target[-2]: if source[-1] > target[-1] and source[-2] < target[-2]:
@@ -81,7 +81,7 @@ def crossunder(source, target):
""" """
if isinstance(target, numbers.Number): if isinstance(target, numbers.Number):
if source[-1] is np.nan or source[-2] is np.nan \ if source[-1] is np.nan or source[-2] is np.nan \
or target is np.nan: or target is np.nan:
return False return False
if source[-1] < target <= source[-2]: if source[-1] < target <= source[-2]:
@@ -90,7 +90,7 @@ def crossunder(source, target):
return False return False
else: else:
if source[-1] is np.nan or source[-2] is np.nan \ if source[-1] is np.nan or source[-2] is np.nan \
or target[-1] is np.nan or target[-2] is np.nan: or target[-1] is np.nan or target[-2] is np.nan:
return False return False
if source[-1] < target[-1] and source[-2] >= target[-2]: if source[-1] < target[-1] and source[-2] >= target[-2]:
@@ -229,7 +229,10 @@ def prepare_stats(stats, recorded_cols=list()):
asset_values) asset_values)
df = pd.DataFrame(stats) df = pd.DataFrame(stats)
df['orders'] = df['orders'].apply(lambda orders: len(orders))
df['transactions'] = df['transactions'].apply(
lambda transactions: len(transactions)
)
index_cols = [ index_cols = [
'period_close', 'starting_cash', 'ending_cash', 'portfolio_value', 'period_close', 'starting_cash', 'ending_cash', 'portfolio_value',
'pnl', 'long_exposure', 'short_exposure', 'orders', 'transactions', 'pnl', 'long_exposure', 'short_exposure', 'orders', 'transactions',
@@ -241,11 +244,6 @@ def prepare_stats(stats, recorded_cols=list()):
for column in recorded_cols: for column in recorded_cols:
index_cols.append(column) index_cols.append(column)
df['orders'] = df['orders'].apply(lambda orders: len(orders))
df['transactions'] = df['transactions'].apply(
lambda transactions: len(transactions)
)
if asset_cols: if asset_cols:
columns = asset_cols columns = asset_cols
df.set_index(index_cols, drop=True, inplace=True) df.set_index(index_cols, drop=True, inplace=True)
@@ -398,7 +396,8 @@ def email_error(algo_name, dt, e, environ=None):
)}) )})
def stats_to_algo_folder(stats, algo_namespace, recorded_cols=None): def stats_to_algo_folder(stats, algo_namespace,
folder_name, recorded_cols=None):
""" """
Saves the performance stats to the algo local folder. Saves the performance stats to the algo local folder.
@@ -406,6 +405,7 @@ def stats_to_algo_folder(stats, algo_namespace, recorded_cols=None):
---------- ----------
stats: list[Object] stats: list[Object]
algo_namespace: str algo_namespace: str
folder_name: str
recorded_cols: list[str] recorded_cols: list[str]
Returns Returns
@@ -418,7 +418,7 @@ def stats_to_algo_folder(stats, algo_namespace, recorded_cols=None):
timestr = time.strftime('%Y%m%d') timestr = time.strftime('%Y%m%d')
folder = get_algo_folder(algo_namespace) folder = get_algo_folder(algo_namespace)
stats_folder = os.path.join(folder, 'stats') stats_folder = os.path.join(folder, folder_name)
ensure_directory(stats_folder) ensure_directory(stats_folder)
filename = os.path.join(stats_folder, '{}.csv'.format(timestr)) filename = os.path.join(stats_folder, '{}.csv'.format(timestr))
+4 -2
View File
@@ -29,13 +29,15 @@ from .risk import check_entry
from empyrical import ( from empyrical import (
alpha_beta_aligned, alpha_beta_aligned,
annual_volatility, annual_volatility,
cum_returns,
downside_risk, downside_risk,
information_ratio, information_ratio,
max_drawdown,
sharpe_ratio, sharpe_ratio,
sortino_ratio sortino_ratio
) )
from catalyst.patches.stats import (
max_drawdown,
cum_returns,
)
from catalyst.constants import LOG_LEVEL from catalyst.constants import LOG_LEVEL
View File
@@ -0,0 +1,302 @@
[
{
"constant": true,
"inputs": [],
"name": "name",
"outputs": [
{
"name": "",
"type": "string"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
},
{
"constant": false,
"inputs": [
{
"name": "_spender",
"type": "address"
},
{
"name": "_value",
"type": "uint256"
}
],
"name": "approve",
"outputs": [
{
"name": "",
"type": "bool"
}
],
"payable": false,
"stateMutability": "nonpayable",
"type": "function"
},
{
"constant": true,
"inputs": [],
"name": "totalSupply",
"outputs": [
{
"name": "",
"type": "uint256"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
},
{
"constant": false,
"inputs": [
{
"name": "_from",
"type": "address"
},
{
"name": "_to",
"type": "address"
},
{
"name": "_value",
"type": "uint256"
}
],
"name": "transferFrom",
"outputs": [
{
"name": "",
"type": "bool"
}
],
"payable": false,
"stateMutability": "nonpayable",
"type": "function"
},
{
"constant": true,
"inputs": [],
"name": "INITIAL_SUPPLY",
"outputs": [
{
"name": "",
"type": "uint256"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
},
{
"constant": true,
"inputs": [],
"name": "decimals",
"outputs": [
{
"name": "",
"type": "uint8"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
},
{
"constant": false,
"inputs": [
{
"name": "_spender",
"type": "address"
},
{
"name": "_subtractedValue",
"type": "uint256"
}
],
"name": "decreaseApproval",
"outputs": [
{
"name": "success",
"type": "bool"
}
],
"payable": false,
"stateMutability": "nonpayable",
"type": "function"
},
{
"constant": false,
"inputs": [],
"name": "getAfterApproveTest",
"outputs": [
{
"name": "",
"type": "uint256"
}
],
"payable": false,
"stateMutability": "nonpayable",
"type": "function"
},
{
"constant": true,
"inputs": [
{
"name": "_owner",
"type": "address"
}
],
"name": "balanceOf",
"outputs": [
{
"name": "balance",
"type": "uint256"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
},
{
"constant": true,
"inputs": [],
"name": "symbol",
"outputs": [
{
"name": "",
"type": "string"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
},
{
"constant": false,
"inputs": [
{
"name": "_to",
"type": "address"
},
{
"name": "_value",
"type": "uint256"
}
],
"name": "transfer",
"outputs": [
{
"name": "",
"type": "bool"
}
],
"payable": false,
"stateMutability": "nonpayable",
"type": "function"
},
{
"constant": false,
"inputs": [
{
"name": "_spender",
"type": "address"
},
{
"name": "_addedValue",
"type": "uint256"
}
],
"name": "increaseApproval",
"outputs": [
{
"name": "success",
"type": "bool"
}
],
"payable": false,
"stateMutability": "nonpayable",
"type": "function"
},
{
"constant": true,
"inputs": [
{
"name": "_owner",
"type": "address"
},
{
"name": "_spender",
"type": "address"
}
],
"name": "allowance",
"outputs": [
{
"name": "",
"type": "uint256"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"name": "testValue",
"type": "address"
}
],
"payable": false,
"stateMutability": "nonpayable",
"type": "constructor"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"name": "owner",
"type": "address"
},
{
"indexed": true,
"name": "spender",
"type": "address"
},
{
"indexed": false,
"name": "value",
"type": "uint256"
}
],
"name": "Approval",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"name": "from",
"type": "address"
},
{
"indexed": true,
"name": "to",
"type": "address"
},
{
"indexed": false,
"name": "value",
"type": "uint256"
}
],
"name": "Transfer",
"type": "event"
}
]
@@ -0,0 +1 @@
0x7fAec9aaE31BE428DeAAE1be8195dF609079Fd10
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
0x3985f5de8fddf2e8f7705cd360b498bf35ebfbc4
+710
View File
@@ -0,0 +1,710 @@
from __future__ import print_function
import glob
import json
import os
import re
import shutil
import sys
import time
import bcolz
import logbook
import pandas as pd
import requests
from requests_toolbelt import MultipartDecoder
from requests_toolbelt.multipart.decoder import \
NonMultipartContentTypeException
from catalyst.constants import (
LOG_LEVEL, AUTH_SERVER, ETH_REMOTE_NODE, MARKETPLACE_CONTRACT,
MARKETPLACE_CONTRACT_ABI, ENIGMA_CONTRACT, ENIGMA_CONTRACT_ABI)
from catalyst.exchange.utils.stats_utils import set_print_settings
from catalyst.marketplace.marketplace_errors import (
MarketplacePubAddressEmpty, MarketplaceDatasetNotFound,
MarketplaceNoAddressMatch, MarketplaceHTTPRequest,
MarketplaceNoCSVFiles, MarketplaceRequiresPython3)
from catalyst.marketplace.utils.auth_utils import get_key_secret, \
get_signed_headers
from catalyst.marketplace.utils.bundle_utils import merge_bundles
from catalyst.marketplace.utils.eth_utils import bin_hex, from_grains, \
to_grains
from catalyst.marketplace.utils.path_utils import get_bundle_folder, \
get_data_source_folder, get_marketplace_folder, \
get_user_pubaddr, get_temp_bundles_folder, extract_bundle
if sys.version_info.major < 3:
import urllib
else:
import urllib.request as urllib
log = logbook.Logger('Marketplace', level=LOG_LEVEL)
class Marketplace:
def __init__(self):
global Web3
try:
from web3 import Web3, HTTPProvider
except ImportError:
raise MarketplaceRequiresPython3()
self.addresses = get_user_pubaddr()
if self.addresses[0]['pubAddr'] == '':
raise MarketplacePubAddressEmpty(
filename=os.path.join(
get_marketplace_folder(), 'addresses.json')
)
self.default_account = self.addresses[0]['pubAddr']
self.web3 = Web3(HTTPProvider(ETH_REMOTE_NODE))
contract_url = urllib.urlopen(MARKETPLACE_CONTRACT)
self.mkt_contract_address = Web3.toChecksumAddress(
contract_url.readline().decode(
contract_url.info().get_content_charset()).strip())
abi_url = urllib.urlopen(MARKETPLACE_CONTRACT_ABI)
abi = json.load(abi_url)
self.mkt_contract = self.web3.eth.contract(
self.mkt_contract_address,
abi=abi,
)
contract_url = urllib.urlopen(ENIGMA_CONTRACT)
self.eng_contract_address = Web3.toChecksumAddress(
contract_url.readline().decode(
contract_url.info().get_content_charset()).strip())
abi_url = urllib.urlopen(ENIGMA_CONTRACT_ABI)
abi = json.load(abi_url)
self.eng_contract = self.web3.eth.contract(
self.eng_contract_address,
abi=abi,
)
# def get_data_sources_map(self):
# return [
# dict(
# name='Marketcap',
# desc='The marketcap value in USD.',
# start_date=pd.to_datetime('2017-01-01'),
# end_date=pd.to_datetime('2018-01-15'),
# data_frequencies=['daily'],
# ),
# dict(
# name='GitHub',
# desc='The rate of development activity on GitHub.',
# start_date=pd.to_datetime('2017-01-01'),
# end_date=pd.to_datetime('2018-01-15'),
# data_frequencies=['daily', 'hour'],
# ),
# dict(
# name='Influencers',
# desc='Tweets & related sentiments by selected influencers.',
# start_date=pd.to_datetime('2017-01-01'),
# end_date=pd.to_datetime('2018-01-15'),
# data_frequencies=['daily', 'hour', 'minute'],
# ),
# ]
def to_text(self, hex):
return Web3.toText(hex).rstrip('\0')
def choose_pubaddr(self):
if len(self.addresses) == 1:
address = self.addresses[0]['pubAddr']
address_i = 0
print('Using {} for this transaction.'.format(address))
else:
while True:
for i in range(0, len(self.addresses)):
print('{}\t{}\t{}'.format(
i,
self.addresses[i]['pubAddr'],
self.addresses[i]['desc'])
)
address_i = int(input('Choose your address associated with '
'this transaction: [default: 0] ') or 0)
if not (0 <= address_i < len(self.addresses)):
print('Please choose a number between 0 and {}\n'.format(
len(self.addresses) - 1))
else:
address = Web3.toChecksumAddress(
self.addresses[address_i]['pubAddr'])
break
return address, address_i
def sign_transaction(self, from_address, tx):
print('\nVisit https://www.myetherwallet.com/#offline-transaction and '
'enter the following parameters:\n\n'
'From Address:\t\t{_from}\n'
'\n\tClick the "Generate Information" button\n\n'
'To Address:\t\t{to}\n'
'Value / Amount to Send:\t{value}\n'
'Gas Limit:\t\t{gas}\n'
'Gas Price:\t\t[Accept the default value]\n'
'Nonce:\t\t\t{nonce}\n'
'Data:\t\t\t{data}\n'.format(
_from=from_address,
to=tx['to'],
value=tx['value'],
gas=tx['gas'],
nonce=tx['nonce'],
data=tx['data'], )
)
signed_tx = input('Copy and Paste the "Signed Transaction" '
'field here:\n')
if signed_tx.startswith('0x'):
signed_tx = signed_tx[2:]
return signed_tx
def check_transaction(self, tx_hash):
if 'ropsten' in ETH_REMOTE_NODE:
etherscan = 'https://ropsten.etherscan.io/tx/{}'.format(
tx_hash)
else:
etherscan = 'https://etherscan.io/tx/{}'.format(tx_hash)
print('\nYou can check the outcome of your transaction here:\n'
'{}\n\n'.format(etherscan))
def list(self):
data_sources = self.mkt_contract.functions.getAllProviders().call()
data = []
for index, data_source in enumerate(data_sources):
if index > 0:
if 'test' not in Web3.toText(data_source).lower():
data.append(
dict(
dataset=self.to_text(data_source)
)
)
df = pd.DataFrame(data)
set_print_settings()
if df.empty:
print('There are no datasets available yet.')
else:
print(df)
def subscribe(self, dataset):
dataset = dataset.lower()
address = self.choose_pubaddr()[0]
provider_info = self.mkt_contract.functions.getDataProviderInfo(
Web3.toHex(dataset)
).call()
if not provider_info[4]:
print('The requested "{}" dataset is not registered in '
'the Data Marketplace.'.format(dataset))
return
grains = provider_info[1]
price = from_grains(grains)
subscribed = self.mkt_contract.functions.checkAddressSubscription(
address, Web3.toHex(dataset)
).call()
if subscribed[5]:
print(
'\nYou are already subscribed to the "{}" dataset.\n'
'Your subscription started on {} UTC, and is valid until '
'{} UTC.'.format(
dataset,
pd.to_datetime(subscribed[3], unit='s', utc=True),
pd.to_datetime(subscribed[4], unit='s', utc=True)
)
)
return
print('\nThe price for a monthly subscription to this dataset is'
' {} ENG'.format(price))
print(
'Checking that the ENG balance in {} is greater than {} '
'ENG... '.format(address, price), end=''
)
wallet_address = address[2:]
balance = self.web3.eth.call({
'from': address,
'to': self.eng_contract_address,
'data': '0x70a08231000000000000000000000000{}'.format(
wallet_address
)
})
try:
balance = Web3.toInt(balance) # web3 >= 4.0.0b7
except TypeError:
balance = Web3.toInt(hexstr=balance) # web3 <= 4.0.0b6
if balance > grains:
print('OK.')
else:
print('FAIL.\n\nAddress {} balance is {} ENG,\nwhich is lower '
'than the price of the dataset that you are trying to\n'
'buy: {} ENG. Get enough ENG to cover the costs of the '
'monthly\nsubscription for what you are trying to buy, '
'and try again.'.format(
address, from_grains(balance), price))
return
while True:
agree_pay = input('Please confirm that you agree to pay {} ENG '
'for a monthly subscription to the dataset "{}" '
'starting today. [default: Y] '.format(
price, dataset)) or 'y'
if agree_pay.lower() not in ('y', 'n'):
print("Please answer Y or N.")
else:
if agree_pay.lower() == 'y':
break
else:
return
print('Ready to subscribe to dataset {}.\n'.format(dataset))
print('In order to execute the subscription, you will need to sign '
'two different transactions:\n'
'1. First transaction is to authorize the Marketplace contract '
'to spend {} ENG on your behalf.\n'
'2. Second transaction is the actual subscription for the '
'desired dataset'.format(price))
tx = self.eng_contract.functions.approve(
self.mkt_contract_address,
grains,
).buildTransaction(
{'nonce': self.web3.eth.getTransactionCount(address)}
)
if 'ropsten' in ETH_REMOTE_NODE:
tx['gas'] = min(int(tx['gas'] * 1.5), 4700000)
signed_tx = self.sign_transaction(address, tx)
try:
tx_hash = '0x{}'.format(
bin_hex(self.web3.eth.sendRawTransaction(signed_tx))
)
print(
'\nThis is the TxHash for this transaction: {}'.format(tx_hash)
)
except Exception as e:
print('Unable to subscribe to data source: {}'.format(e))
return
self.check_transaction(tx_hash)
print('Waiting for the first transaction to succeed...')
while True:
try:
if self.web3.eth.getTransactionReceipt(tx_hash).status:
break
else:
print('\nTransaction failed. Aborting...')
return
except AttributeError:
pass
for i in range(0, 10):
print('.', end='', flush=True)
time.sleep(1)
print('\nFirst transaction successful!\n'
'Now processing second transaction.')
tx = self.mkt_contract.functions.subscribe(
Web3.toHex(dataset),
).buildTransaction(
{'nonce': self.web3.eth.getTransactionCount(address)})
if 'ropsten' in ETH_REMOTE_NODE:
tx['gas'] = min(int(tx['gas'] * 1.5), 4700000)
signed_tx = self.sign_transaction(address, tx)
try:
tx_hash = '0x{}'.format(bin_hex(
self.web3.eth.sendRawTransaction(signed_tx)))
print('\nThis is the TxHash for this transaction: '
'{}'.format(tx_hash))
except Exception as e:
print('Unable to subscribe to data source: {}'.format(e))
return
self.check_transaction(tx_hash)
print('Waiting for the second transaction to succeed...')
while True:
try:
if self.web3.eth.getTransactionReceipt(tx_hash).status:
break
else:
print('\nTransaction failed. Aborting...')
return
except AttributeError:
pass
for i in range(0, 10):
print('.', end='', flush=True)
time.sleep(1)
print('\nSecond transaction successful!\n'
'You have successfully subscribed to dataset {} with'
'address {}.\n'
'You can now ingest this dataset anytime during the '
'next month by running the following command:\n'
'catalyst marketplace ingest --dataset={}'.format(
dataset, address, dataset))
def process_temp_bundle(self, ds_name, path):
"""
Merge the temp bundle into the main bundle for the specified
data source.
Parameters
----------
ds_name
path
Returns
-------
"""
tmp_bundle = extract_bundle(path)
bundle_folder = get_data_source_folder(ds_name)
if os.listdir(bundle_folder):
zsource = bcolz.ctable(rootdir=tmp_bundle, mode='r')
ztarget = bcolz.ctable(rootdir=bundle_folder, mode='r')
merge_bundles(zsource, ztarget)
else:
os.rename(tmp_bundle, bundle_folder)
pass
def ingest(self, ds_name, start=None, end=None, force_download=False):
# ds_name = ds_name.lower()
# TODO: catch error conditions
provider_info = self.mkt_contract.functions.getDataProviderInfo(
Web3.toHex(ds_name)
).call()
if not provider_info[4]:
print('The requested "{}" dataset is not registered in '
'the Data Marketplace.'.format(ds_name))
return
address, address_i = self.choose_pubaddr()
fns = self.mkt_contract.functions
check_sub = fns.checkAddressSubscription(
address, Web3.toHex(ds_name)
).call()
if check_sub[0] != address or self.to_text(check_sub[1]) != ds_name:
print('You are not subscribed to dataset "{}" with address {}. '
'Plese subscribe first.'.format(ds_name, address))
return
if not check_sub[5]:
print('Your subscription to dataset "{}" expired on {} UTC.'
'Please renew your subscription by running:\n'
'catalyst marketplace subscribe --dataset={}'.format(
ds_name,
pd.to_datetime(check_sub[4], unit='s', utc=True),
ds_name)
)
if 'key' in self.addresses[address_i]:
key = self.addresses[address_i]['key']
secret = self.addresses[address_i]['secret']
else:
key, secret = get_key_secret(address)
headers = get_signed_headers(ds_name, key, secret)
log.debug('Starting download of dataset for ingestion...')
r = requests.post(
'{}/marketplace/ingest'.format(AUTH_SERVER),
headers=headers,
stream=True,
)
if r.status_code == 200:
target_path = get_temp_bundles_folder()
try:
decoder = MultipartDecoder.from_response(r)
for part in decoder.parts:
h = part.headers[b'Content-Disposition'].decode('utf-8')
# Extracting the filename from the header
name = re.search(r'filename="(.*)"', h).group(1)
filename = os.path.join(target_path, name)
with open(filename, 'wb') as f:
# for chunk in part.content.iter_content(
# chunk_size=1024):
# if chunk: # filter out keep-alive new chunks
# f.write(chunk)
f.write(part.content)
self.process_temp_bundle(ds_name, filename)
except NonMultipartContentTypeException:
response = r.json()
raise MarketplaceHTTPRequest(
request='ingest dataset',
error=response,
)
else:
raise MarketplaceHTTPRequest(
request='ingest dataset',
error=r.status_code,
)
log.info('{} ingested successfully'.format(ds_name))
def get_dataset(self, ds_name, start=None, end=None):
ds_name = ds_name.lower()
# TODO: filter ctable by start and end date
bundle_folder = get_data_source_folder(ds_name)
z = bcolz.ctable(rootdir=bundle_folder, mode='r')
df = z.todataframe() # type: pd.DataFrame
df.set_index(['date', 'symbol'], drop=True, inplace=True)
# TODO: implement the filter more carefully
# if start and end is None:
# df = df.xs(start, level=0)
return df
def clean(self, data_source_name, data_frequency=None):
data_source_name = data_source_name.lower()
if data_frequency is None:
folder = get_data_source_folder(data_source_name)
else:
folder = get_bundle_folder(data_source_name, data_frequency)
shutil.rmtree(folder)
pass
def create_metadata(self, key, secret, ds_name, data_frequency, desc,
has_history=True, has_live=True):
"""
Returns
-------
"""
headers = get_signed_headers(ds_name, key, secret)
r = requests.post(
'{}/marketplace/register'.format(AUTH_SERVER),
json=dict(
ds_name=ds_name,
desc=desc,
data_frequency=data_frequency,
has_history=has_history,
has_live=has_live,
),
headers=headers,
)
if r.status_code != 200:
raise MarketplaceHTTPRequest(
request='register', error=r.status_code
)
if 'error' in r.json():
raise MarketplaceHTTPRequest(
request='upload file', error=r.json()['error']
)
def register(self):
while True:
desc = input('Enter the name of the dataset to register: ')
dataset = desc.lower()
provider_info = self.mkt_contract.functions.getDataProviderInfo(
Web3.toHex(dataset)
).call()
if provider_info[4]:
print('There is already a dataset registered under '
'the name "{}". Please choose a different '
'name.'.format(dataset))
else:
break
price = int(
input(
'Enter the price for a monthly subscription to '
'this dataset in ENG: '
)
)
while True:
freq = input('Enter the data frequency [daily, hourly, minute]: ')
if freq.lower() not in ('daily', 'hourly', 'minute'):
print('Not a valid frequency.')
else:
break
while True:
reg_pub = input(
'Does it include historical data? [default: Y]: '
) or 'y'
if reg_pub.lower() not in ('y', 'n'):
print('Please answer Y or N.')
else:
if reg_pub.lower() == 'y':
has_history = True
else:
has_history = False
break
while True:
reg_pub = input(
'Doest it include live data? [default: Y]: '
) or 'y'
if reg_pub.lower() not in ('y', 'n'):
print('Please answer Y or N.')
else:
if reg_pub.lower() == 'y':
has_live = True
else:
has_live = False
break
address, address_i = self.choose_pubaddr()
if 'key' in self.addresses[address_i]:
key = self.addresses[address_i]['key']
secret = self.addresses[address_i]['secret']
else:
key, secret = get_key_secret(address)
grains = to_grains(price)
tx = self.mkt_contract.functions.register(
Web3.toHex(dataset),
grains,
address,
).buildTransaction(
{'nonce': self.web3.eth.getTransactionCount(address)}
)
if 'ropsten' in ETH_REMOTE_NODE:
tx['gas'] = min(int(tx['gas'] * 1.5), 4700000)
signed_tx = self.sign_transaction(address, tx)
try:
tx_hash = '0x{}'.format(
bin_hex(self.web3.eth.sendRawTransaction(signed_tx))
)
print(
'\nThis is the TxHash for this transaction: {}'.format(tx_hash)
)
except Exception as e:
print('Unable to register the requested dataset: {}'.format(e))
return
self.check_transaction(tx_hash)
print('Waiting for the transaction to succeed...')
while True:
try:
if self.web3.eth.getTransactionReceipt(tx_hash).status:
break
else:
print('\nTransaction failed. Aborting...')
return
except AttributeError:
pass
for i in range(0, 10):
print('.', end='', flush=True)
time.sleep(1)
print('\nWarming up the {} dataset'.format(dataset))
self.create_metadata(
key=key,
secret=secret,
ds_name=dataset,
data_frequency=freq,
desc=desc,
has_history=has_history,
has_live=has_live,
)
print('\n{} registered successfully'.format(dataset))
def publish(self, dataset, datadir, watch):
dataset = dataset.lower()
provider_info = self.mkt_contract.functions.getDataProviderInfo(
Web3.toHex(dataset)
).call()
if not provider_info[4]:
raise MarketplaceDatasetNotFound(dataset=dataset)
match = next(
(l for l in self.addresses if l['pubAddr'] == provider_info[0]),
None
)
if not match:
raise MarketplaceNoAddressMatch(
dataset=dataset,
address=provider_info[0])
print('Using address: {} to publish this dataset.'.format(
provider_info[0]))
if 'key' in match:
key = match['key']
secret = match['secret']
else:
key, secret = get_key_secret(provider_info[0])
headers = get_signed_headers(dataset, key, secret)
filenames = glob.glob(os.path.join(datadir, '*.csv'))
if not filenames:
raise MarketplaceNoCSVFiles(datadir=datadir)
files = []
for file in filenames:
files.append(('file', open(file, 'rb')))
r = requests.post('{}/marketplace/publish'.format(AUTH_SERVER),
files=files,
headers=headers)
if r.status_code != 200:
raise MarketplaceHTTPRequest(request='upload file',
error=r.status_code)
if 'error' in r.json():
raise MarketplaceHTTPRequest(request='upload file',
error=r.json()['error'])
print('Dataset {} uploaded successfully.'.format(dataset))
@@ -0,0 +1,97 @@
import sys
import traceback
from catalyst.errors import ZiplineError
def silent_except_hook(exctype, excvalue, exctraceback):
if exctype in [MarketplacePubAddressEmpty, MarketplaceDatasetNotFound,
MarketplaceNoAddressMatch, MarketplaceHTTPRequest,
MarketplaceNoCSVFiles, MarketplaceContractDataNoMatch,
MarketplaceSubscriptionExpired, MarketplaceJSONError,
MarketplaceWalletNotSupported, MarketplaceEmptySignature,
MarketplaceRequiresPython3]:
fn = traceback.extract_tb(exctraceback)[-1][0]
ln = traceback.extract_tb(exctraceback)[-1][1]
print("Error traceback: {1} (line {2})\n"
"{0.__name__}: {3}".format(exctype, fn, ln, excvalue))
else:
sys.__excepthook__(exctype, excvalue, exctraceback)
sys.excepthook = silent_except_hook
class MarketplacePubAddressEmpty(ZiplineError):
msg = (
'Please enter your public address to use in the Data Marketplace '
'in the following file: {filename}'
).strip()
class MarketplaceDatasetNotFound(ZiplineError):
msg = (
'The dataset "{dataset}" is not registered in the Data Marketplace.'
).strip()
class MarketplaceNoAddressMatch(ZiplineError):
msg = (
'The address registered with the dataset {dataset}: {address} '
'does not match any of your addresses.'
).strip()
class MarketplaceHTTPRequest(ZiplineError):
msg = (
'Request to remote server to {request} failed: {error}'
).strip()
class MarketplaceNoCSVFiles(ZiplineError):
msg = (
'No CSV files found on {datadir} to upload.'
)
class MarketplaceContractDataNoMatch(ZiplineError):
msg = (
'The information found on the contract does not match the '
'requested data:\n{params}.'
)
class MarketplaceSubscriptionExpired(ZiplineError):
msg = (
'Your subscription to dataset "{dataset}" expired on {date} '
'and is no longer active. You have to subscribe again running the '
'following command:\n'
'catalyst marketplace subscribe --dataset={dataset}'
)
class MarketplaceWalletNotSupported(ZiplineError):
msg = (
'Wallet {wallet} is not supported.'
)
class MarketplaceEmptySignature(ZiplineError):
msg = (
'Signature cannot be empty.'
)
class MarketplaceJSONError(ZiplineError):
msg = (
'The configuration file {file} is malformed. Please correct '
'the following error:\n{error}'
)
class MarketplaceRequiresPython3(ZiplineError):
msg = (
'\nCatalyst requires Python3 to access the Enigma Data Marketplace.\n'
'If you want to use the Data Marketplace, you need to reinstall '
'Catalyst\nwith Python3. See the documentation website for additional '
'information.')
+131
View File
@@ -0,0 +1,131 @@
import hashlib
import hmac
import requests
import time
from catalyst.marketplace.marketplace_errors import (
MarketplaceHTTPRequest, MarketplaceWalletNotSupported,
MarketplaceEmptySignature)
from catalyst.marketplace.utils.path_utils import (
get_user_pubaddr, save_user_pubaddr)
from catalyst.constants import AUTH_SERVER
def get_key_secret(pubAddr, wallet='mew'):
"""
Obtain a new key/secret pair from authentication server
Parameters
----------
pubAddr: str
dataset: str
Returns
-------
key: str
secret: str
"""
session = requests.Session()
response = session.get('{}/marketplace/getkeysecret'.format(AUTH_SERVER),
headers={
'Authorization': 'Digest username="{0}"'.format(
pubAddr)})
if response.status_code != 401:
raise MarketplaceHTTPRequest(request=str('obtain key/secret'),
error='Unexpected response code: '
'{}'.format(response.status_code))
header = response.headers.get('WWW-Authenticate')
auth_type, auth_info = header.split(None, 1)
d = requests.utils.parse_dict_header(auth_info)
nonce = '0x{}'.format(d['nonce'])
if wallet == 'mew':
print('\nObtaining a key/secret pair to streamline all future '
'requests with the authentication server.\n'
'Visit https://www.myetherwallet.com/signmsg.html and sign the '
'following message:\n{}'.format(nonce))
signature = input('Copy and Paste the "sig" field from '
'the signature here (without the double quotes, '
'only the HEX value):\n')
else:
raise MarketplaceWalletNotSupported(wallet=wallet)
if signature is None:
raise MarketplaceEmptySignature()
signature = signature[2:]
r = int(signature[0:64], base=16)
s = int(signature[64:128], base=16)
v = int(signature[128:130], base=16)
vrs = [v, r, s]
response = session.get('{}/marketplace/getkeysecret'.format(AUTH_SERVER),
headers={
'Authorization': 'Digest username="{0}",realm="{1}",'
'nonce="{2}",uri="/marketplace/getkeysecret",response="{3}",'
'opaque="{4}"'.format(pubAddr,
d['realm'],
d['nonce'],
','.join(str(e) for e in vrs+[wallet]),
d['opaque'])})
if response.status_code == 200:
if 'error' in response.json():
raise MarketplaceHTTPRequest(request=str('obtain key/secret'),
error=str(response.json()['error']))
else:
addresses = get_user_pubaddr()
match = next((l for l in addresses if
l['pubAddr'] == pubAddr), None)
match['key'] = response.json()['key']
match['secret'] = response.json()['secret']
addresses[addresses.index(match)] = match
save_user_pubaddr(addresses)
print('Key/secret pair retrieved successfully from server.')
return match['key'], match['secret']
else:
raise MarketplaceHTTPRequest(request=str('obtain key/secret'),
error=response.status_code)
def get_signed_headers(ds_name, key, secret):
"""
Return a new request header including the key / secret signature
Parameters
----------
ds_name
key
secret
Returns
-------
"""
nonce = str(int(time.time()))
signature = hmac.new(
secret.encode('utf-8'),
'{}{}'.format(ds_name, nonce).encode('utf-8'),
hashlib.sha512
).hexdigest()
headers = {
'Sign': signature,
'Key': key,
'Nonce': nonce,
'Dataset': ds_name,
}
return headers
@@ -0,0 +1,36 @@
import os
import shutil
import bcolz
import pandas as pd
def merge_bundles(zsource, ztarget):
"""
Merge
Parameters
----------
zsource
ztarget
Returns
-------
"""
# TODO: find a way to do this iteratively instead of in-memory
df_source = zsource.todataframe()
df_target = ztarget.todataframe()
df = pd.concat(
[df_source, df_target], ignore_index=True
) # type: pd.DataFrame
df.drop_duplicates(inplace=True)
df.set_index(['date', 'symbol'], drop=False, inplace=True)
dirname = os.path.basename(ztarget.rootdir)
bak_dir = ztarget.rootdir.replace(dirname, '.{}'.format(dirname))
os.rename(ztarget.rootdir, bak_dir)
z = bcolz.ctable.fromdataframe(df=df, rootdir=ztarget.rootdir)
shutil.rmtree(bak_dir)
return z
+82
View File
@@ -0,0 +1,82 @@
import binascii
# def bytes32(string):
# """
# Convert string to bytes32 data type for smart contract
# Parameters
# ----------
# string: str
# Returns
# -------
# list
# """
# return binascii.hexlify(string.encode('utf-8'))
# def b32_str(bytes32):
# """
# Convert bytes32 to string
# Parameters
# ----------
# input: bytes object
# Returns
# -------
# str
# """
# return binascii.unhexlify(
# bytes32.decode('utf-8').rstrip('\0')).decode('ascii')
def bin_hex(binary):
"""
Convert bytes32 to string
Parameters
----------
input: bytes object
Returns
-------
str
"""
return binascii.hexlify(binary).decode('utf-8')
def from_grains(amount):
"""
Convert from grains to cryptocurrency
Parameters
----------
input: amount
Returns
-------
int
"""
return amount // 10 ** 8
def to_grains(amount):
"""
Convert from cryptocurrency to grains
Parameters
----------
input: amount
Returns
-------
int
"""
return amount * 10 ** 8
+166
View File
@@ -0,0 +1,166 @@
import os
import json
import tarfile
from catalyst.utils.deprecate import deprecated
from catalyst.utils.paths import data_root, ensure_directory
from catalyst.marketplace.marketplace_errors import MarketplaceJSONError
def get_marketplace_folder(environ=None):
"""
The root path of the marketplace folder.
Parameters
----------
environ:
Returns
-------
str
"""
if not environ:
environ = os.environ
root = data_root(environ)
marketplace_folder = os.path.join(root, 'marketplace')
ensure_directory(marketplace_folder)
return marketplace_folder
def get_data_source_folder(data_source_name, environ=None):
"""
The root path of an data_source folder.
Parameters
----------
data_source_name: str
environ:
Returns
-------
str
"""
if not environ:
environ = os.environ
root = data_root(environ)
data_source_folder = os.path.join(root, 'marketplace', data_source_name)
ensure_directory(data_source_folder)
return data_source_folder
@deprecated
def get_bundle_folder(data_source_name, data_frequency, environ=None):
data_source_folder = get_data_source_folder(data_source_name, environ)
bundle_folder = os.path.join(data_source_folder, data_frequency)
ensure_directory(bundle_folder)
return bundle_folder
def get_temp_bundles_folder(environ=None):
"""
The temp folder for bundle downloads by algo name.
Parameters
----------
ds_name: str
environ:
Returns
-------
str
"""
root = data_root(environ)
folder = os.path.join(root, 'marketplace', 'temp_bundles')
ensure_directory(folder)
return folder
def extract_bundle(tar_filename):
"""
Extract a bcolz bundle.
Parameters
----------
ds_name
Returns
-------
str
"""
target_path = tar_filename.replace('.tar.gz', '')
with tarfile.open(tar_filename, 'r') as tar:
tar.extractall(target_path)
return target_path
def get_user_pubaddr(environ=None):
"""
The de-serialized contend of the user's addresses.json file.
Parameters
----------
environ:
Returns
-------
Object
"""
marketplace_folder = get_marketplace_folder(environ)
filename = os.path.join(marketplace_folder, 'addresses.json')
if os.path.isfile(filename):
with open(filename) as data_file:
try:
data = json.load(data_file)
except json.decoder.JSONDecodeError as e:
raise MarketplaceJSONError(file=filename, error=e)
try:
d = data[0]['pubAddr']
except Exception as e:
return [data, ]
return data
else:
data = []
data.append(dict(pubAddr='', desc=''))
with open(filename, 'w') as f:
json.dump(data, f, sort_keys=False, indent=2,
separators=(',', ':'))
return data
def save_user_pubaddr(data, environ=None):
"""
Saves the user's public addresses and their related metadata in
the corresponding addresses.json file.
Parameters
----------
data: dict
Returns
-------
True
"""
marketplace_folder = get_marketplace_folder(environ)
filename = os.path.join(marketplace_folder, 'addresses.json')
with open(filename, 'w') as f:
json.dump(data, f, sort_keys=False, indent=2,
separators=(',', ':'))
return True
+376
View File
@@ -0,0 +1,376 @@
# -*- coding: utf-8 -*-
# !/usr/bin/env python2
import sys
import os
import pandas as pd
import signal
# import talib
from logbook import Logger
from catalyst import run_algorithm
from catalyst.api import (
symbol,
record,
order,
order_target,
order_target_percent,
get_open_orders
)
from catalyst.finance import commission
# from base.telegrambot import TelegramBot
class GracefulKiller:
# Source: https://stackoverflow.com/a/31464349
def __init__(self, context):
self.kill_now = False
self.signal = 0
self.context = context
signal.signal(signal.SIGINT, self.exit_gracefully)
def exit_gracefully(self, signum, frame):
self.kill_now = True
self.signal = signum
if hasattr(self.context,
'telegram_bot') and self.context.telegram_bot is not None:
self.context.telegram_bot.updater.stop()
sys.exit(0)
def exit(self):
return self.kill_now
class SimulationParameters:
MODE = 'paper'
CAPITAL_BASE = 1000
"""
Capital base used on this simulation
"""
DATA_FREQUECY = 'minute'
EXCHANGE_NAME = 'bitfinex'
# EXCHANGE_NAME = 'binance'
"""
Exchange used on this simulation
"""
DATA_DIR = '/home/av/Dropbox/simulations/data'
ALGO_NAMESPACE = os.path.basename(__file__).split('.')[0]
ALGO_NAMESPACE_IMAGE = '{}/{}/{}.png'.format(DATA_DIR, 'images',
ALGO_NAMESPACE)
ALGO_NAMESPACE_RESULTS_TABLE = '{}/{}/{}.csv'.format(DATA_DIR, 'tables',
ALGO_NAMESPACE + '_results')
ALGO_NAMESPACE_TRANSACTIONS_TABLE = '{}/{}/{}.csv'.format(DATA_DIR,
'tables',
ALGO_NAMESPACE + '_transactions')
BASE_CURRENCY = 'usd'
# BASE_CURRENCY = 'usdt'
# SHORT PERIOD
START_DATE = '2017-09-07'
"""
Start date used on this simulation
"""
END_DATE = '2017-12-12'
"""
End date used on this simulation
"""
SKIP_FIRST_CANDLES = 0
# CANDLES_SAMPLE_RATE = 60
# CANDLES_SAMPLE_RATE = 30
CANDLES_SAMPLE_RATE = 1
"""
Candle interval used on this simulation (in minutes)
"""
# http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases
# 30 minute interval ohlcv data (the standard data required for candlestick or
# indicators/signals)
# 30T means 30 minutes re-sampling of one minute data.
# CANDLES_FREQUENCY = '60T'
# CANDLES_FREQUENCY = '30T'
CANDLES_FREQUENCY = '1T'
CANDLES_BUFFER_SIZE = 48
COIN_PAIR = 'btc_usd'
# COIN_PAIR = 'btc_usdt'
"""
Coin pair used on this simulation
"""
# TRANSACTIONS
COMMISSION_FEE = 0.0030
BUY_MIN_AMOUNT = 5 # i.e: USD
SELL_MIN_AMOUNT = 0.001 # i.e: USD
BUY_SELL_PERCENTAGE = 1 # 0.50
BUY_PERCENTAGE = BUY_SELL_PERCENTAGE
SELL_PERCENTAGE = BUY_SELL_PERCENTAGE
BASE_PRICE = 'close'
"""
Base price used (close / Heiken Ashi)
"""
log = None
parameters = None
def print_facts(context):
context.log.info("""
Index: {}
Date: {}
Candle:
O: {}
H: {}
L: {}
C: {}
V: {}
Metrics:
...
Portfolio:
Base price: {}
Base coin (coin2/usd): {}
Amount (coin1/btc): {}
""".format(
# Facts
context.i,
context.curr_minute,
context.candles_open[-1],
context.candles_high[-1],
context.candles_low[-1],
context.candles_close[-1],
context.candles_volume[-1],
# Metrics
# ...
# Portfolio
context.curr_base_price,
context.portfolio.cash,
context.portfolio.positions[context.coin_pair].amount,
))
def print_facts_telegram(context):
price = context.curr_base_price
amount = context.portfolio.positions[context.coin_pair].amount
pnl = context.portfolio.pnl
capital_used = context.portfolio.capital_used
portfolio_value = context.portfolio.portfolio_value
portfolio_returns = context.portfolio.returns
starting_cash = context.portfolio.starting_cash
cash = context.portfolio.cash
msg = """
Status...
Price: {}
Starting cash: {}
Cash: {}
Capital used: {}
Amount: {}
Portfolio value: {}
Returns: {}
PnL: {}
""".format(
price,
starting_cash,
cash,
capital_used,
amount,
portfolio_value,
portfolio_returns,
pnl,
)
if hasattr(context, 'telegram_bot') and context.telegram_bot is not None:
context.telegram_bot.msg(msg)
def default_initialize(context):
# FIXME: set_benchmark
# set_benchmark(symbol(context.parameters.COIN_PAIR))
context.coin_pair = symbol(context.parameters.COIN_PAIR)
context.base_price = None
context.current_day = None
context.counter = -1
context.i = 0
context.candles_sample_rate = context.parameters.CANDLES_SAMPLE_RATE
context.candles_frequency = context.parameters.CANDLES_FREQUENCY
context.candles_buffer_size = context.parameters.CANDLES_BUFFER_SIZE
context.set_commission(
commission.PerShare(cost=context.parameters.COMMISSION_FEE))
def default_handle_data(context, data):
context.curr_minute = data.current_dt
context.counter += 1
if context.candles_sample_rate == 1:
context.i += 1
elif context.counter % context.candles_sample_rate != 0:
context.i += 1
return
if context.i < context.parameters.SKIP_FIRST_CANDLES:
return
context.candles_open = data.history(
context.coin_pair,
'open',
bar_count=context.candles_buffer_size,
frequency=context.candles_frequency)
context.candles_high = data.history(
context.coin_pair,
'high',
bar_count=context.candles_buffer_size,
frequency=context.candles_frequency)
context.candles_low = data.history(
context.coin_pair,
'low',
bar_count=context.candles_buffer_size,
frequency=context.candles_frequency)
context.candles_close = data.history(
context.coin_pair,
'price',
bar_count=context.candles_buffer_size,
frequency=context.candles_frequency)
context.candles_volume = data.history(
context.coin_pair,
'volume',
bar_count=context.candles_buffer_size,
frequency=context.candles_frequency)
# FIXME: Here is the error!
# The candles_close frame shows more or less always a value of 94, while
# bitcoin price is very different from that
print(context.candles_close)
context.base_prices = context.candles_close
cash = context.portfolio.cash
amount = context.portfolio.positions[context.coin_pair].amount
price = data.current(context.coin_pair, 'price')
order_id = None
context.last_base_price = context.base_prices[-2]
context.curr_base_price = context.base_prices[-1]
# TA calculations
# ...
# Sanity checks
# assert cash >= 0
if cash < 0:
import ipdb;
ipdb.set_trace() # BREAKPOINT
print_facts(context)
print_facts_telegram(context)
# Order management
net_shares = 0
if context.counter == 2:
brute_shares = (cash / price) * context.parameters.BUY_PERCENTAGE
share_commission_fee = brute_shares * context.parameters.COMMISSION_FEE
net_shares = brute_shares - share_commission_fee
buy_order_id = order(context.coin_pair, net_shares)
if context.counter == 3:
brute_shares = amount * context.parameters.SELL_PERCENTAGE
share_commission_fee = brute_shares * context.parameters.COMMISSION_FEE
net_shares = -(brute_shares - share_commission_fee)
sell_order_id = order(context.coin_pair, net_shares)
# Record
record(
price=price,
foo='bar',
# volume=current['volume'],
# price_change=price_change,
# Metrics
cash=cash,
# buy=context.buy,
# sell=context.sell
)
def default_analyze(context=None, perf=None):
pass
def initialize(context):
global log
context.parameters = parameters
context.log = Logger(context.parameters.ALGO_NAMESPACE)
log = context.log
default_initialize(context)
context.killer = GracefulKiller(context)
context.telegram_bot = None
# TELEGRAM_TOKEN='token'
# context.telegram_bot = TelegramBot()
# context.telegram_bot.initialize(TELEGRAM_TOKEN, context)
if __name__ == '__main__':
# Parameters:
parameters = SimulationParameters()
start_date = pd.to_datetime(parameters.START_DATE, utc=True)
end_date = pd.to_datetime(parameters.END_DATE, utc=True)
if parameters.MODE == 'backtest':
results = run_algorithm(
capital_base=parameters.CAPITAL_BASE,
data_frequency=parameters.DATA_FREQUECY,
initialize=initialize,
handle_data=default_handle_data,
analyze=default_analyze,
exchange_name=parameters.EXCHANGE_NAME,
algo_namespace=parameters.ALGO_NAMESPACE,
base_currency=parameters.BASE_CURRENCY,
start=start_date,
end=end_date,
live=False,
live_graph=False
)
returns_daily = results
results.to_csv('{}'.format(parameters.ALGO_NAMESPACE_RESULTS_TABLE))
# returns_daily = returns_minutely.add(1).groupby(pd.TimeGrouper('24H')).prod().add(-1)
# FIXME: pyfolio integration
# pf_data = pyfolio.utils.extract_rets_pos_txn_from_zipline(results)
# pf_data = pyfolio.utils.extract_rets_pos_txn_from_zipline(results[:'2017-01-01'])
# pyfolio.create_full_tear_sheet(*pf_data)
elif parameters.MODE == 'paper':
results = run_algorithm(
capital_base=parameters.CAPITAL_BASE,
data_frequency=parameters.DATA_FREQUECY,
initialize=initialize,
handle_data=default_handle_data,
analyze=default_analyze,
exchange_name=parameters.EXCHANGE_NAME,
algo_namespace=parameters.ALGO_NAMESPACE,
base_currency=parameters.BASE_CURRENCY,
live=True,
simulate_orders=True,
live_graph=False
)
elif parameters.MODE == 'live':
results = run_algorithm(
initialize=initialize,
handle_data=default_handle_data,
analyze=default_analyze,
exchange_name=parameters.EXCHANGE_NAME,
algo_namespace=parameters.ALGO_NAMESPACE,
base_currency=parameters.BASE_CURRENCY,
live=True,
live_graph=True
)
+32
View File
@@ -0,0 +1,32 @@
from catalyst.api import symbol
from catalyst.utils.run_algo import run_algorithm
coins = ['dash', 'btc', 'dash', 'etc', 'eth', 'ltc', 'nxt', 'rep', 'str', 'xmr', 'xrp', 'zec']
symbols = None
def initialize(context):
pass
def _handle_data(context, data):
global symbols
if symbols is None: symbols = [symbol(c + '_usdt') for c in coins]
print'getting history for: %s' % [s.symbol for s in symbols]
history = data.history(symbols,
['close', 'volume'],
bar_count=1, # EXCEPTION, Change to 2
frequency='5T')
#print 'history: %s' % history.shape
run_algorithm(initialize=initialize,
handle_data=_handle_data,
analyze=lambda _, results: True,
exchange_name='poloniex',
base_currency='usdt',
algo_namespace='issue-236',
live=True,
data_frequency='minute',
capital_base=3000,
simulate_orders=True)
+6 -8
View File
@@ -55,6 +55,7 @@ class _RunAlgoError(click.ClickException, ValueError):
---------- ----------
pyfunc_msg : str pyfunc_msg : str
The message that will be shown when called as a python function. The message that will be shown when called as a python function.
cmdline_msg : str cmdline_msg : str
The message that will be shown on the command line. The message that will be shown on the command line.
""" """
@@ -416,7 +417,8 @@ def run_algorithm(initialize,
auth_aliases=None, auth_aliases=None,
stats_output=None, stats_output=None,
output=os.devnull): output=os.devnull):
"""Run a trading algorithm. """
Run a trading algorithm.
Parameters Parameters
---------- ----------
@@ -458,7 +460,7 @@ def run_algorithm(initialize,
This argument is mutually exclusive with ``data``. This argument is mutually exclusive with ``data``.
default_extension : bool, optional default_extension : bool, optional
Should the default catalyst extension be loaded. This is found at Should the default catalyst extension be loaded. This is found at
``$ZIPLINE_ROOT/extension.py`` ``$CATALYST_ROOT/extension.py``
extensions : iterable[str], optional extensions : iterable[str], optional
The names of any other extensions to load. Each element may either be The names of any other extensions to load. Each element may either be
a dotted module path like ``a.b.c`` or a path to a python file ending a dotted module path like ``a.b.c`` or a path to a python file ending
@@ -469,12 +471,8 @@ def run_algorithm(initialize,
environ : mapping[str -> str], optional environ : mapping[str -> str], optional
The os environment to use. Many extensions use this to get parameters. The os environment to use. Many extensions use this to get parameters.
This defaults to ``os.environ``. This defaults to ``os.environ``.
live: execute live trading live : bool, optional
exchange_conn: The exchange connection parameters Execute algorithm in live trading mode.
Supported Exchanges
-------------------
bitfinex
Returns Returns
------- -------
+103
View File
@@ -0,0 +1,103 @@
#!flask/bin/python
import base64
import requests
import pandas as pd
import json
def convert_date(date):
"""
when transferring dates by json,
converts it to str
:param date:
:return: str(date)
"""
if isinstance(date, pd.Timestamp):
return date.__str__()
def run_server(
initialize,
handle_data,
before_trading_start,
analyze,
algofile,
algotext,
defines,
data_frequency,
capital_base,
data,
bundle,
bundle_timestamp,
start,
end,
output,
print_algo,
local_namespace,
environ,
live,
exchange,
algo_namespace,
base_currency,
live_graph,
analyze_live,
simulate_orders,
auth_aliases,
stats_output,
):
# address to send
url = 'http://sandbox.enigma.co/api/catalyst/serve'
# url = 'http://127.0.0.1:5000/api/catalyst/serve'
# argument preparation - encode the file for transfer
if algotext:
algotext = base64.b64encode(algotext)
else:
algotext = base64.b64encode(bytes(algofile.read(), 'utf-8')).decode('utf-8')
algofile = None
json_file = {'arguments': {
'initialize': initialize,
'handle_data': handle_data,
'before_trading_start': before_trading_start,
'analyze': analyze,
'algotext': algotext,
'defines': defines,
'data_frequency': data_frequency,
'capital_base': capital_base,
'data': data,
'bundle': bundle,
'bundle_timestamp': bundle_timestamp,
'start': start,
'end': end,
'local_namespace': local_namespace,
'environ': None,
'analyze_live': analyze_live,
'stats_output': stats_output,
'algofile': algofile,
'output': output,
'print_algo': print_algo,
'live': live,
'exchange': exchange,
'algo_namespace': algo_namespace,
'base_currency': base_currency,
'live_graph': live_graph,
'simulate_orders': simulate_orders,
'auth_aliases': auth_aliases,
}}
response = requests.post(url,
json=json.dumps(
json_file,
default=convert_date
)
)
if response.status_code == 500:
raise Exception("issues with cloud connections, "
"unable to run catalyst on the cloud")
received_data = response.json()
cloud_log_tail = base64.b64decode(received_data["log"])
print(cloud_log_tail)
+173 -179
View File
@@ -4,7 +4,7 @@ API Reference
Running a Backtest Running a Backtest
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
.. autofunction:: zipline.run_algorithm(...) .. autofunction:: catalyst.run_algorithm(...)
Algorithm API Algorithm API
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@@ -18,341 +18,335 @@ currently-executing :class:`~zipline.algorithm.TradingAlgorithm` instance.
Data Object Data Object
``````````` ```````````
.. autoclass:: zipline.protocol.BarData .. autoclass:: catalyst.protocol.BarData
:members: :members:
Scheduling Functions Scheduling Functions
```````````````````` ````````````````````
.. autofunction:: zipline.api.schedule_function .. autofunction:: catalyst.api.schedule_function
.. autoclass:: zipline.api.date_rules .. autoclass:: catalyst.api.date_rules
:members: :members:
:undoc-members: :undoc-members:
.. autoclass:: zipline.api.time_rules .. autoclass:: catalyst.api.time_rules
:members: :members:
Orders Orders
`````` ``````
.. autofunction:: zipline.api.order .. autofunction:: catalyst.api.order
.. autofunction:: zipline.api.order_value .. autofunction:: catalyst.api.order_value
.. autofunction:: zipline.api.order_percent .. autofunction:: catalyst.api.order_percent
.. autofunction:: zipline.api.order_target .. autofunction:: catalyst.api.order_target
.. autofunction:: zipline.api.order_target_value .. autofunction:: catalyst.api.order_target_value
.. autofunction:: zipline.api.order_target_percent .. autofunction:: catalyst.api.order_target_percent
.. autoclass:: zipline.finance.execution.ExecutionStyle .. autoclass:: catalyst.finance.execution.ExecutionStyle
:members: :members:
.. autoclass:: zipline.finance.execution.MarketOrder .. autoclass:: catalyst.finance.execution.MarketOrder
.. autoclass:: zipline.finance.execution.LimitOrder .. autoclass:: catalyst.finance.execution.LimitOrder
.. autoclass:: zipline.finance.execution.StopOrder .. autoclass:: catalyst.finance.execution.StopOrder
.. autoclass:: zipline.finance.execution.StopLimitOrder .. autoclass:: catalyst.finance.execution.StopLimitOrder
.. autofunction:: zipline.api.get_order .. autofunction:: catalyst.api.get_order
.. autofunction:: zipline.api.get_open_orders .. autofunction:: catalyst.api.get_open_orders
.. autofunction:: zipline.api.cancel_order .. autofunction:: catalyst.api.cancel_order
Order Cancellation Policies Order Cancellation Policies
''''''''''''''''''''''''''' '''''''''''''''''''''''''''
.. autofunction:: zipline.api.set_cancel_policy .. autofunction:: catalyst.api.set_cancel_policy
.. autoclass:: zipline.finance.cancel_policy.CancelPolicy .. autoclass:: catalyst.finance.cancel_policy.CancelPolicy
:members: :members:
.. autofunction:: zipline.api.EODCancel .. autofunction:: catalyst.api.EODCancel
.. autofunction:: zipline.api.NeverCancel .. autofunction:: catalyst.api.NeverCancel
Assets Assets
`````` ``````
.. autofunction:: zipline.api.symbol .. autofunction:: catalyst.api.symbol
.. autofunction:: zipline.api.symbols .. autofunction:: catalyst.api.symbols
.. autofunction:: zipline.api.future_symbol .. autofunction:: catalyst.api.set_symbol_lookup_date
.. autofunction:: zipline.api.set_symbol_lookup_date .. autofunction:: catalyst.api.sid
.. autofunction:: zipline.api.sid
Trading Controls Trading Controls
```````````````` ````````````````
Zipline provides trading controls to help ensure that the algorithm is zipline provides trading controls to help ensure that the algorithm is
performing as expected. The functions help protect the algorithm from certian performing as expected. The functions help protect the algorithm from certian
bugs that could cause undesirable behavior when trading with real money. bugs that could cause undesirable behavior when trading with real money.
.. autofunction:: zipline.api.set_do_not_order_list .. autofunction:: catalyst.api.set_do_not_order_list
.. autofunction:: zipline.api.set_long_only .. autofunction:: catalyst.api.set_long_only
.. autofunction:: zipline.api.set_max_leverage .. autofunction:: catalyst.api.set_max_leverage
.. autofunction:: zipline.api.set_max_order_count .. autofunction:: catalyst.api.set_max_order_count
.. autofunction:: zipline.api.set_max_order_size .. autofunction:: catalyst.api.set_max_order_size
.. autofunction:: zipline.api.set_max_position_size .. autofunction:: catalyst.api.set_max_position_size
Simulation Parameters Simulation Parameters
````````````````````` `````````````````````
.. autofunction:: zipline.api.set_benchmark .. autofunction:: catalyst.api.set_benchmark
Commission Models Commission Models
''''''''''''''''' '''''''''''''''''
.. autofunction:: zipline.api.set_commission .. autofunction:: catalyst.api.set_commission
.. autoclass:: zipline.finance.commission.CommissionModel .. autoclass:: catalyst.finance.commission.CommissionModel
:members: :members:
.. autoclass:: zipline.finance.commission.PerShare .. autoclass:: catalyst.finance.commission.PerShare
.. autoclass:: zipline.finance.commission.PerTrade .. autoclass:: catalyst.finance.commission.PerTrade
.. autoclass:: zipline.finance.commission.PerDollar .. autoclass:: catalyst.finance.commission.PerDollar
Slippage Models Slippage Models
''''''''''''''' '''''''''''''''
.. autofunction:: zipline.api.set_slippage .. autofunction:: catalyst.api.set_slippage
.. autoclass:: zipline.finance.slippage.SlippageModel .. autoclass:: catalyst.finance.slippage.SlippageModel
:members: :members:
.. autoclass:: zipline.finance.slippage.FixedSlippage .. autoclass:: catalyst.finance.slippage.FixedSlippage
.. autoclass:: zipline.finance.slippage.VolumeShareSlippage .. autoclass:: catalyst.finance.slippage.VolumeShareSlippage
Pipeline Pipeline
```````` ````````
For more information, see :ref:`pipeline-api` Not supported yet.
.. autofunction:: zipline.api.attach_pipeline .. For more information, see :ref:`pipeline-api`
.. autofunction:: zipline.api.pipeline_output .. .. autofunction:: catalyst.api.attach_pipeline
.. .. autofunction:: catalyst.api.pipeline_output
Miscellaneous Miscellaneous
````````````` `````````````
.. autofunction:: zipline.api.record .. autofunction:: catalyst.api.record
.. autofunction:: zipline.api.get_environment .. autofunction:: catalyst.api.get_environment
.. autofunction:: zipline.api.fetch_csv .. autofunction:: catalyst.api.fetch_csv
.. _pipeline-api: .. _pipeline-api:
Pipeline API .. Pipeline API
~~~~~~~~~~~~ .. ~~~~~~~~~~~~
.. autoclass:: zipline.pipeline.Pipeline .. .. autoclass:: zipline.pipeline.Pipeline
:members: .. :members:
:member-order: groupwise .. :member-order: groupwise
.. autoclass:: zipline.pipeline.CustomFactor .. .. autoclass:: zipline.pipeline.CustomFactor
:members: .. :members:
:member-order: groupwise .. :member-order: groupwise
.. autoclass:: zipline.pipeline.filters.Filter .. .. autoclass:: zipline.pipeline.filters.Filter
:members: __and__, __or__ .. :members: __and__, __or__
:exclude-members: dtype .. :exclude-members: dtype
.. autoclass:: zipline.pipeline.factors.Factor .. .. autoclass:: zipline.pipeline.factors.Factor
:members: bottom, deciles, demean, linear_regression, pearsonr, .. :members: bottom, deciles, demean, linear_regression, pearsonr,
percentile_between, quantiles, quartiles, quintiles, rank, .. percentile_between, quantiles, quartiles, quintiles, rank,
spearmanr, top, winsorize, zscore, isnan, notnan, isfinite, eq, .. spearmanr, top, winsorize, zscore, isnan, notnan, isfinite, eq,
__add__, __sub__, __mul__, __div__, __mod__, __pow__, __lt__, .. \__add__, \__sub__, \__mul__, \__div__, \__mod__, \__pow__,
__le__, __ne__, __ge__, __gt__ .. \__lt__, \__le__, \__ne__, \__ge__, \__gt__
:exclude-members: dtype .. :exclude-members: dtype
:member-order: bysource .. :member-order: bysource
.. autoclass:: zipline.pipeline.term.Term .. .. autoclass:: zipline.pipeline.term.Term
:members: .. :members:
:exclude-members: compute_extra_rows, dependencies, inputs, mask, windowed .. :exclude-members: compute_extra_rows, dependencies, inputs, mask, windowed
.. autoclass:: zipline.pipeline.data.USEquityPricing .. .. autoclass:: zipline.pipeline.data.USEquityPricing
:members: open, high, low, close, volume .. :members: open, high, low, close, volume
:undoc-members: .. :undoc-members:
Built-in Factors .. Built-in Factors
```````````````` .. ````````````````
.. autoclass:: zipline.pipeline.factors.AverageDollarVolume .. .. autoclass:: zipline.pipeline.factors.AverageDollarVolume
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.BollingerBands .. .. autoclass:: zipline.pipeline.factors.BollingerBands
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.BusinessDaysSincePreviousEvent .. .. autoclass:: zipline.pipeline.factors.BusinessDaysSincePreviousEvent
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.BusinessDaysUntilNextEvent .. .. autoclass:: zipline.pipeline.factors.BusinessDaysUntilNextEvent
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.ExponentialWeightedMovingAverage .. .. autoclass:: zipline.pipeline.factors.ExponentialWeightedMovingAverage
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.ExponentialWeightedMovingStdDev .. .. autoclass:: zipline.pipeline.factors.ExponentialWeightedMovingStdDev
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.Latest .. .. autoclass:: zipline.pipeline.factors.Latest
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.MaxDrawdown .. .. autoclass:: zipline.pipeline.factors.MaxDrawdown
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.Returns .. .. autoclass:: zipline.pipeline.factors.Returns
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.RollingLinearRegressionOfReturns .. .. autoclass:: zipline.pipeline.factors.RollingLinearRegressionOfReturns
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.RollingPearsonOfReturns .. .. autoclass:: zipline.pipeline.factors.RollingPearsonOfReturns
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.RollingSpearmanOfReturns .. .. autoclass:: zipline.pipeline.factors.RollingSpearmanOfReturns
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.RSI .. .. autoclass:: zipline.pipeline.factors.RSI
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.SimpleMovingAverage .. .. autoclass:: zipline.pipeline.factors.SimpleMovingAverage
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.VWAP .. .. autoclass:: zipline.pipeline.factors.VWAP
:members: .. :members:
.. autoclass:: zipline.pipeline.factors.WeightedAverageValue .. .. autoclass:: zipline.pipeline.factors.WeightedAverageValue
:members: .. :members:
Pipeline Engine .. Pipeline Engine
``````````````` .. ```````````````
.. autoclass:: zipline.pipeline.engine.PipelineEngine .. .. autoclass:: zipline.pipeline.engine.PipelineEngine
:members: run_pipeline, run_chunked_pipeline .. :members: run_pipeline, run_chunked_pipeline
:member-order: bysource .. :member-order: bysource
.. autoclass:: zipline.pipeline.engine.SimplePipelineEngine .. .. autoclass:: zipline.pipeline.engine.SimplePipelineEngine
:members: __init__, run_pipeline, run_chunked_pipeline .. :members: __init__, run_pipeline, run_chunked_pipeline
:member-order: bysource .. :member-order: bysource
.. autofunction:: zipline.pipeline.engine.default_populate_initial_workspace .. .. autofunction:: zipline.pipeline.engine.default_populate_initial_workspace
Data Loaders .. Data Loaders
```````````` .. ````````````
.. autoclass:: zipline.pipeline.loaders.equity_pricing_loader.USEquityPricingLoader .. .. autoclass:: zipline.pipeline.loaders.equity_pricing_loader.USEquityPricingLoader
:members: __init__, from_files, load_adjusted_array .. :members: __init__, from_files, load_adjusted_array
:member-order: bysource .. :member-order: bysource
Asset Metadata Asset Metadata
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
.. autoclass:: zipline.assets.Asset .. autoclass:: catalyst.assets.Asset
:members: :members:
.. autoclass:: zipline.assets.Equity .. autoclass:: catalyst.assets.AssetConvertible
:members:
.. autoclass:: zipline.assets.Future
:members:
.. autoclass:: zipline.assets.AssetConvertible
:members: :members:
Trading Calendar API Trading Calendar API
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. autofunction:: zipline.utils.calendars.get_calendar .. autofunction:: catalyst.utils.calendars.get_calendar
.. autoclass:: zipline.utils.calendars.TradingCalendar .. autoclass:: catalyst.utils.calendars.TradingCalendar
:members: :members:
.. autofunction:: zipline.utils.calendars.register_calendar .. autofunction:: catalyst.utils.calendars.register_calendar
.. autofunction:: zipline.utils.calendars.register_calendar_type .. autofunction:: catalyst.utils.calendars.register_calendar_type
.. autofunction:: zipline.utils.calendars.deregister_calendar .. autofunction:: catalyst.utils.calendars.deregister_calendar
.. autofunction:: zipline.utils.calendars.clear_calendars .. autofunction:: catalyst.utils.calendars.clear_calendars
Data API Data API
~~~~~~~~ ~~~~~~~~
Writers .. Writers
``````` .. ```````
.. autoclass:: zipline.data.minute_bars.BcolzMinuteBarWriter .. .. autoclass:: zipline.data.minute_bars.BcolzMinuteBarWriter
:members: .. :members:
.. autoclass:: zipline.data.us_equity_pricing.BcolzDailyBarWriter .. .. autoclass:: zipline.data.us_equity_pricing.BcolzDailyBarWriter
:members: .. :members:
.. autoclass:: zipline.data.us_equity_pricing.SQLiteAdjustmentWriter .. .. autoclass:: zipline.data.us_equity_pricing.SQLiteAdjustmentWriter
:members: .. :members:
.. autoclass:: zipline.assets.AssetDBWriter .. .. autoclass:: zipline.assets.AssetDBWriter
:members: .. :members:
Readers .. Readers
``````` .. ```````
.. autoclass:: zipline.data.minute_bars.BcolzMinuteBarReader .. .. autoclass:: zipline.data.minute_bars.BcolzMinuteBarReader
:members: .. :members:
.. autoclass:: zipline.data.us_equity_pricing.BcolzDailyBarReader .. .. autoclass:: zipline.data.us_equity_pricing.BcolzDailyBarReader
:members: .. :members:
.. autoclass:: zipline.data.us_equity_pricing.SQLiteAdjustmentReader .. .. autoclass:: zipline.data.us_equity_pricing.SQLiteAdjustmentReader
:members: .. :members:
.. autoclass:: zipline.assets.AssetFinder .. .. autoclass:: zipline.assets.AssetFinder
:members: .. :members:
.. autoclass:: zipline.data.data_portal.DataPortal .. .. autoclass:: zipline.data.data_portal.DataPortal
:members: .. :members:
Bundles .. Bundles
``````` .. ```````
.. autofunction:: zipline.data.bundles.register .. .. autofunction:: zipline.data.bundles.register
.. autofunction:: zipline.data.bundles.ingest(name, environ=os.environ, date=None, show_progress=True) .. .. autofunction:: zipline.data.bundles.ingest(name, environ=os.environ, date=None, show_progress=True)
.. autofunction:: zipline.data.bundles.load(name, environ=os.environ, date=None) .. .. autofunction:: zipline.data.bundles.load(name, environ=os.environ, date=None)
.. autofunction:: zipline.data.bundles.unregister .. .. autofunction:: zipline.data.bundles.unregister
.. data:: zipline.data.bundles.bundles .. .. data:: zipline.data.bundles.bundles
The bundles that have been registered as a mapping from bundle name to bundle .. The bundles that have been registered as a mapping from bundle name to bundle
data. This mapping is immutable and should only be updated through .. data. This mapping is immutable and should only be updated through
:func:`~zipline.data.bundles.register` or .. :func:`~zipline.data.bundles.register` or
:func:`~zipline.data.bundles.unregister`. .. :func:`~zipline.data.bundles.unregister`.
.. autofunction:: zipline.data.bundles.yahoo_equities .. .. autofunction:: zipline.data.bundles.yahoo_equities
@@ -362,16 +356,16 @@ Utilities
Caching Caching
``````` ```````
.. autoclass:: zipline.utils.cache.CachedObject .. autoclass:: catalyst.utils.cache.CachedObject
.. autoclass:: zipline.utils.cache.ExpiringCache .. autoclass:: catalyst.utils.cache.ExpiringCache
.. autoclass:: zipline.utils.cache.dataframe_cache .. autoclass:: catalyst.utils.cache.dataframe_cache
.. autoclass:: zipline.utils.cache.working_file .. autoclass:: catalyst.utils.cache.working_file
.. autoclass:: zipline.utils.cache.working_dir .. autoclass:: catalyst.utils.cache.working_dir
Command Line Command Line
```````````` ````````````
.. autofunction:: zipline.utils.cli.maybe_show_progress .. autofunction:: catalyst.utils.cli.maybe_show_progress
+51 -161
View File
@@ -168,7 +168,7 @@ We'll start with the CLI, and introduce the ``run_algorithm()`` in the last
example of this tutorial. Some of the :doc:`example algorithms <example-algos>` example of this tutorial. Some of the :doc:`example algorithms <example-algos>`
provide instructions on how to run them both from the CLI, and using the provide instructions on how to run them both from the CLI, and using the
:func:`~catalyst.run_algorithm` function. For the third method, refer to the :func:`~catalyst.run_algorithm` function. For the third method, refer to the
corresponding section on :doc:`Catalyst & Jupyter Notebook <jupyter>` after you corresponding section on :ref:`Catalyst & Jupyter Notebook <jupyter>` after you
have assimilated the contents of this tutorial. have assimilated the contents of this tutorial.
Command line interface Command line interface
@@ -473,6 +473,7 @@ Which we execute by running:
</div> </div>
| |
There is a row for each trading day, starting on the first day of our There is a row for each trading day, starting on the first day of our
simulation Jan 1st, 2016. In the columns you can find various simulation Jan 1st, 2016. In the columns you can find various
information about the state of your algorithm. The column information about the state of your algorithm. The column
@@ -518,7 +519,7 @@ 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 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: reason you don't have it installed, you can add it by running:
.. code-block:: python .. code-block:: bash
(catalyst)$ pip install matplotlib (catalyst)$ pip install matplotlib
@@ -579,162 +580,8 @@ which you can skim through for now. A copy of this algorithm is available in
the ``examples`` directory: the ``examples`` directory:
`dual_moving_average.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/dual_moving_average.py>`_. `dual_moving_average.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/dual_moving_average.py>`_.
.. code-block:: python .. literalinclude:: ../../catalyst/examples/dual_moving_average.py
:language: python
import numpy as np
import pandas as pd
from logbook import Logger
import matplotlib.pyplot as plt
from catalyst import run_algorithm
from catalyst.api import (order, record, symbol, order_target_percent,
get_open_orders)
from catalyst.exchange.utils.stats_utils import extract_transactions
NAMESPACE = 'dual_moving_average'
log = Logger(NAMESPACE)
def initialize(context):
context.i = 0
context.asset = symbol('ltc_usd')
context.base_price = None
def handle_data(context, data):
# define the windows for the moving averages
short_window = 50
long_window = 200
# Skip as many bars as long_window to properly compute the average
context.i += 1
if context.i < long_window:
return
# Compute moving averages calling data.history() for each
# moving average with the appropriate parameters. We choose to use
# minute bars for this simulation -> freq="1m"
# Returns a pandas dataframe.
short_mavg = data.history(context.asset, 'price',
bar_count=short_window, frequency="1m").mean()
long_mavg = data.history(context.asset, 'price',
bar_count=long_window, frequency="1m").mean()
# Let's keep the price of our asset in a more handy variable
price = data.current(context.asset, 'price')
# 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
# Save values for later inspection
record(price=price,
cash=context.portfolio.cash,
price_change=price_change,
short_mavg=short_mavg,
long_mavg=long_mavg)
# 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.asset)
if len(orders) > 0:
return
# Exit if we cannot trade
if not data.can_trade(context.asset):
return
# We check what's our position on our portfolio and trade accordingly
pos_amount = context.portfolio.positions[context.asset].amount
# Trading logic
if short_mavg > long_mavg and pos_amount == 0:
# we buy 100% of our portfolio for this asset
order_target_percent(context.asset, 1)
elif short_mavg < long_mavg and pos_amount > 0:
# we sell all our positions for this asset
order_target_percent(context.asset, 0)
def analyze(context, perf):
# Get the base_currency that was passed as a parameter to the simulation
exchange = list(context.exchanges.values())[0]
base_currency = exchange.base_currency.upper()
# First chart: Plot portfolio value using base_currency
ax1 = plt.subplot(411)
perf.loc[:, ['portfolio_value']].plot(ax=ax1)
ax1.legend_.remove()
ax1.set_ylabel('Portfolio Value\n({})'.format(base_currency))
start, end = ax1.get_ylim()
ax1.yaxis.set_ticks(np.arange(start, end, (end-start)/5))
# Second chart: Plot asset price, moving averages and buys/sells
ax2 = plt.subplot(412, sharex=ax1)
perf.loc[:, ['price','short_mavg','long_mavg']].plot(ax=ax2, label='Price')
ax2.legend_.remove()
ax2.set_ylabel('{asset}\n({base})'.format(
asset = context.asset.symbol,
base = base_currency
))
start, end = ax2.get_ylim()
ax2.yaxis.set_ticks(np.arange(start, end, (end-start)/5))
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=''
)
# Third chart: Compare percentage change between our portfolio
# and the price of the asset
ax3 = plt.subplot(413, sharex=ax1)
perf.loc[:, ['algorithm_period_return', 'price_change']].plot(ax=ax3)
ax3.legend_.remove()
ax3.set_ylabel('Percent Change')
start, end = ax3.get_ylim()
ax3.yaxis.set_ticks(np.arange(start, end, (end-start)/5))
# Fourth chart: Plot our cash
ax4 = plt.subplot(414, sharex=ax1)
perf.cash.plot(ax=ax4)
ax4.set_ylabel('Cash\n({})'.format(base_currency))
start, end = ax4.get_ylim()
ax4.yaxis.set_ticks(np.arange(0, end, end/5))
plt.show()
if __name__ == '__main__':
run_algorithm(
capital_base=1000,
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-9-22', utc=True),
end=pd.to_datetime('2017-9-23', utc=True),
)
In order to run the code above, you have to ingest the needed data first: In order to run the code above, you have to ingest the needed data first:
@@ -806,6 +653,7 @@ the ``scikit-learn`` functions require ``numpy.ndarray``\ s rather than
``pandas.DataFrame``\ s, so you can simply pass the underlying ``pandas.DataFrame``\ s, so you can simply pass the underlying
``ndarray`` of a ``DataFrame`` via ``.values``). ``ndarray`` of a ``DataFrame`` via ``.values``).
.. _jupyter:
Jupyter Notebook Jupyter Notebook
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@@ -826,13 +674,13 @@ In order to use Jupyter Notebook, you first have to install it inside your
environment. It's available as ``pip`` package, so regardless of how you environment. It's available as ``pip`` package, so regardless of how you
installed Catalyst, go inside your catalyst environemnt and run: installed Catalyst, go inside your catalyst environemnt and run:
.. code:: bash .. code-block:: bash
(catalyst)$ pip install jupyter (catalyst)$ pip install jupyter
Once you have Jupyter Notebook installed, every time you want to use it run: Once you have Jupyter Notebook installed, every time you want to use it run:
.. code:: bash .. code-block:: bash
(catalyst)$ jupyter notebook (catalyst)$ jupyter notebook
@@ -846,7 +694,7 @@ Before running your algorithms inside the Jupyter Notebook, remember to ingest
the data from the command line interface (CLI). In the example below, you would the data from the command line interface (CLI). In the example below, you would
need to run first: need to run first:
.. code:: bash .. code-block:: bash
catalyst ingest-exchange -x bitfinex -i btc_usd catalyst ingest-exchange -x bitfinex -i btc_usd
@@ -16607,7 +16455,49 @@ NaN
</div> </div>
PyCharm IDE
~~~~~~~~~~~
PyCharm is an Integrated Development Environment (IDE) used in computer
programming, specifically for the Python language. It streamlines the continuos
development of Python code, and among other things includes a debugger that
comes in handy to see the inner workings of Catalyst, and your trading
algorithms.
Install
^^^^^^^
Install PyCharm from their `Website <https://www.jetbrains.com/pycharm/download/>`__.
There is a free and open-source **Community** version.
Setup
^^^^^
1. When creating a new project in PyCharm, right under you specify the Location,
click on **Project Interpreter** to display a drop down menu
2. Select **Existing interpreter**, click the gear box right next to it and
select 'add local'. Depending on your installation, select either
"*Virtual Environemnt*" or "*Conda Environment" and click the '...' button to
navigate to your catalyst env and select the Python binary file:
``bin/python`` for Linux/MacOS installations or 'python.exe' for Windows
installs (for example: 'C:\\Users\\user\\Anaconda2\\envs\\catalyst\\python.exe').
Select OK. You may want to click on *Make available to all projects* for your
future reference. Click OK again, and create your new environment using the
set up of your virtual environment.
Alternatively, if you already have your project created, in Windows do:
1. File -> Default Settings -> Project Interpreter. Click the gear box next to
the project interpreter and select add local, and follow the steps from the
second step above.
On MacOS:
1. PyCharm -> Preferences -> Settings -> Project:NAME_OF_PROJECT ->
Project Interpreter. Click the gear box next to the project interpreter
and select add local, and follow the steps from the second step above.
You should now be able to run your project/scripts in PyCharm.
Next steps Next steps
~~~~~~~~~~ ~~~~~~~~~~
+5 -2
View File
@@ -27,8 +27,8 @@ extlinks = {
# -- Docstrings --------------------------------------------------------------- # -- Docstrings ---------------------------------------------------------------
#extensions += ['numpydoc'] extensions += ['numpydoc']
#numpydoc_show_class_members = False numpydoc_show_class_members = False
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates'] templates_path = ['.templates']
@@ -97,3 +97,6 @@ intersphinx_mapping = {
doctest_global_setup = "import catalyst" doctest_global_setup = "import catalyst"
todo_include_todos = True todo_include_todos = True
suppress_warnings = ['image.nonlocal_uri']
+7 -17
View File
@@ -36,25 +36,15 @@ Finally, you can build the C extensions by running:
$ python setup.py build_ext --inplace $ python setup.py build_ext --inplace
.. To finish, make sure `tests`__ pass. Development with Docker
-----------------------
.. __ #style-guide-running-tests If you want to work with zipline using a `Docker`__ container, you'll need to
build the ``Dockerfile`` in the Zipline root directory, and then build
``Dockerfile-dev``. Instructions for building both containers can be found in
``Dockerfile`` and ``Dockerfile-dev``, respectively.
.. If you get an error running nosetests after setting up a fresh virtualenv, please try running __ https://docs.docker.com/get-started/
.. code-block
.. # where zipline is the name of your virtualenv
.. $ deactivate zipline
.. $ workon zipline
.. Development with Docker
.. -----------------------
..If you want to work with zipline using a `Docker`__ container, you'll need to build the ``Dockerfile`` in the Zipline root directory, and then build ``Dockerfile-dev``. Instructions for building both containers can be found in ``Dockerfile`` and ``Dockerfile-dev``, respectively.
.. __ https://docs.docker.com/get-started/
Git Branching Structure Git Branching Structure
----------------------- -----------------------
+18 -881
View File
@@ -1,4 +1,5 @@
| |
Example Algorithms Example Algorithms
================== ==================
@@ -51,35 +52,8 @@ Buy BTC Simple Algorithm
Source code: `examples/buy_btc_simple.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_btc_simple.py>`_ Source code: `examples/buy_btc_simple.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_btc_simple.py>`_
.. code-block:: python .. literalinclude:: ../../catalyst/examples/buy_btc_simple.py
:language: python
'''
Run this example, by executing the following from your terminal:
catalyst ingest-exchange -x bitfinex -f daily -i btc_usdt
catalyst run -f buy_btc_simple.py -x bitfinex --start 2016-1-1 --end 2017-9-30 -o buy_btc_simple_out.pickle
If you want to run this code using another exchange, make sure that
the asset is available on that exchange. For example, if you were to run
it for exchange Poloniex, you would need to edit the following line:
context.asset = symbol('btc_usdt') # note 'usdt' instead of 'usd'
and specify exchange poloniex as follows:
catalyst ingest-exchange -x poloniex -f daily -i btc_usdt
catalyst run -f buy_btc_simple.py -x poloniex --start 2016-1-1 --end 2017-9-30 -o buy_btc_simple_out.pickle
To see which assets are available on each exchange, visit:
https://www.enigma.co/catalyst/status
'''
from catalyst.api import order, record, symbol
def initialize(context):
context.asset = symbol('btc_usd')
def handle_data(context, data):
order(context.asset, 1)
record(btc = data.current(context.asset, 'price'))
This simple algorithm does not produce any output nor displays any chart. This simple algorithm does not produce any output nor displays any chart.
@@ -89,8 +63,6 @@ This simple algorithm does not produce any output nor displays any chart.
Buy and Hodl Algorithm Buy and Hodl Algorithm
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
Source code: `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: First ingest the historical pricing data needed to run this algorithm:
.. code-block:: bash .. code-block:: bash
@@ -118,157 +90,10 @@ 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 earlier date, you'll get an error), and the most recent date you can choose is
one day prior to the current date. one day prior to the current date.
Source code: `examples/buy_and_hodl.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_and_hodl.py>`_
.. code-block:: python .. literalinclude:: ../../catalyst/examples/buy_and_hodl.py
:language: 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
import matplotlib.pyplot as plt
from catalyst import run_algorithm
from catalyst.api import (order_target_value, symbol, record,
cancel_order, get_open_orders, )
def initialize(context):
context.ASSET_NAME = 'btc_usd'
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:
print('buying')
# 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,
)
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):
# 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.scatter(
buys.index.to_pydatetime(),
results.price[buys.index],
marker='^',
s=100,
c='g',
label=''
)
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()
if __name__ == '__main__':
run_algorithm(
capital_base=10000,
data_frequency='daily',
initialize=initialize,
handle_data=handle_data,
analyze=analyze,
exchange_name='bitfinex',
algo_namespace='buy_and_hodl',
base_currency='usd',
start=pd.to_datetime('2015-03-01', utc=True),
end=pd.to_datetime('2017-10-31', utc=True),
)
.. image:: https://s3.amazonaws.com/enigmaco-docs/github.io/example_buy_and_hodl.png .. image:: https://s3.amazonaws.com/enigmaco-docs/github.io/example_buy_and_hodl.png
@@ -277,166 +102,13 @@ one day prior to the current date.
Dual Moving Average Crossover Dual Moving Average Crossover
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Source Code: `examples/dual_moving_average.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/dual_moving_average.py>`_
This strategy is covered in detail in the last part of This strategy is covered in detail in the last part of
`this tutorial <beginner-tutorial.html#history>`_. `this tutorial <beginner-tutorial.html#history>`_.
.. code-block:: python Source Code: `examples/dual_moving_average.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/dual_moving_average.py>`_
import numpy as np .. literalinclude:: ../../catalyst/examples/dual_moving_average.py
import pandas as pd :language: python
from logbook import Logger
import matplotlib.pyplot as plt
from catalyst import run_algorithm
from catalyst.api import (order, record, symbol, order_target_percent,
get_open_orders)
from catalyst.exchange.stats_utils import extract_transactions
NAMESPACE = 'dual_moving_average'
log = Logger(NAMESPACE)
def initialize(context):
context.i = 0
context.asset = symbol('ltc_usd')
context.base_price = None
def handle_data(context, data):
# define the windows for the moving averages
short_window = 50
long_window = 200
# Skip as many bars as long_window to properly compute the average
context.i += 1
if context.i < long_window:
return
# Compute moving averages calling data.history() for each
# moving average with the appropriate parameters. We choose to use
# minute bars for this simulation -> freq="1m"
# Returns a pandas dataframe.
short_mavg = data.history(context.asset, 'price',
bar_count=short_window, frequency="1m").mean()
long_mavg = data.history(context.asset, 'price',
bar_count=long_window, frequency="1m").mean()
# Let's keep the price of our asset in a more handy variable
price = data.current(context.asset, 'price')
# 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
# Save values for later inspection
record(price=price,
cash=context.portfolio.cash,
price_change=price_change,
short_mavg=short_mavg,
long_mavg=long_mavg)
# 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.asset)
if len(orders) > 0:
return
# Exit if we cannot trade
if not data.can_trade(context.asset):
return
# We check what's our position on our portfolio and trade accordingly
pos_amount = context.portfolio.positions[context.asset].amount
# Trading logic
if short_mavg > long_mavg and pos_amount == 0:
# we buy 100% of our portfolio for this asset
order_target_percent(context.asset, 1)
elif short_mavg < long_mavg and pos_amount > 0:
# we sell all our positions for this asset
order_target_percent(context.asset, 0)
def analyze(context, perf):
# Get the base_currency that was passed as a parameter to the simulation
base_currency = context.exchanges.values()[0].base_currency.upper()
# First chart: Plot portfolio value using base_currency
ax1 = plt.subplot(411)
perf.loc[:, ['portfolio_value']].plot(ax=ax1)
ax1.legend_.remove()
ax1.set_ylabel('Portfolio Value\n({})'.format(base_currency))
start, end = ax1.get_ylim()
ax1.yaxis.set_ticks(np.arange(start, end, (end-start)/5))
# Second chart: Plot asset price, moving averages and buys/sells
ax2 = plt.subplot(412, sharex=ax1)
perf.loc[:, ['price','short_mavg','long_mavg']].plot(ax=ax2, label='Price')
ax2.legend_.remove()
ax2.set_ylabel('{asset}\n({base})'.format(
asset = context.asset.symbol,
base = base_currency
))
start, end = ax2.get_ylim()
ax2.yaxis.set_ticks(np.arange(start, end, (end-start)/5))
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=''
)
# Third chart: Compare percentage change between our portfolio
# and the price of the asset
ax3 = plt.subplot(413, sharex=ax1)
perf.loc[:, ['algorithm_period_return', 'price_change']].plot(ax=ax3)
ax3.legend_.remove()
ax3.set_ylabel('Percent Change')
start, end = ax3.get_ylim()
ax3.yaxis.set_ticks(np.arange(start, end, (end-start)/5))
# Fourth chart: Plot our cash
ax4 = plt.subplot(414, sharex=ax1)
perf.cash.plot(ax=ax4)
ax4.set_ylabel('Cash\n({})'.format(base_currency))
start, end = ax4.get_ylim()
ax4.yaxis.set_ticks(np.arange(0, end, end/5))
plt.show()
if __name__ == '__main__':
run_algorithm(
capital_base=1000,
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-9-22', utc=True),
end=pd.to_datetime('2017-9-23', utc=True),
)
.. image:: https://s3.amazonaws.com/enigmaco-docs/github.io/tutorial_dual_moving_average.png .. image:: https://s3.amazonaws.com/enigmaco-docs/github.io/tutorial_dual_moving_average.png
@@ -446,8 +118,6 @@ This strategy is covered in detail in the last part of
Mean Reversion Algorithm Mean Reversion Algorithm
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
Source code: `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 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. up quickly, we're going to buy; when it goes down quickly, we're going to sell.
Hopefully, we'll ride the waves. Hopefully, we'll ride the waves.
@@ -468,284 +138,10 @@ lines 218-245, so in order to run the algorithm we just type:
python mean_reversion_simple.py python mean_reversion_simple.py
.. code-block:: python Source code: `examples/mean_reversion_simple.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/mean_reversion_simple.py>`_
import os .. literalinclude:: ../../catalyst/examples/mean_reversion_simple.py
import tempfile :language: python
import time
import numpy as np
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.
from catalyst.utils.paths import ensure_directory
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 Neo in USD.
context.neo_eth = symbol('neo_usd')
context.base_price = None
context.current_day = None
context.RSI_OVERSOLD = 30
context.RSI_OVERBOUGHT = 80
context.CANDLE_SIZE = '15T'
context.start_time = time.time()
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_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.neo_eth,
fields='close',
bar_count=50,
frequency=context.CANDLE_SIZE
)
# 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_eth, 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_eth)
if len(orders) > 0:
return
# Exit if we cannot trade
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.neo_eth].amount
if rsi[-1] <= context.RSI_OVERSOLD and pos_amount == 0:
log.info(
'{}: buying - price: {}, rsi: {}'.format(
data.current_dt, price, rsi[-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] >= context.RSI_OVERBOUGHT and pos_amount > 0:
log.info(
'{}: selling - price: {}, rsi: {}'.format(
data.current_dt, price, rsi[-1]
)
)
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):
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()
# Plot the portfolio value over time.
ax1 = plt.subplot(611)
perf.loc[:, 'portfolio_value'].plot(ax=ax1)
ax1.set_ylabel('Portfolio\nValue\n({})'.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}\n({base})'.format(
asset=context.neo_eth.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.floor('1 min'), 'price'],
marker='^',
s=100,
c='green',
label=''
)
ax2.scatter(
sell_df.index.to_pydatetime(),
perf.loc[sell_df.index.floor('1 min'), '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\n({})'.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\nChange')
ax6 = plt.subplot(615, sharex=ax1)
perf.loc[:, 'rsi'].plot(ax=ax6, label='RSI')
ax6.set_ylabel('RSI')
ax6.axhline(context.RSI_OVERBOUGHT, color='darkgoldenrod')
ax6.axhline(context.RSI_OVERSOLD, color='darkgoldenrod')
if not transaction_df.empty:
ax6.scatter(
buy_df.index.to_pydatetime(),
perf.loc[buy_df.index.floor('1 min'), 'rsi'],
marker='^',
s=100,
c='green',
label=''
)
ax6.scatter(
sell_df.index.to_pydatetime(),
perf.loc[sell_df.index.floor('1 min'), 'rsi'],
marker='v',
s=100,
c='red',
label=''
)
plt.legend(loc=3)
start, end = ax6.get_ylim()
ax6.yaxis.set_ticks(np.arange(0, end, end/5))
# 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':
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 bitfinex -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-01', 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='bittrex',
live=True,
algo_namespace=NAMESPACE,
base_currency='usd',
live_graph=False
)
.. image:: https://s3.amazonaws.com/enigmaco-docs/github.io/example_mean_reversion_simple.png .. image:: https://s3.amazonaws.com/enigmaco-docs/github.io/example_mean_reversion_simple.png
@@ -762,8 +158,6 @@ strategy.
Simple Universe Simple Universe
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
Source code: `examples/simple_universe.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/simple_universe.py>`_
This example aims to provide an easy way for users to learn how to This example aims to provide an easy way for users to learn how to
collect data from any given exchange and select a subset of the available collect data from any given exchange and select a subset of the available
currency pairs for trading. You simply need to specify the exchange and currency pairs for trading. You simply need to specify the exchange and
@@ -790,142 +184,10 @@ of the file:
catalyst ingest-exchange -x bitfinex -f minute catalyst ingest-exchange -x bitfinex -f minute
.. code-block:: bash Source code: `examples/simple_universe.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/simple_universe.py>`_
python simple_universe.py
Credits: This code was originally submitted by `Abner Ayala-Acevedo
<https://github.com/abnera>`_. Thank you!
.. code-block:: python
from datetime import timedelta
import numpy as np
import pandas as pd
from catalyst import run_algorithm
from catalyst.exchange.exchange_utils import get_exchange_symbols
from catalyst.api import (symbols, )
def initialize(context):
context.i = -1 # minute counter
context.exchange = context.exchanges.values()[0].name.lower()
context.base_currency = context.exchanges.values()[0].base_currency.lower()
def handle_data(context, data):
context.i += 1
lookback_days = 7 # 7 days
# current date & time in each iteration formatted into a string
now = data.current_dt
date, time = now.strftime('%Y-%m-%d %H:%M:%S').split(' ')
lookback_date = now - timedelta(days=lookback_days)
# keep only the date as a string, discard the time
lookback_date = lookback_date.strftime('%Y-%m-%d %H:%M:%S').split(' ')[0]
one_day_in_minutes = 1440 # 60 * 24 assumes data_frequency='minute'
# update universe everyday at midnight
if not context.i % one_day_in_minutes:
context.universe = universe(context, lookback_date, date)
# get data every 30 minutes
minutes = 30
# get lookback_days of history data: that is 'lookback' number of bins
lookback = one_day_in_minutes / minutes * lookback_days
if not context.i % minutes and context.universe:
# we iterate for every pair in the current universe
for coin in context.coins:
pair = str(coin.symbol)
# Get 30 minute interval OHLCV data. This is the standard data
# required for candlestick or indicators/signals. Return Pandas
# DataFrames. 30T means 30-minute re-sampling of one minute data.
# Adjust it to your desired time interval as needed.
opened = fill(data.history(coin, 'open',
bar_count=lookback, frequency='30T')).values
high = fill(data.history(coin, 'high',
bar_count=lookback, frequency='30T')).values
low = fill(data.history(coin, 'low',
bar_count=lookback, frequency='30T')).values
close = fill(data.history(coin, 'price',
bar_count=lookback, frequency='30T')).values
volume = fill(data.history(coin, 'volume',
bar_count=lookback, frequency='30T')).values
# close[-1] is the last value in the set, which is the equivalent
# to current price (as in the most recent value)
# displays the minute price for each pair every 30 minutes
print('{now}: {pair} -\tO:{o},\tH:{h},\tL:{c},\tC{c},\tV:{v}'.format(
now=now,
pair=pair,
o=opened[-1],
h=high[-1],
l=low[-1],
c=close[-1],
v=volume[-1],
))
# -------------------------------------------------------------
# --------------- Insert Your Strategy Here -------------------
# -------------------------------------------------------------
def analyze(context=None, results=None):
pass
# Get the universe for a given exchange and a given base_currency market
# Example: Poloniex BTC Market
def universe(context, lookback_date, current_date):
# get all the pairs for the given exchange
json_symbols = get_exchange_symbols(context.exchange)
# convert into a DataFrame for easier processing
df = pd.DataFrame.from_dict(json_symbols).transpose().astype(str)
df['base_currency'] = df.apply(lambda row: row.symbol.split('_')[1],axis=1)
df['market_currency'] = df.apply(lambda row: row.symbol.split('_')[0],axis=1)
# Filter all the pairs to get only the ones for a given base_currency
df = df[df['base_currency'] == context.base_currency]
# Filter all the pairs to ensure that pair existed in the current date range
df = df[df.start_date < lookback_date]
df = df[df.end_daily >= current_date]
context.coins = symbols(*df.symbol) # convert all the pairs to symbols
return df.symbol.tolist()
# Replace all NA, NAN or infinite values with its nearest value
def fill(series):
if isinstance(series, pd.Series):
return series.replace([np.inf, -np.inf], np.nan).ffill().bfill()
elif isinstance(series, np.ndarray):
return pd.Series(series).replace(
[np.inf, -np.inf], np.nan
).ffill().bfill().values
else:
return series
if __name__ == '__main__':
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,
capital_base=100.0, # amount of base_currency
initialize=initialize,
handle_data=handle_data,
analyze=analyze,
exchange_name='bitfinex',
data_frequency='minute',
base_currency='btc',
live=False,
live_graph=False,
algo_namespace='simple_universe')
.. literalinclude:: ../../catalyst/examples/simple_universe.py
:language: python
.. _portfolio_optimization: .. _portfolio_optimization:
@@ -939,135 +201,10 @@ use 180 days of historical data and rebalance every 30 days. This code was used
in writting the following article: in writting the following article:
`Markowitz Portfolio Optimization for Cryptocurrencies <https://blog.enigma.co/markowitz-portfolio-optimization-for-cryptocurrencies-in-catalyst-b23c38652556>`_. `Markowitz Portfolio Optimization for Cryptocurrencies <https://blog.enigma.co/markowitz-portfolio-optimization-for-cryptocurrencies-in-catalyst-b23c38652556>`_.
.. code-block:: python Source code: `examples/simple_universe.py <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/portfolio_optimization.py>`_
''' .. literalinclude:: ../../catalyst/examples/portfolio_optimization.py
You can run this code using the Python interpreter: :language: python
$ python portfolio_optimization.py
'''
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='1d')
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, )
.. image:: https://cdn-images-1.medium.com/max/1600/0*EjjiKZHlYF3sn7yQ. .. image:: https://cdn-images-1.medium.com/max/1600/0*EjjiKZHlYF3sn7yQ.
:align: center :align: center
+2
View File
@@ -1,6 +1,8 @@
.. include:: ../../README.rst .. include:: ../../README.rst
| |
| |
Table of Contents Table of Contents
----------------- -----------------
+42 -12
View File
@@ -47,8 +47,10 @@ you can install MiniConda, which is a smaller footprint (fewer packages and
smaller size) than its big brother Anaconda, but it still contains all the smaller size) than its big brother Anaconda, but it still contains all the
main packages needed. To install MiniConda, you can follow these steps: main packages needed. To install MiniConda, you can follow these steps:
1. Download `MiniConda <https://conda.io/miniconda.html>`_. Select Python 2.7 1. Download `MiniConda <https://conda.io/miniconda.html>`_. Select either
for your Operating System. Python 3.6 (recommended) or Python 2.7 for your Operating System. The
`Enigma Data Marketplace <https://enigmampc.github.io/marketplace/>`_ will
require Python3, that's why we are recommending to opt for the newer version.
2. Install MiniConda. See the `Installation Instructions 2. Install MiniConda. See the `Installation Instructions
<https://conda.io/docs/user-guide/install/index.html>`_ if you need help. <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 3. Ensure the correct installation by running ``conda list`` in a Terminal
@@ -64,18 +66,27 @@ main packages needed. To install MiniConda, you can follow these steps:
Once either Conda or MiniConda has been set up you can install Catalyst: Once either Conda or MiniConda has been set up you can install Catalyst:
1. Download the file `python2.7-environment.yml 1. Download the file `python3.6-environment.yml
<https://github.com/enigmampc/catalyst/blob/master/etc/python2.7-environment.yml>`_. <https://github.com/enigmampc/catalyst/blob/master/etc/python3.6-environment.yml>`_
(recommended) or `python2.7-environment.yml
<https://github.com/enigmampc/catalyst/blob/master/etc/python2.7-environment.yml>`_
matching your Conda installation from step #1 above.
To download, simply click on the 'Raw' button and save the file locally 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 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. ``.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 2. Open a Terminal window and enter [``cd/dir``] into the directory where you
saved the above ``python2.7-environment.yml`` file. saved the above ``.yml`` file.
3. Install using this file. This step can take about 5-10 minutes to install. 3. Install using this file. This step can take about 5-10 minutes to install.
.. code-block:: bash
conda env create -f python3.6-environment.yml
or
.. code-block:: bash .. code-block:: bash
conda env create -f python2.7-environment.yml conda env create -f python2.7-environment.yml
@@ -122,6 +133,14 @@ with the following steps:
2. Create the environment: 2. Create the environment:
for python 2.7:
.. code-block:: bash
conda create --name catalyst python=2.7 scipy zlib
or for python 3.6:
.. code-block:: bash .. code-block:: bash
conda create --name catalyst python=2.7 scipy zlib conda create --name catalyst python=2.7 scipy zlib
@@ -298,7 +317,7 @@ Troubleshooting ``pip`` Install
.. _pipenv: .. _pipenv:
Installing with ``pipenv`` Installing with ``pipenv``
------------------------- --------------------------
Installing Catalyst via ``pipenv`` is perhaps easier that installing it via Installing Catalyst via ``pipenv`` is perhaps easier that installing it via
``pip`` itself but you need to install ``pipenv`` first via ``pip``. ``pip`` itself but you need to install ``pipenv`` first via ``pip``.
@@ -443,12 +462,22 @@ about matplotlib backends, please refer to the
Windows Requirements Windows Requirements
-------------------- --------------------
In Windows, you will first need to install the `Microsoft Visual C++ Compiler In Windows, you will first need to install the Microsoft Visual C++ Compiler,
for Python 2.7 which is different depending on the version of Python that you plan to use:
<https://www.microsoft.com/en-us/download/details.aspx?id=44266>`_. This
package contains the compiler and the set of system headers necessary for * Python 3.5, 3.6: `Visual C++ 2015 Build Tools
producing binary wheels for Python 2.7 packages. If it's not already in your <http://landinghub.visualstudio.com/visual-cpp-build-tools>`_,
system, download it and install it before proceeding to the next step. which installs Visual C++ version 14.0. **This is the recommended version**
* Python 2.7: `Microsoft Visual C++ Compiler for Python 2.7
<https://www.microsoft.com/en-us/download/details.aspx?id=44266>`_, which
installs version Visual C++ version 9.0
This package contains the compiler and the set of system headers necessary for
producing binary wheels for Python packages. If it's not already in your
system, download it and install it before proceeding to the next step. If you
need additional help, or are looking for other versions of Visual C++ for
Windows (only advanced users), follow `this link <https://wiki.python.org/moin/WindowsCompilers>`_.
Once you have the above compiler installed, the easiest and best supported way 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 to install Catalyst in Windows is to use :ref:`Conda <conda>`. If you didn't
@@ -476,6 +505,7 @@ mentioned above are as follows:
default you get 0 as the Value Data) default you get 0 as the Value Data)
| |
- **The installer has encountered an unexpected error installing this package. - **The installer has encountered an unexpected error installing this package.
This may indicate a problem with this package. The error code is 2503.** This may indicate a problem with this package. The error code is 2503.**
+29 -11
View File
@@ -30,22 +30,24 @@ Paper Trading vs Live Trading modes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Catalyst currently supports three different modes in which you can execute your Catalyst currently supports three different modes in which you can execute your
trading algorithm. The first is backtesting, which is covered extensively in the trading algorithm. The first is **backtesting**, which is covered extensively in
tutorial, and uses historical data to run your algorithm. There is no the tutorial, and uses historical data to run your algorithm. There is no
interaction with the exchange in backtesting mode, and this is the first mode interaction with the exchange in backtesting mode, and this is the first mode
that you should test any new algorithm. that you should test any new algorithm.
Once you are confident with the simulations that you have obtained with your Once you are confident with the simulations that you have obtained with your
algorithm in backtesting, you may switch to live trading, where you have two algorithm in backtesting, you may switch to live trading, where you have two
different modes: different modes:
* *Paper Trading*: The simulated algorithm runs in real time, and fetches
pricing data in real time from the exchange, but the orders never reach the * **Paper Trading**: The simulated algorithm runs in real time, and fetches
exchange, and are instead kept within Catalyst and simulated. No real currency pricing data in real time from the exchange, but the orders never reach the
is bought or sold. Think of it as a `backtesting happening in real time`. exchange, and are instead kept within Catalyst and simulated. No real currency
* *Live Trading*: This is the proper live trading mode in which an algorithm is bought or sold. Think of it as a `backtesting happening in real time`.
runs in real time, fetching pricing data from live exchanges and placing orders
against the exchange. Real currency is transacted on the exchange driven by the * **Live Trading**: This is the proper live trading mode in which an algorithm
algorithm. runs in real time, fetching pricing data from live exchanges and placing
orders against the exchange. Real currency is transacted on the exchange
driven by the algorithm.
These three modes are controlled by the following variables: These three modes are controlled by the following variables:
@@ -113,7 +115,7 @@ Currency symbols (e.g. btc, eth, ltc) follow the Bittrex convention.
Here are some examples: Here are some examples:
.. code-block:: json .. code:: python
# With Bitfinex # With Bitfinex
bitcoin_usd_asset = symbol('btc_usd') bitcoin_usd_asset = symbol('btc_usd')
@@ -174,6 +176,22 @@ Here is the breakdown of the new arguments:
- ``simulate_orders``: Enables the paper trading mode, in which orders are - ``simulate_orders``: Enables the paper trading mode, in which orders are
simulated in Catalyst instead of processed on the exchange. It defaults to simulated in Catalyst instead of processed on the exchange. It defaults to
``True``. ``True``.
- ``end_date``: When setting the end_date to a time in the **future**,
it will schedule the live algo to finish gracefully at the specified date.
- ``start_date``: (**Will be implemented in the future**)
The live algo starts by default in the present, as mentioned above.
by setting the start_date to a time in the future, the algorithm would
essentially sleep and when the predefined time comes, it would start executing.
The `catalyst live` command offers additional parameters.
You can learn more by running the following from the command line:
.. code-block:: bash
catalyst live --help
Here is a complete algorithm for reference: Here is a complete algorithm for reference:
`Buy Low and Sell High <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_low_sell_high_live.py>`_ `Buy Low and Sell High <https://github.com/enigmampc/catalyst/blob/master/catalyst/examples/buy_low_sell_high_live.py>`_
+32
View File
@@ -2,6 +2,38 @@
Release Notes Release Notes
============= =============
Version 0.5.3
^^^^^^^^^^^^^
**Release Date**: 2018-02-09
Bug Fixes
~~~~~~~~~
- Fixed an issue with last candle in backtesting :issue:`219`
Version 0.5.2
^^^^^^^^^^^^^
**Release Date**: 2018-02-08
Bug Fixes
~~~~~~~~~
- Fixed an issue with live candle values :issue:`216` and :issue:`199`
Version 0.5.1
^^^^^^^^^^^^^
**Release Date**: 2018-02-07
Bug Fixes
~~~~~~~~~
- Fixed an issue with orders that stay open :issue:`211`
- Fixed Jupyter issues :issue:`179`
- Fetching multiple tickers in one call to minimize rate limit risks :issue:`174`
- Improved live state presentation :issue:`171`
Build
~~~~~
- Introducing the Enigma Marketplace
Version 0.4.7 Version 0.4.7
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
**Release Date**: 2018-01-19 **Release Date**: 2018-01-19
+5
View File
@@ -11,6 +11,7 @@ Installation: MacOS
| |
| |
Installation: Windows Installation: Windows
--------------------- ---------------------
@@ -21,6 +22,7 @@ Where things go smoothly:
<iframe width="560" height="315" src="https://www.youtube.com/embed/H8HqcEbZmkk" frameborder="0" allowfullscreen></iframe> <iframe width="560" height="315" src="https://www.youtube.com/embed/H8HqcEbZmkk" frameborder="0" allowfullscreen></iframe>
| |
Where things don't: Where things don't:
.. raw:: html .. raw:: html
@@ -29,6 +31,7 @@ Where things don't:
| |
| |
Backtesting a Strategy Backtesting a Strategy
---------------------- ----------------------
@@ -44,6 +47,7 @@ sell. Hopefully, well ride the waves.
| |
| |
Live Trading a Strategy Live Trading a Strategy
----------------------- -----------------------
@@ -54,5 +58,6 @@ in the previous video, we now take it to trade live against the Bittrex exchange
.. raw:: html .. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/NupiE-Xuglw" frameborder="0" allowfullscreen></iframe> <iframe width="560" height="315" src="https://www.youtube.com/embed/NupiE-Xuglw" frameborder="0" allowfullscreen></iframe>
| |
| |
+1 -1
View File
@@ -16,4 +16,4 @@ fi
jupyter notebook -y --no-browser --notebook-dir=${PROJECT_DIR} \ jupyter notebook -y --no-browser --notebook-dir=${PROJECT_DIR} \
--certfile=${SSL_CERT_PEM} --keyfile=${SSL_CERT_KEY} --ip='*' \ --certfile=${SSL_CERT_PEM} --keyfile=${SSL_CERT_KEY} --ip='*' \
--config=${CONFIG_PATH} --config=${CONFIG_PATH} --allow-root
+8 -2
View File
@@ -1,9 +1,11 @@
name: catalyst name: catalyst
channels: channels:
- defaults - defaults
- conda-forge
dependencies: dependencies:
- certifi=2016.2.28=py27_0 - certifi=2016.2.28=py27_0
- mkl=2017.0.3 - mkl=2017.0.3
- matplotlib=2.1.2=py36_0
- numpy=1.13.1=py27_0 - numpy=1.13.1=py27_0
- openssl=1.0.2l - openssl=1.0.2l
- pip=9.0.1=py27_1 - pip=9.0.1=py27_1
@@ -20,7 +22,11 @@ dependencies:
- bcolz==0.12.1 - bcolz==0.12.1
- bottleneck==1.2.1 - bottleneck==1.2.1
- chardet==3.0.4 - chardet==3.0.4
- ccxt==1.10.774 - ccxt==1.10.1094
# The Enigma Data Marketplace requires Python3 because it depends on
# web3, which requires Python3, as building its dependencies breaks in Python2
# - web3==4.0.0b7
- requests-toolbelt==0.8.0
- click==6.7 - click==6.7
- contextlib2==0.5.5 - contextlib2==0.5.5
- cycler==0.10.0 - cycler==0.10.0
@@ -57,4 +63,4 @@ dependencies:
- tables==3.4.2 - tables==3.4.2
- toolz==0.8.2 - toolz==0.8.2
- urllib3==1.22 - urllib3==1.22
- enigma-catalyst>=0.3 - enigma-catalyst>=0.5
+90
View File
@@ -0,0 +1,90 @@
name: catalyst
channels:
- defaults
- conda-forge
dependencies:
- ca-certificates=2017.08.26
- certifi=2018.1.18
- intel-openmp=2018.0.0
- mkl=2018.0.1
- numpy=1.14.0
- openssl=1.0.2n
- matplotlib=2.1.2=py36_0
- pip=9.0.1
- python=3.6.4
- scipy=1.0.0
- setuptools=38.4.0=py36_0
- sqlite=3.22.0
- tk=8.6.7
- wheel=0.30.0
- xz=5.2.3
- zlib=1.2.11
- pip:
- aiodns==1.1.1
- aiohttp==3.0.1
- alembic==0.9.7
- async-timeout==2.0.0
- attrdict==2.0.0
- attrs==17.4.0
- bcolz==0.12.1
- boto3==1.5.27
- botocore==1.8.41
- bottleneck==1.2.1
- cchardet==2.1.1
- ccxt==1.10.1102
- chardet==3.0.4
- click==6.7
- contextlib2==0.5.5
- cyordereddict==1.0.0
- cython==0.27.3
- cytoolz==0.9.0
- decorator==4.2.1
- docutils==0.14
- empyrical==0.2.1
- enigma-catalyst>=0.5.3
- eth-abi==1.0.0b0
- eth-account==0.1.0a2
- eth-keyfile==0.5.1
- eth-keys==0.2.0b1
- eth-rlp==0.1.0a2
- eth-utils==1.0.0b1
- hexbytes==0.1.0b0
- idna==2.6
- idna-ssl==1.0.0
- intervaltree==2.1.0
- jmespath==0.9.3
- logbook==1.2.1
- lru-dict==1.1.6
- lxml==4.1.1
- mako==1.0.7
- markupsafe==1.0
- multidict==4.1.0
- multipledispatch==0.4.9
- networkx==2.1
- numexpr==2.6.4
- pandas==0.19.2
- pandas-datareader==0.6.0
- patsy==0.5.0
- pycares==2.3.0
- pycryptodome==3.4.11
- pysha3==1.0.2
- python-dateutil==2.6.1
- python-editor==1.0.3
- pytz==2018.3
- redo==1.6
- requests==2.18.4
- requests-file==1.4.3
- requests-ftp==0.3.1
- requests-toolbelt==0.8.0
- rlp==0.6.0
- s3transfer==0.1.12
- six==1.11.0
- sortedcontainers==1.5.9
- sqlalchemy==1.2.2
- statsmodels==0.8.0
- tables==3.4.2
- toolz==0.9.0
- urllib3==1.22
- web3==4.0.0b9
- wrapt==1.10.11
- yarl==1.1.0
+3 -1
View File
@@ -81,6 +81,8 @@ empyrical==0.2.1
tables==3.3.0 tables==3.3.0
#Catalyst dependencies #Catalyst dependencies
ccxt==1.10.774 ccxt==1.10.1094
boto3==1.4.8 boto3==1.4.8
redo==1.6 redo==1.6
web3==4.0.0b11; python_version > '3.4'
requests-toolbelt==0.8.0
+1 -1
View File
@@ -16,7 +16,7 @@ babel==1.3
docutils==0.12 docutils==0.12
snowballstemmer==1.2.0 snowballstemmer==1.2.0
sphinx-rtd-theme==0.1.8 sphinx-rtd-theme==0.1.8
sphinx==1.3.4 sphinx==1.6.7
pbr==1.10.0 pbr==1.10.0
mock==2.0.0 mock==2.0.0
+1 -1
View File
@@ -1,4 +1,4 @@
Sphinx>=1.3.2 Sphinx==1.6.7
numpydoc>=0.5.0 numpydoc>=0.5.0
sphinx-autobuild==0.6.0 sphinx-autobuild==0.6.0
docutils==0.12 docutils==0.12
+16 -11
View File
@@ -1,8 +1,7 @@
import pandas as pd import pandas as pd
from logbook import Logger from logbook import Logger
from catalyst.testing import ZiplineTestCase from catalyst.exchange.utils.stats_utils import set_print_settings
from catalyst.testing.fixtures import WithLogger
from .base import BaseExchangeTestCase from .base import BaseExchangeTestCase
from catalyst.exchange.ccxt.ccxt_exchange import CCXT from catalyst.exchange.ccxt.ccxt_exchange import CCXT
from catalyst.exchange.exchange_execution import ExchangeLimitOrder from catalyst.exchange.exchange_execution import ExchangeLimitOrder
@@ -15,23 +14,23 @@ log = Logger('test_ccxt')
class TestCCXT(BaseExchangeTestCase): class TestCCXT(BaseExchangeTestCase):
@classmethod @classmethod
def setup(self): def setup(self):
exchange_name = 'bitfinex' exchange_name = 'bittrex'
auth = get_exchange_auth(exchange_name) auth = get_exchange_auth(exchange_name)
self.exchange = CCXT( self.exchange = CCXT(
exchange_name=exchange_name, exchange_name=exchange_name,
key=auth['key'], key=auth['key'],
secret=auth['secret'], secret=auth['secret'],
base_currency='bnb', base_currency='usdt',
) )
self.exchange.init() self.exchange.init()
def test_order(self): def test_order(self):
log.info('creating order') log.info('creating order')
asset = self.exchange.get_asset('neo_bnb') asset = self.exchange.get_asset('eth_usdt')
order_id = self.exchange.order( order_id = self.exchange.order(
asset=asset, asset=asset,
style=ExchangeLimitOrder(limit_price=10), style=ExchangeLimitOrder(limit_price=1000),
amount=1, amount=1.01,
) )
log.info('order created {}'.format(order_id)) log.info('order created {}'.format(order_id))
assert order_id is not None assert order_id is not None
@@ -58,24 +57,30 @@ class TestCCXT(BaseExchangeTestCase):
def test_get_candles(self): def test_get_candles(self):
log.info('retrieving candles') log.info('retrieving candles')
candles = self.exchange.get_candles( candles = self.exchange.get_candles(
freq='30T', freq='1T',
assets=[self.exchange.get_asset('eth_btc')], assets=[self.exchange.get_asset('eth_btc')],
bar_count=200, bar_count=200,
start_dt=pd.to_datetime('2017-09-01', utc=True) # start_dt=pd.to_datetime('2017-09-01', utc=True),
) )
for asset in candles: for asset in candles:
df = pd.DataFrame(candles[asset]) df = pd.DataFrame(candles[asset])
df.set_index('last_traded', drop=True, inplace=True) df.set_index('last_traded', drop=True, inplace=True)
set_print_settings()
print('got {} candles'.format(len(df)))
print(df.head(10))
print(df.tail(10))
pass pass
def test_tickers(self): def test_tickers(self):
log.info('retrieving tickers') log.info('retrieving tickers')
assets = [ assets = [
self.exchange.get_asset('iot_usd'), self.exchange.get_asset('ada_eth'),
self.exchange.get_asset('zrx_eth'),
] ]
tickers = self.exchange.tickers(assets) tickers = self.exchange.tickers(assets)
assert len(tickers) == 1 assert len(tickers) == 2
pass pass
def test_my_trades(self): def test_my_trades(self):
+175
View File
@@ -0,0 +1,175 @@
from catalyst.exchange.utils.exchange_utils import transform_candles_to_df, \
forward_fill_df_if_needed, get_candles_df
from catalyst.testing.fixtures import WithLogger, ZiplineTestCase
from datetime import timedelta
from pandas import Timestamp, DataFrame, concat
import numpy as np
class TestExchangeUtils(WithLogger, ZiplineTestCase):
@classmethod
def get_specific_field_from_df(cls, df, field, asset):
new_df = DataFrame(df[field])
new_df.columns = [asset]
new_df.index.name = None
return new_df
@classmethod
def verify_forward_fill_df_if_needed(cls, candles, periods, expected_df):
observed_df = forward_fill_df_if_needed(
transform_candles_to_df(candles),
periods)
assert (expected_df.equals(observed_df))
@classmethod
def verify_get_candles_df(cls, assets, candles, end_fixed_dt,
expected_df, check_next_candle=False):
# run on all the fields
for field in ['volume', 'open', 'close', 'high', 'low']:
field_dt = cls.get_specific_field_from_df(expected_df,
field,
assets[0])
# run on several timestamps
for delta in range(5):
end_dt = end_fixed_dt + timedelta(minutes=delta)
assert (field_dt.equals(get_candles_df({assets[0]: candles},
field, '5T', 3,
end_dt=end_dt)))
field_dt_a1 = cls.get_specific_field_from_df(expected_df,
field,
assets[0])
field_dt_a2 = cls.get_specific_field_from_df(expected_df,
field,
assets[1])
observed_df = get_candles_df({assets[0]: candles,
assets[1]: candles},
field, '5T', 3,
end_dt=end_dt)
assert (observed_df.equals(concat([field_dt_a1, field_dt_a2],
axis=1)))
if check_next_candle:
# one candle forward
end_dt = end_fixed_dt + timedelta(minutes=6)
observed_df = get_candles_df({assets[0]: candles,
assets[1]: candles},
field, '5T', 3,
end_dt=end_dt)
assert (not observed_df.equals(concat([field_dt_a1,
field_dt_a2],
axis=1)))
assert (concat([field_dt_a1, field_dt_a2],
axis=1)[1:].equals(observed_df[:-1]))
def test_get_candles_df(self):
assets = ['btc_usdt', 'eth_usdt']
# test forward fill in the end
candles = [{'high': 595, 'volume': 10, 'low': 594,
'close': 595, 'open': 594,
'last_traded': Timestamp('2018-03-01 09:45:00+0000',
tz='UTC')
},
{'high': 594, 'volume': 108, 'low': 592,
'close': 593, 'open': 592,
'last_traded': Timestamp('2018-03-01 09:50:00+0000',
tz='UTC')
}]
expected = [{'high': 595.0, 'volume': 10.0, 'low': 594.0,
'close': 595.0, 'open': 594.0,
'last_traded': Timestamp('2018-03-01 09:45:00+0000',
tz='UTC')
},
{'high': 594.0, 'volume': 108.0, 'low': 592.0,
'close': 593.0, 'open': 592.0,
'last_traded': Timestamp('2018-03-01 09:50:00+0000',
tz='UTC')
},
{'high': 593.0, 'volume': 0.0, 'low': 593.0,
'close': 593.0, 'open': 593.0,
'last_traded': Timestamp('2018-03-01 09:55:00+0000',
tz='UTC')
}]
periods = [Timestamp('2018-03-01 09:45:00+0000', tz='UTC'),
Timestamp('2018-03-01 09:50:00+0000', tz='UTC'),
Timestamp('2018-03-01 09:55:00+0000', tz='UTC')]
expected_df = transform_candles_to_df(expected)
self.verify_forward_fill_df_if_needed(candles, periods,
expected_df)
self.verify_get_candles_df(assets, candles, periods[2],
expected_df, True)
# test forward fill in the middle
candles = [{'high': 595, 'volume': 10, 'low': 594,
'close': 595, 'open': 594,
'last_traded': Timestamp('2018-03-01 09:45:00+0000',
tz='UTC')
},
{'high': 594, 'volume': 108, 'low': 592,
'close': 593, 'open': 592,
'last_traded': Timestamp('2018-03-01 09:55:00+0000',
tz='UTC')
}]
expected = [{'high': 595.0, 'volume': 10.0, 'low': 594.0,
'close': 595.0, 'open': 594.0,
'last_traded': Timestamp('2018-03-01 09:45:00+0000',
tz='UTC')
},
{'high': 595.0, 'volume': 0.0, 'low': 595.0,
'close': 595.0, 'open': 595.0,
'last_traded': Timestamp('2018-03-01 09:50:00+0000',
tz='UTC')
},
{'high': 594.0, 'volume': 108.0, 'low': 592.0,
'close': 593.0, 'open': 592.0,
'last_traded': Timestamp('2018-03-01 09:55:00+0000',
tz='UTC')
}]
expected_df = transform_candles_to_df(expected)
self.verify_forward_fill_df_if_needed(candles, periods, expected_df)
self.verify_get_candles_df(assets, candles, periods[2], expected_df)
# test "forward fill" at the beginning
candles = [{'high': 595, 'volume': 10, 'low': 594,
'close': 595, 'open': 594,
'last_traded': Timestamp('2018-03-01 09:50:00+0000',
tz='UTC')
},
{'high': 594, 'volume': 108, 'low': 592,
'close': 593, 'open': 592,
'last_traded': Timestamp('2018-03-01 09:55:00+0000',
tz='UTC')
}]
expected = [{'high': np.NaN, 'volume': 0.0, 'low': np.NaN,
'close': np.NaN, 'open': np.NaN,
'last_traded': Timestamp('2018-03-01 09:45:00+0000',
tz='UTC')
},
{'high': 595, 'volume': 10, 'low': 594,
'close': 595, 'open': 594,
'last_traded': Timestamp('2018-03-01 09:50:00+0000',
tz='UTC')
},
{'high': 594, 'volume': 108, 'low': 592,
'close': 593, 'open': 592,
'last_traded': Timestamp('2018-03-01 09:55:00+0000',
tz='UTC')
}]
expected_df = transform_candles_to_df(expected)
self.verify_forward_fill_df_if_needed(candles, periods, expected_df)
# Not the same due to dropna - commenting out for now
# self.verify_get_candles_df(assets, candles, periods[2], expected_df)
+137 -10
View File
@@ -2,6 +2,7 @@ import random
import os import os
import pandas as pd import pandas as pd
from datetime import timedelta
from logbook import TestHandler from logbook import TestHandler
from pandas.util.testing import assert_frame_equal from pandas.util.testing import assert_frame_equal
@@ -12,6 +13,7 @@ from catalyst.exchange.utils.exchange_utils import get_candles_df
from catalyst.exchange.utils.factory import get_exchange from catalyst.exchange.utils.factory import get_exchange
from catalyst.exchange.utils.test_utils import output_df, \ from catalyst.exchange.utils.test_utils import output_df, \
select_random_assets select_random_assets
from catalyst.exchange.utils.stats_utils import set_print_settings
pd.set_option('display.expand_frame_repr', False) pd.set_option('display.expand_frame_repr', False)
pd.set_option('precision', 8) pd.set_option('precision', 8)
@@ -35,7 +37,7 @@ class TestSuiteBundle:
return data_portal return data_portal
def compare_bundle_with_exchange(self, exchange, assets, end_dt, bar_count, def compare_bundle_with_exchange(self, exchange, assets, end_dt, bar_count,
freq, data_frequency, data_portal): freq, data_frequency, data_portal, field):
""" """
Creates DataFrames from the bundle and exchange for the specified Creates DataFrames from the bundle and exchange for the specified
data set. data set.
@@ -58,14 +60,26 @@ class TestSuiteBundle:
log_catcher = TestHandler() log_catcher = TestHandler()
with log_catcher: with log_catcher:
symbols = [asset.symbol for asset in assets]
print(
'comparing {} for {}/{} with {} timeframe until {}'.format(
field, exchange.name, symbols, freq, end_dt
)
)
data['bundle'] = data_portal.get_history_window( data['bundle'] = data_portal.get_history_window(
assets=assets, assets=assets,
end_dt=end_dt, end_dt=end_dt,
bar_count=bar_count, bar_count=bar_count,
frequency=freq, frequency=freq,
field='close', field=field,
data_frequency=data_frequency, data_frequency=data_frequency,
) )
set_print_settings()
print(
'the bundle data:\n{}'.format(
data['bundle']
)
)
candles = exchange.get_candles( candles = exchange.get_candles(
end_dt=end_dt, end_dt=end_dt,
freq=freq, freq=freq,
@@ -74,11 +88,16 @@ class TestSuiteBundle:
) )
data['exchange'] = get_candles_df( data['exchange'] = get_candles_df(
candles=candles, candles=candles,
field='close', field=field,
freq=freq, freq=freq,
bar_count=bar_count, bar_count=bar_count,
end_dt=end_dt, end_dt=end_dt,
) )
print(
'the exchange data:\n{}'.format(
data['exchange']
)
)
for source in data: for source in data:
df = data[source] df = data[source]
path, folder = output_df( path, folder = output_df(
@@ -88,24 +107,85 @@ class TestSuiteBundle:
print('saved {} test results: {}'.format(end_dt, folder)) print('saved {} test results: {}'.format(end_dt, folder))
assert_frame_equal( assert_frame_equal(
right=data['bundle'], right=data['bundle'][:-1],
left=data['exchange'], left=data['exchange'][:-1],
check_less_precise=1, check_less_precise=1,
) )
try: try:
assert_frame_equal( assert_frame_equal(
right=data['bundle'], right=data['bundle'][:-1],
left=data['exchange'], left=data['exchange'][:-1],
check_less_precise=min([a.decimals for a in assets]), check_less_precise=min([a.decimals for a in assets]),
) )
except Exception as e: except Exception as e:
print('Some differences were found within a 1 decimal point ' print(
'interval of confidence: {}'.format(e)) 'Some differences were found within a 1 decimal point '
'interval of confidence: {}'.format(e)
)
with open(os.path.join(folder, 'compare.txt'), 'w+') as handle: with open(os.path.join(folder, 'compare.txt'), 'w+') as handle:
handle.write(e.args[0]) handle.write(e.args[0])
pass pass
def compare_current_with_last_candle(self, exchange, assets, end_dt,
freq, data_frequency, data_portal):
"""
Creates DataFrames from the bundle and exchange for the specified
data set.
Parameters
----------
exchange: Exchange
assets
end_dt
bar_count
freq
data_frequency
data_portal
Returns
-------
"""
data = dict()
assets = sorted(assets, key=lambda a: a.symbol)
log_catcher = TestHandler()
with log_catcher:
symbols = [asset.symbol for asset in assets]
print(
'comparing data for {}/{} with {} timeframe on {}'.format(
exchange.name, symbols, freq, end_dt
)
)
data['candle'] = data_portal.get_history_window(
assets=assets,
end_dt=end_dt,
bar_count=1,
frequency=freq,
field='close',
data_frequency=data_frequency,
)
set_print_settings()
print(
'the bundle first / last row:\n{}'.format(
data['candle'].iloc[[-1]]
)
)
current = data_portal.get_spot_value(
assets=assets,
field='close',
dt=end_dt,
data_frequency=data_frequency,
)
data['current'] = pd.Series(data=current, index=assets)
print(
'the current price:\n{}'.format(
data['current']
)
)
pass
def test_validate_bundles(self): def test_validate_bundles(self):
# exchange_population = 3 # exchange_population = 3
asset_population = 3 asset_population = 3
@@ -125,8 +205,11 @@ class TestSuiteBundle:
frequencies = exchange.get_candle_frequencies(data_frequency) frequencies = exchange.get_candle_frequencies(data_frequency)
freq = random.sample(frequencies, 1)[0] freq = random.sample(frequencies, 1)[0]
rnd = random.SystemRandom()
# field = rnd.choice(['open', 'high', 'low', 'close', 'volume'])
field = rnd.choice(['volume'])
bar_count = random.randint(1, 10) bar_count = random.randint(3, 6)
assets = select_random_assets( assets = select_random_assets(
exchange.assets, asset_population exchange.assets, asset_population
@@ -139,6 +222,7 @@ class TestSuiteBundle:
if end_dt is None or asset_end_dt < end_dt: if end_dt is None or asset_end_dt < end_dt:
end_dt = asset_end_dt end_dt = asset_end_dt
end_dt = end_dt + timedelta(minutes=3)
dt_range = pd.date_range( dt_range = pd.date_range(
end=end_dt, periods=bar_count, freq=freq end=end_dt, periods=bar_count, freq=freq
) )
@@ -150,5 +234,48 @@ class TestSuiteBundle:
freq=freq, freq=freq,
data_frequency=data_frequency, data_frequency=data_frequency,
data_portal=data_portal, data_portal=data_portal,
field=field,
)
pass
def test_validate_last_candle(self):
# exchange_population = 3
asset_population = 3
data_frequency = random.choice(['minute'])
# bundle = 'dailyBundle' if data_frequency
# == 'daily' else 'minuteBundle'
# exchanges = select_random_exchanges(
# population=exchange_population,
# features=[bundle],
# ) # Type: list[Exchange]
exchanges = [get_exchange('poloniex', skip_init=True)]
data_portal = TestSuiteBundle.get_data_portal(exchanges)
for exchange in exchanges:
exchange.init()
frequencies = exchange.get_candle_frequencies(data_frequency)
freq = random.sample(frequencies, 1)[0]
assets = select_random_assets(
exchange.assets, asset_population
)
end_dt = None
for asset in assets:
attribute = 'end_{}'.format(data_frequency)
asset_end_dt = getattr(asset, attribute)
if end_dt is None or asset_end_dt < end_dt:
end_dt = asset_end_dt
end_dt = end_dt + timedelta(minutes=3)
self.compare_current_with_last_candle(
exchange=exchange,
assets=assets,
end_dt=end_dt,
freq=freq,
data_frequency=data_frequency,
data_portal=data_portal,
) )
pass pass
@@ -15,7 +15,7 @@ from catalyst.exchange.utils.test_utils import select_random_exchanges, \
handle_exchange_error, select_random_assets handle_exchange_error, select_random_assets
from catalyst.testing import ZiplineTestCase from catalyst.testing import ZiplineTestCase
from catalyst.testing.fixtures import WithLogger from catalyst.testing.fixtures import WithLogger
from exchange.utils.factory import get_exchanges from catalyst.exchange.utils.factory import get_exchanges, get_exchange
log = Logger('TestSuiteExchange') log = Logger('TestSuiteExchange')
@@ -90,7 +90,7 @@ class TestSuiteExchange(WithLogger, ZiplineTestCase):
# exchange_population, # exchange_population,
# features=['fetchTickers'], # features=['fetchTickers'],
# ) # Type: list[Exchange] # ) # Type: list[Exchange]
exchanges = list(get_exchanges(['bitfinex']).values()) exchanges = list(get_exchanges(['binance']).values())
for exchange in exchanges: for exchange in exchanges:
exchange.init() exchange.init()
@@ -113,10 +113,11 @@ class TestSuiteExchange(WithLogger, ZiplineTestCase):
exchange_population = 3 exchange_population = 3
asset_population = 3 asset_population = 3
exchanges = select_random_exchanges( # exchanges = select_random_exchanges(
population=exchange_population, # population=exchange_population,
features=['fetchOHLCV'], # features=['fetchOHLCV'],
) # Type: list[Exchange] # ) # Type: list[Exchange]
exchanges = list(get_exchanges(['binance']).values())
for exchange in exchanges: for exchange in exchanges:
exchange.init() exchange.init()
@@ -138,7 +139,6 @@ class TestSuiteExchange(WithLogger, ZiplineTestCase):
assets=assets, assets=assets,
bar_count=bar_count, bar_count=bar_count,
start_dt=dt_range[0], start_dt=dt_range[0],
end_dt=dt_range[-1],
) )
assert len(candles) == asset_population assert len(candles) == asset_population
@@ -155,13 +155,20 @@ class TestSuiteExchange(WithLogger, ZiplineTestCase):
quote_currency = 'eth' quote_currency = 'eth'
order_amount = 0.1 order_amount = 0.1
exchanges = select_random_exchanges( # exchanges = select_random_exchanges(
population=population, # population=population,
features=['fetchOrder'], # features=['fetchOrder'],
is_authenticated=True, # is_authenticated=True,
base_currency=quote_currency, # base_currency=quote_currency,
) # Type: list[Exchange] # ) # Type: list[Exchange]
exchanges = [
get_exchange(
'binance',
base_currency=quote_currency,
must_authenticate=True,
)
]
log_catcher = TestHandler() log_catcher = TestHandler()
with log_catcher: with log_catcher:
for exchange in exchanges: for exchange in exchanges:
View File
+36
View File
@@ -0,0 +1,36 @@
from catalyst.marketplace.marketplace import Marketplace
from catalyst.testing.fixtures import WithLogger, ZiplineTestCase
import pandas as pd
class TestMarketplace(WithLogger, ZiplineTestCase):
def test_list(self):
marketplace = Marketplace()
marketplace.list()
pass
def test_register(self):
marketplace = Marketplace()
marketplace.register()
pass
def test_subscribe(self):
marketplace = Marketplace()
marketplace.subscribe('marketcap2222')
pass
def test_ingest(self):
marketplace = Marketplace()
ds_def = marketplace.ingest('github')
pass
def test_publish(self):
marketplace = Marketplace()
datadir = '/Users/fredfortier/Downloads/marketcap_test_single'
marketplace.publish('marketcap1234', datadir, False)
pass
def test_clean(self):
marketplace = Marketplace()
marketplace.clean('marketcap')
pass