DOC: Features

This commit is contained in:
Victor Grau Serrat committed 2017-10-20 08:28:15 -06:00
1 parent 78351ee879
commit 00df4f1227
5 files changed
+54 -2

No files matched your search

+4
View File
@@ -1,4 +1,8 @@
.. include:: welcome.rst
|
|
Table of Contents
-----------------
.. toctree::
:maxdepth: 1
+14 -1
View File
@@ -6,4 +6,17 @@ Catalyst empowers users to share and curate data and build profitable,
data-driven investment strategies.
Features
========
========
- Ease of use: Catalyst tries to get out of your way so that you can
focus on algorithm development. See examples provided.
- Support for several of the top crypto-exchanges by trading volume.
- Input of historical pricing data of all crypto-assets by exchange,
with daily and minute resolution.
- Backtesting and live-trading functionality, with a seamless transition
between the two modes.
- Output of performance statistics are based on Pandas DataFrames to
integrate nicely into the existing PyData eco-system.
- Statistic and machine learning libraries like matplotlib, scipy,
statsmodels, and sklearn support development, analysis, and
visualization of state-of-the-art trading systems.
+21
View File
@@ -137,11 +137,32 @@ Catalyst empowers users to share and curate data and build profitable,
data-driven investment strategies.</p>
<div class="section" id="features">
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li>Ease of use: Catalyst tries to get out of your way so that you can
focus on algorithm development. See examples provided.</li>
<li>Support for several of the top crypto-exchanges by trading volume.</li>
<li>Input of historical pricing data of all crypto-assets by exchange,
with daily and minute resolution.</li>
<li>Backtesting and live-trading functionality, with a seamless transition
between the two modes.</li>
<li>Output of performance statistics are based on Pandas DataFrames to
integrate nicely into the existing PyData eco-system.</li>
<li>Statistic and machine learning libraries like matplotlib, scipy,
statsmodels, and sklearn support development, analysis, and
visualization of state-of-the-art trading systems.</li>
</ul>
<div class="line-block">
<div class="line"><br /></div>
<div class="line"><br /></div>
</div>
<div class="section" id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
</ul>
</div>
</div>
</div>
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({envversion:46,filenames:["appendix","beginner-tutorial","bundles","development-guidelines","index","install","release-process","releases","welcome"],objects:{"zipline.data.bundles":{bundles:[0,0,1,""]}},objnames:{"0":["py","data","Python data"]},objtypes:{"0":"py:data"},terms:{"000000e":1,"001918e":1,"00pm":7,"01pm":7,"0x7ff5c6147f90":1,"11465d9":7,"1fbf5e9bfd7c4d9cb2e8383e1085":1,"201900e":1,"2ee40db":7,"367492e":1,"410420e":1,"513357725cb64a539e3dd02b47da7":1,"533233fae43c7ff74abfb0044f046978817cb4e4":7,"5f49fa2":7,"906000e":1,"977002e":1,"993979e":1,"9ea6b142ff09466b9113331a37437":1,"__getitem__":7,"__main__":7,"__name__":7,"__repr__":7,"__wrapped__":6,"_position_amount":7,"abstract":7,"boolean":[2,7],"case":[1,2,3,5,7],"catch":7,"class":[3,6,7],"default":1,"export":6,"final":[1,2,3],"float":[1,7],"import":[1,2,6,7],"int":[2,7],"long":[1,2,7],"new":1,"null":7,"return":[1,6,7],"short":[1,3,7],"static":[6,7],"switch":7,"throw":7,"true":7,"try":[3,5,7],"var":1,"while":[6,7],aapl:[1,2,7],abil:[2,7],abl:[1,2,5,7],about:[1,2,3,5,7],abov:[1,3,5,6,7],absolut:7,accept:[2,6,7],accident:7,accord:[6,7],accordingli:7,account:[2,7],achiev:1,acquir:[2,5],across:7,act:7,action:7,activ:[5,6,7],actual:7,add:[2,3,6,7],add_histori:7,add_subplot:1,addit:[3,5,7],address:6,adjust:[2,7],advanc:7,advantag:5,affect:7,after:[1,2,3,5,6,7],again:7,against:7,ahead:1,alexand:7,algebra:5,algo:[1,2,7],algo_volatil:1,algofil:[1,2],algorithm_period_return:[1,7],algotext:1,alia:7,alias_dt:7,align:7,all:[0,1,2,3,5,6,7],all_api_method:7,alloc:7,allow:[1,2,5,7],along:[2,7],alpha:[1,5,7],alreadi:[1,2,3,5],also:[1,2,3,5,6,7],altern:[5,7],although:1,alwai:[2,6,7],amor:7,amount:[1,7],anaconda:[5,6,7],anaconda_token:7,analogu:7,analysi:6,analyt:5,analyz:[1,7],andrea:7,ani:[1,2,5,6,7],announc:7,annual:7,annualizedvolatil:7,anonym:2,anoth:[1,2,5,7],anymor:1,anyth:[5,6],app:1,appar:1,appear:[2,6],append:[6,7],appendix:3,appl:1,appli:[1,7],appropri:3,approxim:7,appveyor:[3,6,7],april:7,apt:5,arch:5,architectur:1,arena:7,arg:[1,6,7],argument:[0,1,2,6,7],aroon:7,around:[6,7],arrai:[5,7],ask:[1,3],asof_d:7,assess:1,asset_find:7,assetdbwrit:2,assetfind:7,assetfindercachedequ:7,assign:7,assist:5,assum:[1,3,5],atla:5,atleastn:7,attach_pipelin:7,attempt:[2,7],attribut:[6,7],author:7,auto:7,auto_close_d:7,automat:1,avail:1,averagedollarvolum:7,avoid:[1,2,7],awar:[6,7],ax1:1,ax2:1,back:[3,7],backend:5,backfil:7,backward:7,bad:7,band:7,bar:[1,7],bar_count:[1,7],bardata:7,barread:7,base:[1,2,5,7],basi:7,batch:7,batch_transform:7,batchtransform:7,batteri:1,bcolz:[2,7],bcolzdailybarread:[2,7],bcolzdailybarwrit:[2,7],bcolzminutebarread:[2,7],bcolzminutebarwrit:[2,7],becaus:[5,6,7],becom:7,been:[0,1,2,5,6,7],befor:[1,2,3,5,7],before_trading_start:[0,7],begin:[5,7],behavior:[0,7],below:[1,5],benchmark:7,benchmark_period_return:1,benchmark_volatil:1,benefit:1,best:[3,5],beta:[1,7],better:7,between:[3,7],bia:1,big:5,bin:5,binari:[5,6,7],bit:[3,7],blaze:7,blazeearningscalendarload:7,blazeload:7,bld:3,bloat:7,blotter:7,bmf:7,board:7,bodi:3,bolling:7,bollinger_band:7,bollingerband:7,book:1,book_target_perc:7,bool:7,both:[3,4,6,7,8],bottom:7,bought:1,bound:1,boundari:7,boundcolumn:7,bovespa:7,branch:[3,6],brew:[3,5],brother:5,brows:5,browser:[1,3,6],bucket:7,bug:[2,3],bui:[1,7],build:[3,5,6],build_ext:3,bump:7,busi:1,businessdayssincecashbuybackauth:7,businessdayssincedividendannounc:7,businessdayssincepreviousearn:7,businessdayssincepreviousexd:7,businessdayssincesharebuybackauth:7,businessdaysuntilnextearn:7,businessdaysuntilnextexd:7,button:[5,6],buyappl:1,buyapple_out:1,buyback:7,buyback_auth:7,cachedobject:7,calc:7,calc_dividend_ratio:7,calcul:[1,3,7],calculate_max_drawdown:7,call:[1,2,3,7],can:[1,2,3,5,6,7],can_trad:7,cannot:5,canon:3,cap:7,capabl:[1,7],capit:[1,7],capital_bas:7,capital_us:1,captur:[1,7],cash:[2,3,7],cashbuybackauthor:7,catalyst:[4,5,8],catalyst_dev:5,categor:7,caus:[0,1,2,3,7],ceiling:7,cell:[1,7],certain:7,certian:0,chain:7,chanc:1,chang:[1,3,6],channel:5,charact:3,charg:[1,7],chart:5,check:[1,2,3,7],checker:6,checkout:[1,3,6],checkpoint:7,choic:6,choos:[5,6],chunk:7,classic:1,classifi:[1,7],classmethod:7,clean:[2,5,6,7],cleaner:7,clear:[1,2],cli:[1,7],click:[5,6],clock:7,clone:3,close:[1,7],cloud:7,cmd:1,code:[6,7],codebas:3,coerc:7,colin:7,collect:[1,2],color:1,column:[1,2,7],com:[1,2,3,7],combin:7,come:[2,5,7],comingl:7,commis:7,commissionmodel:7,common:[1,7],commonli:1,commun:5,compar:[1,7],comparison:7,compat:7,compil:[5,6,7],complex:[5,7],complic:7,compounded_log_return:7,comput:[1,5,7],concept:[1,7],conceptu:7,concurr:7,conda:3,conda_build_matrix:6,condit:7,conf:1,config:5,configur:[1,3,5,7],conflict:7,congratul:5,connect:7,consid:7,consist:[1,7],constraint:2,construct:7,constructor:7,consum:[6,7],contain:[1,2,3,5,7],content:1,context:[1,7],contigu:7,continu:1,continuum:5,contract:7,conveni:1,convers:2,convert:[2,7],copi:[2,3,6,7],core:[5,7],correct:[2,5,6,7],correctli:[1,6,7],correl:7,cost:[1,7],could:[0,1,2,5,7],count:[2,Line truncated
Search.setIndex({envversion:46,filenames:["appendix","beginner-tutorial","bundles","development-guidelines","index","install","release-process","releases","welcome"],objects:{"zipline.data.bundles":{bundles:[0,0,1,""]}},objnames:{"0":["py","data","Python data"]},objtypes:{"0":"py:data"},terms:{"000000e":1,"001918e":1,"00pm":7,"01pm":7,"0x7ff5c6147f90":1,"11465d9":7,"1fbf5e9bfd7c4d9cb2e8383e1085":1,"201900e":1,"2ee40db":7,"367492e":1,"410420e":1,"513357725cb64a539e3dd02b47da7":1,"533233fae43c7ff74abfb0044f046978817cb4e4":7,"5f49fa2":7,"906000e":1,"977002e":1,"993979e":1,"9ea6b142ff09466b9113331a37437":1,"__getitem__":7,"__main__":7,"__name__":7,"__repr__":7,"__wrapped__":6,"_position_amount":7,"abstract":7,"boolean":[2,7],"case":[1,2,3,5,7],"catch":7,"class":[3,6,7],"default":1,"export":6,"final":[1,2,3],"float":[1,7],"import":[1,2,6,7],"int":[2,7],"long":[1,2,7],"new":1,"null":7,"return":[1,6,7],"short":[1,3,7],"static":[6,7],"switch":7,"throw":7,"true":7,"try":[3,5,7],"var":1,"while":[6,7],aapl:[1,2,7],abil:[2,7],abl:[1,2,5,7],about:[1,2,3,5,7],abov:[1,3,5,6,7],absolut:7,accept:[2,6,7],accident:7,accord:[6,7],accordingli:7,account:[2,7],achiev:1,acquir:[2,5],across:7,act:7,action:7,activ:[5,6,7],actual:7,add:[2,3,6,7],add_histori:7,add_subplot:1,addit:[3,5,7],address:6,adjust:[2,7],advanc:7,advantag:5,affect:7,after:[1,2,3,5,6,7],again:7,against:7,ahead:1,alexand:7,algebra:5,algo:[1,2,7],algo_volatil:1,algofil:[1,2],algorithm_period_return:[1,7],algotext:1,alia:7,alias_dt:7,align:7,all:[0,1,2,3,4,5,6,7,8],all_api_method:7,alloc:7,allow:[1,2,5,7],along:[2,7],alpha:[1,5,7],alreadi:[1,2,3,5],also:[1,2,3,5,6,7],altern:[5,7],although:1,alwai:[2,6,7],amor:7,amount:[1,7],anaconda:[5,6,7],anaconda_token:7,analogu:7,analysi:[4,6,8],analyt:5,analyz:[1,7],andrea:7,ani:[1,2,5,6,7],announc:7,annual:7,annualizedvolatil:7,anonym:2,anoth:[1,2,5,7],anymor:1,anyth:[5,6],app:1,appar:1,appear:[2,6],append:[6,7],appendix:3,appl:1,appli:[1,7],appropri:3,approxim:7,appveyor:[3,6,7],april:7,apt:5,arch:5,architectur:1,arena:7,arg:[1,6,7],argument:[0,1,2,6,7],aroon:7,around:[6,7],arrai:[5,7],art:[4,8],ask:[1,3],asof_d:7,assess:1,asset_find:7,assetdbwrit:2,assetfind:7,assetfindercachedequ:7,assign:7,assist:5,assum:[1,3,5],atla:5,atleastn:7,attach_pipelin:7,attempt:[2,7],attribut:[6,7],author:7,auto:7,auto_close_d:7,automat:1,avail:1,averagedollarvolum:7,avoid:[1,2,7],awar:[6,7],ax1:1,ax2:1,back:[3,7],backend:5,backfil:7,backward:7,bad:7,band:7,bar:[1,7],bar_count:[1,7],bardata:7,barread:7,base:[1,2,4,5,7,8],basi:7,batch:7,batch_transform:7,batchtransform:7,batteri:1,bcolz:[2,7],bcolzdailybarread:[2,7],bcolzdailybarwrit:[2,7],bcolzminutebarread:[2,7],bcolzminutebarwrit:[2,7],becaus:[5,6,7],becom:7,been:[0,1,2,5,6,7],befor:[1,2,3,5,7],before_trading_start:[0,7],begin:[5,7],behavior:[0,7],below:[1,5],benchmark:7,benchmark_period_return:1,benchmark_volatil:1,benefit:1,best:[3,5],beta:[1,7],better:7,between:[3,4,7,8],bia:1,big:5,bin:5,binari:[5,6,7],bit:[3,7],blaze:7,blazeearningscalendarload:7,blazeload:7,bld:3,bloat:7,blotter:7,bmf:7,board:7,bodi:3,bolling:7,bollinger_band:7,bollingerband:7,book:1,book_target_perc:7,bool:7,both:[3,4,6,7,8],bottom:7,bought:1,bound:1,boundari:7,boundcolumn:7,bovespa:7,branch:[3,6],brew:[3,5],brother:5,brows:5,browser:[1,3,6],bucket:7,bug:[2,3],bui:[1,7],build:[3,5,6],build_ext:3,bump:7,busi:1,businessdayssincecashbuybackauth:7,businessdayssincedividendannounc:7,businessdayssincepreviousearn:7,businessdayssincepreviousexd:7,businessdayssincesharebuybackauth:7,businessdaysuntilnextearn:7,businessdaysuntilnextexd:7,button:[5,6],buyappl:1,buyapple_out:1,buyback:7,buyback_auth:7,cachedobject:7,calc:7,calc_dividend_ratio:7,calcul:[1,3,7],calculate_max_drawdown:7,call:[1,2,3,7],can:[1,2,3,4,5,6,7,8],can_trad:7,cannot:5,canon:3,cap:7,capabl:[1,7],capit:[1,7],capital_bas:7,capital_us:1,captur:[1,7],cash:[2,3,7],cashbuybackauthor:7,catalyst:[4,5,8],catalyst_dev:5,categor:7,caus:[0,1,2,3,7],ceiling:7,cell:[1,7],certain:7,certian:0,chain:7,chanc:1,chang:[1,3,6],channel:5,charact:3,charg:[1,7],chart:5,check:[1,2,3,7],checker:6,checkout:[1,3,6],checkpoint:7,choic:6,choos:[5,6],chunk:7,classic:1,classifi:[1,7],classmethod:7,clean:[2,5,6,7],cleaner:7,clear:[1,2],cli:[1,7],click:[5,6],clock:7,clone:3,close:[1,7],cloud:7,cmd:1,code:[6,7],codebas:3,coerc:7,colin:7,collect:[1,2],color:1,column:[1,2,7],com:[1,2,3,7],combin:7,come:[2,5,7],comingl:7,commis:7,commissionmodel:7,common:[1,7],commonli:1,commun:5,compar:[1,7],comparison:7,compat:7,compil:[5,6,7],complex:[5,7],complic:7,compounded_log_return:7,comput:[1,5,7],concept:[1,7],conceptu:7,concurr:7,conda:3,conda_build_matrix:6,condit:7,conf:1,config:5,configur:[1,3,5,7],conflict:7,congratul:5,connect:7,consid:7,consist:[1,7],constraint:2,construct:7,constructor:7,consum:[6,7],contain:[1,2,3,5,7],content:1,context:[1,7],contigu:7,continu:1,continuum:5,contract:7,conveni:1,convers:2,convert:[2,7],copi:[2,3,6,7],core:[5,7],correct:[2,5,6,7],correctli:[1,6,7],correl:7,cost:[Line truncated
+14
View File
@@ -136,6 +136,20 @@ Catalyst empowers users to share and curate data and build profitable,
data-driven investment strategies.</p>
<div class="section" id="features">
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li>Ease of use: Catalyst tries to get out of your way so that you can
focus on algorithm development. See examples provided.</li>
<li>Support for several of the top crypto-exchanges by trading volume.</li>
<li>Input of historical pricing data of all crypto-assets by exchange,
with daily and minute resolution.</li>
<li>Backtesting and live-trading functionality, with a seamless transition
between the two modes.</li>
<li>Output of performance statistics are based on Pandas DataFrames to
integrate nicely into the existing PyData eco-system.</li>
<li>Statistic and machine learning libraries like matplotlib, scipy,
statsmodels, and sklearn support development, analysis, and
visualization of state-of-the-art trading systems.</li>
</ul>
</div>