You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@climate.apache.org by le...@apache.org on 2017/04/24 21:36:18 UTC
svn commit: r1792548 [10/17] - in /climate/site/trunk/content/api: 1.1.0/
1.1.0/_sources/ 1.1.0/_sources/config/ 1.1.0/_sources/data_source/
1.1.0/_sources/ocw/ 1.1.0/_sources/ui-backend/ 1.1.0/_static/ 1.1.0/config/
1.1.0/data_source/ 1.1.0/ocw/ 1.1.0...
Added: climate/site/trunk/content/api/1.1.0/searchindex.js
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/1.1.0/searchindex.js?rev=1792548&view=auto
==============================================================================
--- climate/site/trunk/content/api/1.1.0/searchindex.js (added)
+++ climate/site/trunk/content/api/1.1.0/searchindex.js Mon Apr 24 21:36:16 2017
@@ -0,0 +1 @@
+Search.setIndex({envversion:46,filenames:["config/config_overview","config/config_writer","config/dataset_information","config/evaluation_settings","config/metrics_information","config/plots_settings","data_source/data_sources","index","ocw/dataset","ocw/dataset_processor","ocw/evaluation","ocw/metrics","ocw/overview","ocw/plotter","ocw/utils","ui-backend/backend"],objects:{"":{"/datasets/":[15,0,1,"get--datasets-"],"/list/":[15,0,1,"get--list-"],"/list/(dir_path:path)":[15,0,1,"get--list-(dir_path-path)"],"/list_latlon/(file_path:path)":[15,0,1,"get--list_latlon-(file_path-path)"],"/list_time/(file_path:path)":[15,0,1,"get--list_time-(file_path-path)"],"/list_vars/(file_path:path)":[15,0,1,"get--list_vars-(file_path-path)"],"/metrics/":[15,0,1,"get--metrics-"],"/parameters/":[15,0,1,"get--parameters-"],"/parameters/bounds":[15,0,1,"get--parameters-bounds"],"/parameters/bounds/":[15,0,1,"get--parameters-bounds-"],"/path_leader/":[15,0,1,"get--path_leader-"],"/results/":[15,0,1,"get-
-results-"],"/results/(dir_path:path)":[15,0,1,"get--results-(dir_path-path)"],"/run_evaluation/":[15,2,1,"post--run_evaluation-"],dap:[6,3,0,"-"],dataset_processor:[9,3,0,"-"],esgf:[6,3,0,"-"],local:[6,3,0,"-"],metrics:[11,3,0,"-"],plotter:[13,3,0,"-"],rcmed:[6,3,0,"-"],utils:[14,3,0,"-"]},"dataset.Dataset":{spatial_boundaries:[8,5,1,""],spatial_resolution:[8,5,1,""],temporal_resolution:[8,5,1,""],time_range:[8,5,1,""]},"evaluation.Evaluation":{add_dataset:[10,5,1,""],add_datasets:[10,5,1,""],add_metric:[10,5,1,""],add_metrics:[10,5,1,""],metrics:[10,6,1,""],results:[10,6,1,""],run:[10,5,1,""],target_datasets:[10,6,1,""],unary_metrics:[10,6,1,""],unary_results:[10,6,1,""]},"metrics.Bias":{run:[11,5,1,""]},"metrics.BinaryMetric":{run:[11,5,1,""]},"metrics.PatternCorrelation":{run:[11,5,1,""]},"metrics.RMSError":{run:[11,5,1,""]},"metrics.SpatialPatternTaylorDiagram":{run:[11,5,1,""]},"metrics.StdDevRatio":{run:[11,5,1,""]},"metrics.TemporalCorrelation":{run:[11,5,1,""]},"metrics.Tem
poralMeanBias":{run:[11,5,1,""]},"metrics.TemporalStdDev":{run:[11,5,1,""]},"metrics.UnaryMetric":{run:[11,5,1,""]},"ocw_config_runner.configuration_writer":{export_evaluation_to_config:[1,4,1,""],generate_dataset_config:[1,4,1,""],generate_dataset_information:[1,4,1,""],generate_evaluation_information:[1,4,1,""],generate_metric_information:[1,4,1,""],generate_subregion_information:[1,4,1,""]},"plotter.TaylorDiagram":{add_contours:[13,5,1,""],add_rms_contours:[13,5,1,""],add_sample:[13,5,1,""],add_stddev_contours:[13,5,1,""]},dap:{load:[6,4,1,""]},dataset:{Bounds:[8,7,1,""],Dataset:[8,7,1,""]},dataset_processor:{ensemble:[9,4,1,""],mask_missing_data:[9,4,1,""],normalize_dataset_datetimes:[9,4,1,""],safe_subset:[9,4,1,""],spatial_regrid:[9,4,1,""],subset:[9,4,1,""],temperature_unit_conversion:[9,4,1,""],temporal_rebin:[9,4,1,""],temporal_rebin_with_time_index:[9,4,1,""],temporal_slice:[9,4,1,""],temporal_subset:[9,4,1,""],variable_unit_conversion:[9,4,1,""],water_flux_unit_conversion
:[9,4,1,""],write_netcdf:[9,4,1,""]},esgf:{load_dataset:[6,4,1,""]},evaluation:{Evaluation:[10,7,1,""]},local:{load_GPM_IMERG_files:[6,4,1,""],load_NLDAS_forcingA_files:[6,4,1,""],load_WRF_2d_files:[6,4,1,""],load_WRF_2d_files_RAIN:[6,4,1,""],load_dataset_from_multiple_netcdf_files:[6,4,1,""],load_file:[6,4,1,""],load_multiple_files:[6,4,1,""]},metrics:{Bias:[11,7,1,""],BinaryMetric:[11,7,1,""],Metric:[11,7,1,""],PatternCorrelation:[11,7,1,""],RMSError:[11,7,1,""],SpatialPatternTaylorDiagram:[11,7,1,""],StdDevRatio:[11,7,1,""],TemporalCorrelation:[11,7,1,""],TemporalMeanBias:[11,7,1,""],TemporalStdDev:[11,7,1,""],UnaryMetric:[11,7,1,""],calc_bias:[11,4,1,""],calc_correlation:[11,4,1,""],calc_rmse:[11,4,1,""],calc_stddev:[11,4,1,""],calc_stddev_ratio:[11,4,1,""]},ocw_config_runner:{configuration_writer:[1,3,0,"-"]},plotter:{TaylorDiagram:[13,7,1,""],draw_barchart:[13,4,1,""],draw_contour_map:[13,4,1,""],draw_histogram:[13,4,1,""],draw_marker_on_map:[13,4,1,""],draw_portrait_diagram:[
13,4,1,""],draw_subregions:[13,4,1,""],draw_taylor_diagram:[13,4,1,""],draw_time_series:[13,4,1,""],set_cmap:[13,4,1,""]},rcmed:{get_parameters_metadata:[6,4,1,""],parameter_dataset:[6,4,1,""]},utils:{calc_area_weighted_spatial_average:[14,4,1,""],calc_climatology_monthly:[14,4,1,""],calc_climatology_year:[14,4,1,""],calc_subregion_area_mean_and_std:[14,4,1,""],calc_temporal_mean:[14,4,1,""],calc_time_series:[14,4,1,""],decode_time_values:[14,4,1,""],get_temporal_overlap:[14,4,1,""],normalize_lat_lon_values:[14,4,1,""],parse_base_time_string:[14,4,1,""],parse_time_base:[14,4,1,""],parse_time_units:[14,4,1,""],reshape_monthly_to_annually:[14,4,1,""]}},objnames:{"0":["http","get","HTTP get"],"1":["http","options","HTTP options"],"2":["http","post","HTTP post"],"3":["py","module","Python module"],"4":["py","function","Python function"],"5":["py","method","Python method"],"6":["py","attribute","Python attribute"],"7":["py","class","Python class"]},objtypes:{"0":"http:get","1":"http:opti
ons","2":"http:post","3":"py:module","4":"py:function","5":"py:method","6":"py:attribute","7":"py:class"},terms:{"2008_tasmax":[0,2],"2b_ctl_eraint_mm_50km_1989":[0,2],"abstract":[],"boolean":[9,13],"case":12,"class":[4,6,8,9,10,11,12,13,15],"default":[1,6,8,10,12,13],"export":[0,1],"final":15,"float":[6,8,11,13],"function":[1,2,3,5,8,12,13,15],"import":[1,12],"int":[6,9,11,13],"long":15,"new":[3,9,12],"public":13,"return":[1,3,6,8,9,11,12,14,15],"short":15,"static":15,"true":[9,11,13,15],"try":[2,3,12],"while":[12,14],abl:[4,13,15],about:[6,12],abov:[2,12,15],accept:[2,3],accur:12,across:14,act:12,actual:12,add:[10,13],add_contour:13,add_dataset:10,add_metr:10,add_rms_contour:13,add_sampl:13,add_stddev_contour:13,addit:[0,2,6,12,13],additional_constraint:6,address:15,adjust:[3,5,12,13],adjust_lat:14,adjusted_lon:14,adjusted_valu:14,africa_knmi:[0,2],africa_uc:[0,2],after:0,again:15,against:[10,11,12],aim:12,all:[0,3,6,9,10,11,12,14,15],allow:[3,12,14],alon:12,along:[3,11],also:[2,4
,5,12,13,15],ani:[2,3,5,9,10,12,14],annot:[0,3],annual:[14,15],annual_mean:14,anyth:[0,6,15],apach:[],apcpsfc_110_sfc_acc1h:6,api:[],app:15,append:13,applic:15,approxim:[8,13],arang:[3,12],arcco:13,area:[3,12,14],area_weight:14,aren:12,arg:13,around:[4,13],arrai:[6,8,9,11,12,13,14],arrang:13,arrow:13,aspect:13,assign:3,assist:12,associ:11,assum:[9,14,15],attempt:[1,12],attent:3,attribut:[3,8],attributeerror:1,authent:6,author:13,automat:[6,9,13],avail:15,averag:[9,11,14],average_each_year:9,average_over_tim:11,aviso:2,awar:5,axi:[11,13],axisartist:13,ayi:13,backbon:12,backend:15,bar:15,barchart:13,base:[11,12,13,14],basemap:13,baz:15,becom:[3,12],been:[0,2],befor:[1,3,10,12,15],begin:9,behav:12,below:[0,2,3,5,6,12,15],best:1,between:[11,12,13],bia:[0,4,11,12,15],bias:11,bias_evalu:12,bin:[0,12,13,14,15],binari:[10,11,12],binarymetr:[11,12],bit:12,blind:1,bool:[9,11,13],both:[13,15],bottl:15,bound:[],boundari:[8,9,13],boundary_check:9,box:[1,3,13],breakdown:12,breviti:12,bring:15,bro
ken:15,built:15,busi:12,calc_area_weighted_spatial_averag:14,calc_bia:11,calc_climatology_monthli:14,calc_climatology_year:14,calc_correl:11,calc_rms:11,calc_stddev:11,calc_stddev_ratio:11,calc_subregion_area_mean_and_std:14,calc_temporal_mean:14,calc_time_seri:14,calcul:[8,11,12,14],calibr:6,call:[3,12,15],can:[0,1,2,3,4,6,10,12,13,14,15],cannot:6,categori:0,caus:[12,14],celciu:9,center:13,certain:8,cgd:14,chang:[12,14,15],check:[1,5,9,13,15],checkout:0,choos:12,clabel:13,clean:15,clev:13,climat:[],climatolog:14,climo:14,cmap:13,cne:2,coard:14,code:12,coeffici:[11,13],collabel:13,color:13,colorbar:13,colormap:13,column:13,com:13,combin:[9,12],come:12,command:[0,13,15],common:[],compact:3,compar:[10,11,12,13],complic:12,compon:12,compos:9,compress:9,comput:[2,11],confid:11,configuration_writ:1,consid:12,constant:13,constraint:6,constructor:[8,10],contain:[1,6,8,9,10,13,15],content:7,contour:[],control:13,convert:[9,14],coordin:8,copi:12,copin:13,core:11,corr1:13,corr2:13,corrcoef:13
,corrcoeff:13,correct:8,correl:[11,13],correspond:[8,13],could:[12,14],couldn:14,cours:12,creat:[0,3,12,15],creation:15,critic:[3,12],css:15,current:[2,11],curv:13,curvilinear:8,custom:4,dai:[3,8,12,14,15],daili:[9,12,15],dap:[],data1:13,data2:13,data:[],data_nam:13,data_sourc:[0,2,6,12,15],data_source_id:15,databas:[6,12,15],datanod:2,dataset1:12,dataset2:12,dataset_arrai:[9,13,14],dataset_id:[2,6,15],dataset_info:15,dataset_nam:6,dataset_processor:[3,9,12],datasetshortnam:15,date:[8,14],datetim:[3,6,8,9,12,13,14],decid:12,decod:14,decode_time_valu:14,def:12,defin:[3,4,15],degre:[12,15],deivat:11,demonstr:15,denot:13,depend:[],depth:0,desir:[6,12,13],detail:[3,5],determin:[6,15],dev:11,develop:3,deviat:[11,13,14],diagram:[11,13],dict:[1,6,8,13,15],dictionari:[1,6,15],didn:14,differ:[2,5,6,11,12,13],dimens:[9,13,14],dimension:[6,8],dir_path:15,direct:0,directli:[3,13],directori:[],directory_help:15,displai:15,divis:14,doc:13,document:[],doe:[1,3,9,12,15],doesn:[10,14],domain:[9,13],
done:12,doubl:1,down:3,download:[0,2,6],draw:13,draw_barchart:13,draw_contour_map:[5,12,13],draw_histogram:13,draw_marker_on_map:13,draw_portrait_diagram:13,draw_subregion:13,draw_taylor_diagram:13,draw_time_seri:13,drawn:13,dsp:12,due:14,dure:0,each:[2,3,5,6,9,10,12,13,14],earlier:12,eas:15,easi:[3,12],easier:12,easiest:15,easili:[0,12],eaton:14,edu:14,either:[9,12],element:5,elev:6,elevation_index:[2,6],els:10,email:12,empti:15,encount:1,end:[2,3,6,8,9,15],end_dat:15,end_tim:[2,6,8,12,15],end_time_index:9,endpoint:[],enough:12,ensembl:9,ensur:[12,14,15],entir:[1,9,13,15],error:[9,11,12,14],esg:[2,6],esgf_password:[2,6],esgf_usernam:[2,6],etc:12,eval:12,evaluation_cr:3,evalut:12,evalutaion:6,evenli:14,everi:[10,12],exactli:[12,15],exclud:1,exist:15,expect:[1,5,6,14,15],experi:15,explain:5,explan:[],explor:12,export_evaluation_to_config:1,exported_ev:1,extend:13,extent:13,extern:12,extract:[1,6,14,15],extractor:[],extrapol:1,extrem:12,facilit:12,fail:0,failur:15,fairli:[12,15],fals:
[9,11,13,14,15],far:[3,12],feel:12,few:[3,12],field:[6,13],fig:13,figur:13,file1:15,file2:15,file_count:[0,2],file_list:6,file_path:[1,6,15],filelist:6,filenam:[6,13],filename_pattern:6,filetyp:13,find:[12,13,14],fine:12,finer:13,first:[3,6,9,10,12,14],flag:[2,3,5,13],floating_ax:13,flux:9,fmt:13,fname:[12,13],folder:12,follow:[0,2,8,12,14,15],foo:[2,15],forc:9,forcingawrf:6,form:[8,13,14],format:[2,3,5,12,13,14,15],found:[1,6,14],frame:13,frameon:13,framework:15,free:12,from:[0,1,2,6,8,9,10,11,12,14,15],frontend:15,full:[9,14,15],fulli:12,funciton:3,funtion:12,further:12,futur:[2,4,12,15],gener:[0,1,3,6,9,12],generate_dataset_config:1,generate_dataset_inform:1,generate_evaluation_from_config:3,generate_evaluation_inform:1,generate_metric_inform:1,generate_subregion_inform:1,get_cmap:13,get_parameters_metadata:6,get_temporal_overlap:14,gist:13,github:13,give:[0,12,13],given:[1,9,11,14,15],good:12,gov:[2,6],gpm:6,gpm_imerg:6,grab:[12,15],grain:12,graph:5,great:12,grid:[3,9,12,13,14],
gridshap:[0,5,13],guarante:8,guess:[1,15],guidelin:8,handi:12,handl:[],have:[0,2,6,9,10,12,15],haven:0,hdf:6,height:[6,13],help:[12,15],helper:[],here:[3,4,12],histogram:13,hold:[8,12],hopefulli:12,hour:[9,14],how:[0,12,15],howev:[2,3,4,12],htm:14,html:13,http:[2,6,13,14],ideal:15,identifi:15,imeg:6,implement:12,includ:[0,3,5,6,12],index:[6,7,9,15],indic:[],indici:9,info:1,inherit:[10,11,12],input:[9,11,12,13],instal:15,instanc:[10,12,13],instanti:12,instead:0,instruct:15,integ:[9,15],interest:[3,6,12],intern:12,interpret:3,interv:3,invalid:14,isn:[3,10],iso:[2,3],jan:9,javascript:15,jet:[2,6,12,15],job:12,jpl:[2,6,15],json:15,just:[2,3,15],keep:12,kei:6,kelvin:9,knmi_dataset:12,know:12,kwarg:13,label:13,label_month:13,laboratori:[2,6,12,15],lat:[0,3,5,6,8,12,13,14,15],lat_max:[8,15],lat_min:[8,15],lat_nam:[6,15],lat_resolut:8,latitud:[6,8,9,13,15],latitudin:8,latslength:8,layer:6,leader:15,learn:0,least:10,leav:[2,12],legend:13,length:[9,14],less:8,let:[0,12],level:[6,11,13],librar
i:0,like:12,limit:12,line:13,linear:13,linearsegmentedcolormap:13,link:15,list:[0,1,3,4,6,8,10,12,13,14,15],list_latlon:15,list_tim:15,list_var:15,live:12,load:[0,2,3,4,6,8,12,15],load_dataset:[2,6],load_dataset_from_multiple_netcdf_fil:6,load_fil:[2,6,12],load_gpm_imerg_fil:6,load_multiple_fil:6,load_nldas_forcinga_fil:6,load_wrf_2d_fil:6,load_wrf_2d_files_rain:6,local:[],local_file_metadata_extractor:15,locat:[2,15],location_nam:13,log:13,login:2,lon:[0,3,5,6,8,12,13,14,15],lon_max:[8,15],lon_min:[8,15],lon_nam:[6,15],lon_resolut:8,longitud:[6,8,9,13,15],longitudin:8,longnam:15,lonslength:8,look:[0,2,3,12],lot:12,luckili:12,machin:12,mai:[2,5,6],mail:12,main:[0,15],mainten:15,make:[0,3,12],malform:14,mani:12,manipul:[],manner:2,manual:[8,12],map:[],marker:13,mask:[6,9],mask_fil:6,mask_missing_data:9,mask_valu:6,mask_vari:6,maskedarrai:11,match:[14,15],matplotlib:13,max:[8,13],max_lat:[2,6,8,12],max_lon:[2,6,8,12],maximum:[6,8,14,15],mean:[9,11,14],measur:15,meridian:13,metadata:[]
,metricname1:15,metricname2:15,midnight:9,might:12,min:[8,13,14],min_lat:[2,6,8,12],min_lon:[2,6,8,12],minim:15,minimum:[6,8,15],minut:14,miss:9,mnmean:2,mod:6,model:[6,9,11,12,13,14,15],modifi:12,modul:[],moment:[4,15],mon:2,month:[9,13,14],month_end:9,month_index:9,month_start:9,monthli:[9,14,15],more:[2,3,5,6,9,10,12,15],most:5,mpl_toolkit:13,much:[2,3],multi:6,multidimension:12,multipl:[6,10,13],must:[8,9,10,11,13,15],my_test_plot:12,name1:13,name2:13,name:[1,2,4,5,6,8,9,12,13,14,15],nasa:[2,6,12,15],nbin:13,ndarrai:[8,9,11,13,14],ndfcdf4:6,necessari:[0,1,3,9,12],need:[0,2,3,4,5,6,8,9,12,15],neither:13,netcdf4:14,netcdf:[2,6,9,12,14,15],never:12,new_bound:12,new_ev:12,new_lat:12,new_latitud:9,new_lon:12,new_longitud:9,next:10,nlat:13,nldas2:6,nlev:13,nlon:13,node:[2,6],none:[6,8,9,10,11,13],normal:[9,13,14],normalize_dataset_datetim:9,normalize_lat_lon_valu:14,note:[1,5,10,12,15],notic:12,nsubregion:14,nt_averag:9,ntime:14,num_col:13,num_lat:14,num_lon:14,num_metr:10,num_month:1
4,num_row:13,num_subregion:10,num_target:10,num_target_d:10,num_target_dataset:10,num_year:14,number:[3,9,10,12,13,14,15],numpi:[3,8,9,11,12,13,14],nuwrf:6,nx2:13,obejct:6,objec:12,object:[0,1,3,5,6,8,9,10,12,13,14,15],obs4mip:2,observ:[6,9,14],ocw:[0,4,5,6,9,12,14,15],ocw_config_runn:1,ocw_evaluation_from_config:0,off:14,often:[3,6],onc:2,onli:[3,4,10,12,14],onto:[3,12],open:[],openid:6,oper:8,option:[0,1,2,3,5,6,8,10,13,15],optional_arg:[0,2,5],order:[2,3],org:[2,13],origin:[6,8,9,12,13,14,15],other:[3,9,12,15],otherwis:[10,15],our:12,out:[0,1,2,6,12,14,15],output:[1,5,6,8,9,11,13],output_nam:[0,5],outsid:[9,12],over:[10,11,12],overlap:[9,14],overrid:[11,12],own:12,page:[0,2,6,7,15],pai:3,pair:[6,10,12],panel:13,parallel:13,param:[9,12],paramet:[1,2,3,5,6,8,9,10,11,12,13,14,15],parameter_dataset:[2,6],parameter_id:[2,6,15],pars:[1,14],parse_base_time_str:14,parse_time_bas:14,parse_time_unit:14,parser:3,part:12,particular:5,pass:[2,3,5,6,12,15],password:6,patch:12,path:[0,1,2,6,9,1
5],path_lead:15,pattern:[6,11],patterncorrel:11,pearson:11,perform:12,perhap:12,phase:10,php:6,pip:15,place:[12,13],plan:[2,15],pleas:[1,12,15],plotter:[],png:13,point:[6,9,12,13,14],polar:13,portrait:13,posit:13,possibl:[1,10,12,13,15],post:15,potenti:[1,9],precipit:6,precipitationc:6,prefix:15,prepar:0,present:[8,14,15],pretti:[2,3,12],previou:0,previous:12,primari:[0,12,15],print:12,prior:3,process:[],processor:[],project:[2,12],prone:12,propag:13,properli:15,propuls:[2,6,12,15],provid:[0,3,9,10,12,15],ptitl:13,pull:[2,15],purpos:13,pylab_exampl:13,python:[0,3,5,8,13,14,15],pyyaml:[0,3],quadrant:13,queri:6,quit:12,racmo2:[0,2],radiu:13,radmax:13,rais:[1,6,8,9,10,14],rang:[3,5,8,12,14,15],range_max:[0,5],range_min:[0,5],range_step:[0,5],ratio:[11,13],rcme:[2,6],rcmed_help:15,read:[0,6],readin:6,realli:12,rebin:[],receiv:[8,14],recogn:13,rect:13,ref_dataset:[10,11,12],refer:[0,2,10,11,12,13,15],reference_arrai:11,reference_dataset:[11,15],refnam:13,refstd:13,region:[6,12,15],regrid
:[],regular:10,rel:15,relat:[1,5,15],releas:13,relev:15,remaind:12,repeat:0,replac:12,repres:12,represent:3,request:[6,12,15],requir:[2,3,5,8,9,10,15],reshap:14,reshape_monthly_to_annu:14,resolut:[8,9,15],respect:12,respons:15,result1:12,result2:12,result:[5,10,11,12,13,15],results_indec:[0,5],retain:14,retriev:[6,14,15],revers:13,rg_1989:[0,2],right:13,rmserror:11,root:11,row:13,rowlabel:13,rtype:12,run_evalu:15,run_webservic:15,runner:0,safe:[2,3,9],safe_subset:9,same:[0,6,9,12,15],sampl:[11,13],sane:1,save:[1,6],save_path:6,saw:12,scale:13,scari:12,scenario:1,scientist:12,script:0,search:[2,6,7],search_url:6,second:[12,13,14],section:[0,1,2,3,4,5],secur:15,see:[12,13],self:[8,12],send:12,separ:6,sequenc:3,seri:[13,14],serv:15,server:15,servererror:6,servic:[],set_cmap:13,shape:[8,9,10,13,14],shift:14,shortli:12,shortnam:15,should:[0,1,2,3,6,9,10,13,14,15],shouldn:12,show_colormap:13,shown:15,similar:9,simpl:12,simple_model_to_model_bia:0,simpli:[4,12],sinc:[12,14],singl:[6,9,10,1
2,13],size:0,slice:9,slightli:[2,5,12],some:[0,3,6,12],some_dataset:12,someth:[2,3],somevarinthedataset:12,sort:[8,14],sourc:[],space:11,spatial:[],spatial_boundari:[8,12],spatial_rebin_lat_step:15,spatial_rebin_lon_step:15,spatial_regrid:[3,9,12],spatial_regrid_:3,spatial_regrid_lat:[0,3],spatial_regrid_lon:[0,3],spatial_resolut:8,spatialpatterntaylordiagram:11,special:3,specif:[0,2,3,6,15],specifi:[0,2,4,5,6,8,10,13],speed:12,split:[12,14],squar:11,sst:2,standard:[2,3,9,11,13,14],start_dat:15,start_tim:[2,6,8,12,15],start_time_index:9,stat:14,std1:13,std2:13,std:[11,13],stddev:13,stddevratio:11,step:[12,15],stick:[2,3],still:[2,3,12],store:[6,12],straightforward:12,string:[1,6,8,9,13,14,15],strip:[6,15],structur:0,style:3,submodul:15,subplot:13,subregion:[1,9,10,13,14,15],subregion_inform:15,subregion_mask:13,subregion_nam:9,substr:14,subtitl:13,succes:15,success:15,suffici:12,suit:12,suppli:[1,4,6,15],support:[0,2,5,12,14,15],sure:[3,12],surfac:6,symbol:15,system:15,take:[10,12],
target1:12,target2:12,target:[0,2,9,10,11,12,13,15],target_arrai:11,target_dataset:[9,10,11,12,15],tasmax:[0,2],taylor:[11,13],taylordiagram:13,tediou:12,tell:15,temperatur:9,temperature_unit_convers:9,tempor:[],temporal_rebin:[3,9,12],temporal_rebin_with_time_index:9,temporal_resolut:[3,8,9,15],temporal_slic:9,temporal_subset:9,temporal_time_delta:[0,3],temporalcorrel:11,temporalmeanbia:11,temporalstddev:[4,11,12,15],term:13,test:[2,15],text:6,than:8,thei:[10,12,14,15],them:[2,3,10,12],theta:13,thi:[0,1,3,5,8,9,11,12,13,14,15],thing:[12,15],third:13,three:8,through:[2,10],throughout:12,time:[2,3,6,8,9,11,12,13,14,15],time_format:14,time_nam:[6,15],time_rang:[8,12],time_var_nam:14,timedelta:[3,8,12,15],timeslength:8,timestep:9,titl:13,tmp:[0,2,6,12],togeth:15,toggl:13,too:12,tool:[0,12],toolkit:[0,12,15],top:15,total_mean:14,totallynotmypassword:2,totallynotmyusernam:2,trend:12,tri:0,trust:1,tstd:12,tupl:[0,3,5,8,13,14],two:[3,6,10,11,12,13],txt:15,type:[0,1,3,5,6,8,9,10,11,12],ucar
:14,unari:[10,11,12],unary_metr:10,unary_result1:12,unary_result2:12,unary_result3:12,unary_result:[10,12],unarymetr:11,understand:[12,15],unexpect:12,uniform:12,uniqu:8,unit:[6,8,9,14,15],unrecogn:8,updat:9,upon:[10,15],upper:13,url:[2,6,12],useless:12,user:[4,10,12,15],usr:15,usual:12,util:[],valid:[1,3,8,10,12],valu:[1,2,3,5,6,8,9,12,13,14,15],valueerror:[6,8,9,10,14],var_nam:15,variabl:[0,2,6,8,9,14,15],variable_nam:6,variable_unit:6,variable_unit_convers:9,variou:[0,12,15],veri:[2,3,12],version:13,visit:0,wai:[3,12,15],want:[0,1,4,5,12],water:9,water_flux_unit_convers:9,web:[],webservic:[],websit:2,weight:14,well:[0,3,4,8,10,14,15],were:12,what:[0,1,5,12],when:[6,10,11,12,13,14,15],where:[0,1,2,3,6,8,10,12,13,15],whether:13,which:[0,1,6,9,10,11,12,14,15],whose:14,width:13,wiki:12,wish:15,within:[9,12,14,15],without:[8,9],won:12,work:[4,15],work_dir:15,workbench:[],would:[12,15],wouldn:12,wrapper:6,wrf311_ctl_eraint_mm_50km:[0,2],wrf:6,wrf_bias_compared_to_knmi:[0,5],write_netcd
f:9,writer:[],written:[0,15],www:14,xlabel:13,yaml:[0,1],yannick:13,ycopin:13,year:[9,14],yearli:[12,15],ylabel:13,you:[0,1,2,3,4,5,6,10,12,13,14,15],your:[0,2,3,4,12],yscale:13,yvalu:13,zosstderr:2},titles:["Configuration File Overview","Configuration File Writer API","Dataset Information","Evaluation Settings","Metrics Information","Plots Settings","Data Sources","Welcome to Apache Open Climate Workbench’s documentation!","Dataset Module","Dataset Processor Module","Evaluation Module","Metrics Module","Overview","Plotter Module","Utils Module","Evaluation UI Webservices"],titleterms:{"abstract":12,apach:7,api:1,bound:[3,8],climat:7,common:12,config:0,configur:[0,1,15],contour:5,dap:6,data:[6,12],dataset:[0,2,8,9,12],depend:15,directori:15,document:7,endpoint:15,esgf:[2,6],evalu:[0,3,10,12,15],exampl:0,explan:15,extractor:15,file:[0,1,15],get:0,handl:12,helper:15,indic:7,inform:[0,2,4],local:[2,6,15],manipul:12,map:5,metadata:15,metric:[0,4,11,12],modul:[6,8,9,10,11,13,14],op
en:7,opendap:2,overview:[0,12],plot:[0,5,12],plotter:13,process:15,processor:9,rcmed:[2,6,15],rebin:3,regrid:3,run:0,servic:15,set:[0,3,5],sourc:[6,12],spatial:3,start:0,subset:3,tabl:7,tempor:3,util:14,web:15,webservic:15,welcom:7,workbench:7,write:0,writer:1}})
\ No newline at end of file
Added: climate/site/trunk/content/api/1.1.0/ui-backend/backend.html
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/1.1.0/ui-backend/backend.html?rev=1792548&view=auto
==============================================================================
--- climate/site/trunk/content/api/1.1.0/ui-backend/backend.html (added)
+++ climate/site/trunk/content/api/1.1.0/ui-backend/backend.html Mon Apr 24 21:36:16 2017
@@ -0,0 +1,709 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Evaluation UI Webservices — Apache Open Climate Workbench 1.1.0 documentation</title>
+
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '1.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 1.1.0 documentation" href="../index.html" />
+ <link rel="next" title="Configuration File Overview" href="../config/config_overview.html" />
+ <link rel="prev" title="Data Sources" href="../data_source/data_sources.html" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+ </head>
+ <body role="document">
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="../config/config_overview.html" title="Configuration File Overview"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="../data_source/data_sources.html" title="Data Sources"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="../index.html">Apache Open Climate Workbench 1.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="evaluation-ui-webservices">
+<h1>Evaluation UI Webservices<a class="headerlink" href="#evaluation-ui-webservices" title="Permalink to this headline">¶</a></h1>
+<p>The OCW evaluation UI is a demonstration web application that is built upon the
+OCW toolkit. The web services for the application are written in Python on top
+of the Bottle Web Framework.</p>
+<div class="section" id="configuration-and-dependencies">
+<h2>Configuration and Dependencies<a class="headerlink" href="#configuration-and-dependencies" title="Permalink to this headline">¶</a></h2>
+<p>The Evaluation UI is built on top of the OCW toolkit and as such requires it to
+function properly. Please check the toolkit’s documentation for relevant
+installation instructions. You will also need to ensure that you have Bottle
+installed. You can install it with:</p>
+<div class="code highlight-python"><div class="highlight"><pre>pip install bottle
+</pre></div>
+</div>
+<p>The backend serves the static files for the evaluation frontend as well. If you
+plan to use the frontend you need to ensure that the <em>app</em> directory is present
+in the main web service directory. The easiest way to do this is to create a
+symbolic link where the <em>run_webservices</em> module is located. Assuming you have
+the entire <em>ocw-ui</em> directory, you can do this with the following command.</p>
+<div class="code highlight-python"><div class="highlight"><pre>cd ocw-ui/backend
+ln -s ../frontend/app app
+</pre></div>
+</div>
+<p>Finally, to start the backend just run the following command.</p>
+<div class="code highlight-python"><div class="highlight"><pre>python run_webservices.py
+</pre></div>
+</div>
+</div>
+<div class="section" id="web-service-explanation">
+<h2>Web Service Explanation<a class="headerlink" href="#web-service-explanation" title="Permalink to this headline">¶</a></h2>
+<p>The backend endpoints are broken up into a number of modules for ease of
+maintenance and understanding. The <em>run_webservices</em> module is the primary
+application module. It brings together all the various submodules into a
+useful system. It also defines a number of helpful endpoints for returning
+static files such as the index page, CSS files, JavaScript files, and more.</p>
+<div class="section" id="local-file-metadata-extractors">
+<h3>Local File Metadata Extractors<a class="headerlink" href="#local-file-metadata-extractors" title="Permalink to this headline">¶</a></h3>
+<p>The <em>local_file_metadata_extractors</em> module contains all the endpoints that are
+used to strip information out of various objects for display in the UI. At the
+moment, the main functionality is stripping out metadata from NetCDF files when
+a user wishes to <em>load</em> a local file into the evaluation.</p>
+<dl class="get">
+<dt id="get--list_latlon-(file_path-path)">
+<code class="descname">GET </code><code class="descname">/list_latlon/</code><span class="sig-paren">(</span><em class="property">file_path: </em><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#get--list_latlon-(file_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve lat/lon information from given file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>file_path</strong> (<em>string:</em>) – Path to the NetCDF file from which lat/lon information
+should be extracted</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing lat/lon information if successful, otherwise
+failure information is returned.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'success'</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="s1">'lat_name'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">guessed</span> <span class="nx">latitude</span> <span class="nx">variable</span> <span class="nx">name</span><span class="p">,</span>
+ <span class="s1">'lon_name'</span><span class="o">:</span> <span class="nx">the</span> <span class="nx">guessed</span> <span class="nx">longitude</span> <span class="nx">variable</span> <span class="nx">name</span><span class="p">,</span>
+ <span class="s1">'lat_min'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lat_max'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lon_min'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lon_max'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">longitude</span> <span class="nx">value</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'success'</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
+ <span class="s1">'variables'</span><span class="o">:</span> <span class="nx">List</span> <span class="nx">of</span> <span class="nx">all</span> <span class="nx">variables</span> <span class="nx">present</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">NetCDF</span> <span class="nx">file</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--list_time-(file_path-path)">
+<code class="descname">GET </code><code class="descname">/list_time/</code><span class="sig-paren">(</span><em class="property">file_path: </em><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#get--list_time-(file_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve time information from provided file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>file_path</strong> (<em>String:</em>) – Path to the NetCDF file from which time information
+should be extracted</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing time information if successful, otherwise
+failure information is returned.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"success"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="s2">"time_name"</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">guessed</span> <span class="nx">time</span> <span class="nx">variable</span> <span class="nx">name</span><span class="p">,</span>
+ <span class="s2">"start_time"</span><span class="o">:</span> <span class="s2">"1988-06-10 00:00:00"</span><span class="p">,</span>
+ <span class="s2">"end_time"</span><span class="o">:</span> <span class="s2">"2008-01-27 00:00:00"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"success"</span><span class="o">:</span> <span class="kc">false</span>
+ <span class="s2">"variables"</span><span class="o">:</span> <span class="nx">List</span> <span class="nx">of</span> <span class="nx">all</span> <span class="nx">variable</span> <span class="nx">names</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">file</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--list_vars-(file_path-path)">
+<code class="descname">GET </code><code class="descname">/list_vars/</code><span class="sig-paren">(</span><em class="property">file_path: </em><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#get--list_vars-(file_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve variable names from file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>file_path</strong> (<em>String:</em>) – Path to the NetCDF file from which variable information
+should be extracted</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing variable information if succesful, otherwise
+failure information is returned.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"success"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="s2">"variables"</span><span class="o">:</span> <span class="nx">List</span> <span class="nx">of</span> <span class="nx">variable</span> <span class="nx">names</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">file</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"success"</span><span class="o">:</span> <span class="kc">false</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="directory-helpers">
+<h3>Directory Helpers<a class="headerlink" href="#directory-helpers" title="Permalink to this headline">¶</a></h3>
+<p>The <em>directory_helpers</em> module contains a number of endpoints for working
+directory manipulation. The frontend uses these endpoints to grab directory
+information (within a prefix path for security), return result directory
+information, and other things.</p>
+<dl class="get">
+<dt id="get--list-(dir_path-path)">
+<code class="descname">GET </code><code class="descname">/list/</code><span class="sig-paren">(</span><em class="property">dir_path: </em><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#get--list-(dir_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the listing of a supplied path.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dir_path</strong> (<em>String</em>) – The directory path to list.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing the directory listing if possible.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
+ <span class="s1">'/bar/'</span><span class="p">,</span>
+ <span class="s1">'/baz.txt'</span><span class="p">,</span>
+ <span class="s1">'/test.txt'</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span><span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--list-">
+<code class="descname">GET </code><code class="descname">/list/</code><a class="headerlink" href="#get--list-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the listing of a supplied path.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dir_path</strong> (<em>String</em>) – The directory path to list.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary containing the directory listing if possible.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example successful JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
+ <span class="s1">'/bar/'</span><span class="p">,</span>
+ <span class="s1">'/baz.txt'</span><span class="p">,</span>
+ <span class="s1">'/test.txt'</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Example failure JSON return</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span><span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--results-">
+<code class="descname">GET </code><code class="descname">/results/</code><a class="headerlink" href="#get--results-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve results directory information.</p>
+<p>The backend’s results directory is determined by WORK_DIR. All the
+directories there are formatted and returned as results. If WORK_DIR does
+not exist, an empty listing will be returned (shown as a ‘failure below’).</p>
+<p><strong>Successful JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
+ <span class="s1">'/bar'</span><span class="p">,</span>
+ <span class="s1">'/foo'</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Failure JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--results-(dir_path-path)">
+<code class="descname">GET </code><code class="descname">/results/</code><span class="sig-paren">(</span><em class="property">dir_path: </em><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#get--results-(dir_path-path)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve specific result files.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dir_path</strong> (<em>String</em>) – The relative results path to list.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary of the requested result’s directory listing.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Successful JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'listing'</span><span class="o">:</span> <span class="p">[</span>
+ <span class="s1">'file1'</span><span class="p">,</span>
+ <span class="s1">'file2'</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Failure JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'listing'</span><span class="o">:</span> <span class="p">[]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--path_leader-">
+<code class="descname">GET </code><code class="descname">/path_leader/</code><a class="headerlink" href="#get--path_leader-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the path leader used for clean path creation.</p>
+<p><strong>Example JSON Response</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span><span class="s1">'leader'</span><span class="o">:</span> <span class="s1">'/usr/local/ocw'</span><span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="rcmed-helpers">
+<h3>RCMED Helpers<a class="headerlink" href="#rcmed-helpers" title="Permalink to this headline">¶</a></h3>
+<p>The <em>rcmed_helpers</em> module contains endpoints for loading datasets from the
+Regional Climate Model Evaluation Database at NASA’s Jet Propulsion Laboratory.</p>
+<dl class="get">
+<dt id="get--datasets-">
+<code class="descname">GET </code><code class="descname">/datasets/</code><a class="headerlink" href="#get--datasets-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return a list of dataset information from JPL’s RCMED.</p>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"dataset_id"</span><span class="o">:</span> <span class="s2">"17"</span><span class="p">,</span>
+ <span class="s2">"shortname"</span><span class="o">:</span> <span class="s2">"The dataset's short name"</span><span class="p">,</span>
+ <span class="s2">"longname"</span><span class="o">:</span> <span class="s2">"The dataset's, full name"</span><span class="p">,</span>
+ <span class="s2">"source"</span><span class="o">:</span> <span class="s2">"Where the dataset originated"</span>
+ <span class="p">},</span>
+ <span class="p">...</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--parameters-">
+<code class="descname">GET </code><code class="descname">/parameters/</code><a class="headerlink" href="#get--parameters-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return dataset specific parameter information from JPL’s RCMED.</p>
+<p><strong>Example Call Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre>/parameters/?dataset=<dataset's short name>
+</pre></div>
+</div>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"parameter_id"</span><span class="o">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"shortname"</span><span class="o">:</span> <span class="s2">"The dataset's short name"</span><span class="p">,</span>
+ <span class="s2">"datasetshortname"</span><span class="o">:</span> <span class="s2">"The dataset's short name again"</span><span class="p">,</span>
+ <span class="s2">"longname"</span><span class="o">:</span> <span class="s2">"The dataset's long name"</span><span class="p">,</span>
+ <span class="s2">"units"</span><span class="o">:</span> <span class="s2">"Units for the dataset's measurements"</span>
+ <span class="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--parameters-bounds">
+<code class="descname">GET </code><code class="descname">/parameters/bounds</code><a class="headerlink" href="#get--parameters-bounds" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return temporal and spatial bounds metadata for all of JPL’s RCMED parameters.</p>
+<p><strong>Example Call Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre>/parameters/bounds/
+</pre></div>
+</div>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"38"</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"1901-01-15"</span><span class="p">,</span>
+ <span class="s2">"end_date"</span><span class="o">:</span> <span class="s2">"2009-12-15"</span><span class="p">,</span>
+ <span class="s2">"lat_max"</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lat_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lon_max"</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+ <span class="s2">"lon_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+ <span class="p">},</span>
+ <span class="s2">"39"</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"1901-01-15"</span><span class="p">,</span>
+ <span class="s2">"end_date"</span><span class="o">:</span> <span class="s2">"2009-12-15"</span><span class="p">,</span>
+ <span class="s2">"lat_max"</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lat_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lon_max"</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+ <span class="s2">"lon_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--parameters-bounds-">
+<code class="descname">GET </code><code class="descname">/parameters/bounds/</code><a class="headerlink" href="#get--parameters-bounds-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return temporal and spatial bounds metadata for all of JPL’s RCMED parameters.</p>
+<p><strong>Example Call Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre>/parameters/bounds/
+</pre></div>
+</div>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"38"</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"1901-01-15"</span><span class="p">,</span>
+ <span class="s2">"end_date"</span><span class="o">:</span> <span class="s2">"2009-12-15"</span><span class="p">,</span>
+ <span class="s2">"lat_max"</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lat_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lon_max"</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+ <span class="s2">"lon_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+ <span class="p">},</span>
+ <span class="s2">"39"</span><span class="o">:</span> <span class="p">{</span>
+ <span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"1901-01-15"</span><span class="p">,</span>
+ <span class="s2">"end_date"</span><span class="o">:</span> <span class="s2">"2009-12-15"</span><span class="p">,</span>
+ <span class="s2">"lat_max"</span><span class="o">:</span> <span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lat_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">89.75</span><span class="p">,</span>
+ <span class="s2">"lon_max"</span><span class="o">:</span> <span class="mf">179.75</span><span class="p">,</span>
+ <span class="s2">"lon_min"</span><span class="o">:</span> <span class="o">-</span><span class="mf">179.75</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="processing-endpoints">
+<h3>Processing Endpoints<a class="headerlink" href="#processing-endpoints" title="Permalink to this headline">¶</a></h3>
+<p>The <em>processing</em> module contains all the endpoints related to the running of
+evaluations.</p>
+<dl class="get">
+<dt id="get--metrics-">
+<code class="descname">GET </code><code class="descname">/metrics/</code><a class="headerlink" href="#get--metrics-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve available metric names.</p>
+<p><strong>Example Return JSON Format</strong></p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s1">'metrics'</span><span class="o">:</span> <span class="p">[</span>
+ <span class="s1">'MetricName1'</span><span class="p">,</span>
+ <span class="s1">'MetricName2'</span><span class="p">,</span>
+ <span class="p">...</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="post">
+<dt id="post--run_evaluation-">
+<code class="descname">POST </code><code class="descname">/run_evaluation/</code><a class="headerlink" href="#post--run_evaluation-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Run an OCW Evaluation.</p>
+<p><em>run_evaluation</em> expects the Evaluation parameters to be POSTed in
+the following format.</p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="nx">reference_dataset</span><span class="o">:</span> <span class="p">{</span>
+ <span class="c1">// Id that tells us how we need to load this dataset.</span>
+ <span class="s1">'data_source_id'</span><span class="o">:</span> <span class="mi">1</span> <span class="o">==</span> <span class="nx">local</span><span class="p">,</span> <span class="mi">2</span> <span class="o">==</span> <span class="nx">rcmed</span><span class="p">,</span>
+
+ <span class="c1">// Dict of data_source specific identifying information.</span>
+ <span class="c1">//</span>
+ <span class="c1">// if data_source_id == 1 == local:</span>
+ <span class="c1">// {</span>
+ <span class="c1">// 'id': The path to the local file on the server for loading.</span>
+ <span class="c1">// 'var_name': The variable data to pull from the file.</span>
+ <span class="c1">// 'lat_name': The latitude variable name.</span>
+ <span class="c1">// 'lon_name': The longitude variable name.</span>
+ <span class="c1">// 'time_name': The time variable name</span>
+ <span class="c1">// 'name': Optional dataset name</span>
+ <span class="c1">// }</span>
+ <span class="c1">//</span>
+ <span class="c1">// if data_source_id == 2 == rcmed:</span>
+ <span class="c1">// {</span>
+ <span class="c1">// 'dataset_id': The dataset id to grab from RCMED.</span>
+ <span class="c1">// 'parameter_id': The variable id value used by RCMED.</span>
+ <span class="c1">// 'name': Optional dataset name</span>
+ <span class="c1">// }</span>
+ <span class="s1">'dataset_info'</span><span class="o">:</span> <span class="p">{..}</span>
+ <span class="p">},</span>
+
+ <span class="c1">// The list of target datasets to use in the Evaluation. The data</span>
+ <span class="c1">// format for the dataset objects should be the same as the</span>
+ <span class="c1">// reference_dataset above.</span>
+ <span class="s1">'target_datasets'</span><span class="o">:</span> <span class="p">[{...},</span> <span class="p">{...},</span> <span class="p">...],</span>
+
+ <span class="c1">// All the datasets are re-binned to the reference dataset</span>
+ <span class="c1">// before being added to an experiment. This step (in degrees)</span>
+ <span class="c1">// is used when re-binning both the reference and target datasets.</span>
+ <span class="s1">'spatial_rebin_lat_step'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">lat</span> <span class="nx">degree</span> <span class="nx">step</span><span class="p">.</span> <span class="nx">Integer</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span>
+
+ <span class="c1">// Same as above, but for lon</span>
+ <span class="s1">'spatial_rebin_lon_step'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">lon</span> <span class="nx">degree</span> <span class="nx">step</span><span class="p">.</span> <span class="nx">Integer</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span>
+
+ <span class="c1">// The temporal resolution to use when doing a temporal re-bin</span>
+ <span class="c1">// This is a timedelta of days to use so daily == 1, monthly is</span>
+ <span class="c1">// (1, 31], annual/yearly is (31, 366], and full is anything > 366.</span>
+ <span class="s1">'temporal_resolution'</span><span class="o">:</span> <span class="nx">Integer</span> <span class="k">in</span> <span class="nx">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">999</span><span class="p">),</span>
+
+ <span class="c1">// A list of the metric class names to use in the evaluation. The</span>
+ <span class="c1">// names must match the class name exactly.</span>
+ <span class="s1">'metrics'</span><span class="o">:</span> <span class="p">[</span><span class="nx">Bias</span><span class="p">,</span> <span class="nx">TemporalStdDev</span><span class="p">,</span> <span class="p">...]</span>
+
+ <span class="c1">// The bounding values used in the Evaluation. Note that lat values</span>
+ <span class="c1">// should range from -180 to 180 and lon values from -90 to 90.</span>
+ <span class="s1">'start_time'</span><span class="o">:</span> <span class="nx">start</span> <span class="nx">time</span> <span class="nx">value</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">format</span> <span class="s1">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'end_time'</span><span class="o">:</span> <span class="nx">end</span> <span class="nx">time</span> <span class="nx">value</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">format</span> <span class="s1">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'lat_min'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lat_max'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lon_min'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lon_max'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+
+ <span class="c1">// NOTE: At the moment, subregion support is fairly minimal. This</span>
+ <span class="c1">// will be addressed in the future. Ideally, the user should be able</span>
+ <span class="c1">// to load a file that they have locally. That would change the</span>
+ <span class="c1">// format that this data is passed.</span>
+ <span class="s1">'subregion_information'</span><span class="o">:</span> <span class="nx">Path</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">subregion</span> <span class="nx">file</span> <span class="nx">on</span> <span class="nx">the</span> <span class="nx">server</span><span class="p">.</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="options">
+<dt id="options--run_evaluation-">
+<code class="descname">OPTIONS </code><code class="descname">/run_evaluation/</code><a class="headerlink" href="#options--run_evaluation-" title="Permalink to this definition">¶</a></dt>
+<dd><p>Run an OCW Evaluation.</p>
+<p><em>run_evaluation</em> expects the Evaluation parameters to be POSTed in
+the following format.</p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+ <span class="nx">reference_dataset</span><span class="o">:</span> <span class="p">{</span>
+ <span class="c1">// Id that tells us how we need to load this dataset.</span>
+ <span class="s1">'data_source_id'</span><span class="o">:</span> <span class="mi">1</span> <span class="o">==</span> <span class="nx">local</span><span class="p">,</span> <span class="mi">2</span> <span class="o">==</span> <span class="nx">rcmed</span><span class="p">,</span>
+
+ <span class="c1">// Dict of data_source specific identifying information.</span>
+ <span class="c1">//</span>
+ <span class="c1">// if data_source_id == 1 == local:</span>
+ <span class="c1">// {</span>
+ <span class="c1">// 'id': The path to the local file on the server for loading.</span>
+ <span class="c1">// 'var_name': The variable data to pull from the file.</span>
+ <span class="c1">// 'lat_name': The latitude variable name.</span>
+ <span class="c1">// 'lon_name': The longitude variable name.</span>
+ <span class="c1">// 'time_name': The time variable name</span>
+ <span class="c1">// 'name': Optional dataset name</span>
+ <span class="c1">// }</span>
+ <span class="c1">//</span>
+ <span class="c1">// if data_source_id == 2 == rcmed:</span>
+ <span class="c1">// {</span>
+ <span class="c1">// 'dataset_id': The dataset id to grab from RCMED.</span>
+ <span class="c1">// 'parameter_id': The variable id value used by RCMED.</span>
+ <span class="c1">// 'name': Optional dataset name</span>
+ <span class="c1">// }</span>
+ <span class="s1">'dataset_info'</span><span class="o">:</span> <span class="p">{..}</span>
+ <span class="p">},</span>
+
+ <span class="c1">// The list of target datasets to use in the Evaluation. The data</span>
+ <span class="c1">// format for the dataset objects should be the same as the</span>
+ <span class="c1">// reference_dataset above.</span>
+ <span class="s1">'target_datasets'</span><span class="o">:</span> <span class="p">[{...},</span> <span class="p">{...},</span> <span class="p">...],</span>
+
+ <span class="c1">// All the datasets are re-binned to the reference dataset</span>
+ <span class="c1">// before being added to an experiment. This step (in degrees)</span>
+ <span class="c1">// is used when re-binning both the reference and target datasets.</span>
+ <span class="s1">'spatial_rebin_lat_step'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">lat</span> <span class="nx">degree</span> <span class="nx">step</span><span class="p">.</span> <span class="nx">Integer</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span>
+
+ <span class="c1">// Same as above, but for lon</span>
+ <span class="s1">'spatial_rebin_lon_step'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">lon</span> <span class="nx">degree</span> <span class="nx">step</span><span class="p">.</span> <span class="nx">Integer</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span>
+
+ <span class="c1">// The temporal resolution to use when doing a temporal re-bin</span>
+ <span class="c1">// This is a timedelta of days to use so daily == 1, monthly is</span>
+ <span class="c1">// (1, 31], annual/yearly is (31, 366], and full is anything > 366.</span>
+ <span class="s1">'temporal_resolution'</span><span class="o">:</span> <span class="nx">Integer</span> <span class="k">in</span> <span class="nx">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">999</span><span class="p">),</span>
+
+ <span class="c1">// A list of the metric class names to use in the evaluation. The</span>
+ <span class="c1">// names must match the class name exactly.</span>
+ <span class="s1">'metrics'</span><span class="o">:</span> <span class="p">[</span><span class="nx">Bias</span><span class="p">,</span> <span class="nx">TemporalStdDev</span><span class="p">,</span> <span class="p">...]</span>
+
+ <span class="c1">// The bounding values used in the Evaluation. Note that lat values</span>
+ <span class="c1">// should range from -180 to 180 and lon values from -90 to 90.</span>
+ <span class="s1">'start_time'</span><span class="o">:</span> <span class="nx">start</span> <span class="nx">time</span> <span class="nx">value</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">format</span> <span class="s1">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'end_time'</span><span class="o">:</span> <span class="nx">end</span> <span class="nx">time</span> <span class="nx">value</span> <span class="k">in</span> <span class="nx">the</span> <span class="nx">format</span> <span class="s1">'%Y-%m-%d %H:%M:%S'</span><span class="p">,</span>
+ <span class="s1">'lat_min'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lat_max'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">latitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lon_min'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">minimum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+ <span class="s1">'lon_max'</span><span class="o">:</span> <span class="nx">The</span> <span class="nx">maximum</span> <span class="nx">longitude</span> <span class="nx">value</span><span class="p">,</span>
+
+ <span class="c1">// NOTE: At the moment, subregion support is fairly minimal. This</span>
+ <span class="c1">// will be addressed in the future. Ideally, the user should be able</span>
+ <span class="c1">// to load a file that they have locally. That would change the</span>
+ <span class="c1">// format that this data is passed.</span>
+ <span class="s1">'subregion_information'</span><span class="o">:</span> <span class="nx">Path</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">subregion</span> <span class="nx">file</span> <span class="nx">on</span> <span class="nx">the</span> <span class="nx">server</span><span class="p">.</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/ocw-logo-variant-sm-01-01-new.png" alt="Logo"/>
+ </a></p>
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Evaluation UI Webservices</a><ul>
+<li><a class="reference internal" href="#configuration-and-dependencies">Configuration and Dependencies</a></li>
+<li><a class="reference internal" href="#web-service-explanation">Web Service Explanation</a><ul>
+<li><a class="reference internal" href="#local-file-metadata-extractors">Local File Metadata Extractors</a></li>
+<li><a class="reference internal" href="#directory-helpers">Directory Helpers</a></li>
+<li><a class="reference internal" href="#rcmed-helpers">RCMED Helpers</a></li>
+<li><a class="reference internal" href="#processing-endpoints">Processing Endpoints</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="../data_source/data_sources.html"
+ title="previous chapter">Data Sources</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="../config/config_overview.html"
+ title="next chapter">Configuration File Overview</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/ui-backend/backend.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+ </div>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2016, Apache Software Foundation.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.4</a>
+
+ |
+ <a href="../_sources/ui-backend/backend.txt"
+ rel="nofollow">Page source</a></li>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
Modified: climate/site/trunk/content/api/current/_sources/data_source/data_sources.txt
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_sources/data_source/data_sources.txt?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_sources/data_source/data_sources.txt (original)
+++ climate/site/trunk/content/api/current/_sources/data_source/data_sources.txt Mon Apr 24 21:36:16 2017
@@ -20,3 +20,8 @@ ESGF Module
===========
.. automodule:: esgf
:members:
+
+PODAAC Module
+=============
+.. automodule:: podaac_datasource
+ :members:
Modified: climate/site/trunk/content/api/current/_sources/index.txt
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_sources/index.txt?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_sources/index.txt (original)
+++ climate/site/trunk/content/api/current/_sources/index.txt Mon Apr 24 21:36:16 2017
@@ -13,6 +13,7 @@ Contents:
ocw/overview
ocw/dataset
+ ocw/dataset_loader
ocw/dataset_processor
ocw/evaluation
ocw/metrics
@@ -33,4 +34,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-
Added: climate/site/trunk/content/api/current/_sources/ocw/dataset_loader.txt
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_sources/ocw/dataset_loader.txt?rev=1792548&view=auto
==============================================================================
--- climate/site/trunk/content/api/current/_sources/ocw/dataset_loader.txt (added)
+++ climate/site/trunk/content/api/current/_sources/ocw/dataset_loader.txt Mon Apr 24 21:36:16 2017
@@ -0,0 +1,5 @@
+Dataset Loader Module
+*********************
+
+.. automodule:: dataset_loader
+ :members:
Modified: climate/site/trunk/content/api/current/_sources/ocw/overview.txt
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_sources/ocw/overview.txt?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_sources/ocw/overview.txt (original)
+++ climate/site/trunk/content/api/current/_sources/ocw/overview.txt Mon Apr 24 21:36:16 2017
@@ -12,7 +12,7 @@ The Apache Open Climate Workbench toolki
Common Data Abstraction
-----------------------
-The OCW :class:`dataset.Dataset` class is the primary data abstraction used throughout OCW. It facilitates the uniform handling of data throughout the toolkit and provides a few useful helper functions such as :func:`dataset.Dataset.spatial_boundaries` and :func:`dataset.Dataset.time_range`. Creating a new dataset object is straightforward but generally you will want to use an OCW data source to load the data for you.
+The OCW :class:`dataset.Dataset` class is the primary data abstraction used throughout OCW. It facilitates the uniform handling of data throughout the toolkit and provides a few useful helper functions such as :func:`dataset.Dataset.spatial_boundaries` and :func:`dataset.Dataset.temporal_boundaries`. Creating a new dataset object is straightforward but generally you will want to use an OCW data source to load the data for you.
Data Sources
------------
@@ -35,7 +35,7 @@ Subsetting is a great way to speed up yo
>>> import ocw.dataset_processor as dsp
>>> new_bounds = Bounds(min_lat, max_lat, min_lon, max_lon, start_time, end_time)
->>> knmi_dataset = dsp.subset(new_bounds, knmi_dataset)
+>>> knmi_dataset = dsp.subset(knmi_dataset, new_bounds)
Temporally re-binning a dataset is great when the time step of the data is too fine grain for the desired use. For instance, perhaps we want to see a yearly trend but we have daily data. We would need to make the following call to adjust our dataset::
Modified: climate/site/trunk/content/api/current/_static/alabaster.css
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_static/alabaster.css?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_static/alabaster.css (original)
+++ climate/site/trunk/content/api/current/_static/alabaster.css Mon Apr 24 21:36:16 2017
@@ -18,6 +18,38 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
@@ -25,12 +57,13 @@
body {
font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
font-size: 17px;
- background-color: white;
+ background-color: #fff;
color: #000;
margin: 0;
padding: 0;
}
+
div.document {
width: 940px;
margin: 30px auto 0 auto;
@@ -47,6 +80,8 @@ div.bodywrapper {
div.sphinxsidebar {
width: 220px;
+ font-size: 14px;
+ line-height: 1.5;
}
hr {
@@ -54,11 +89,15 @@ hr {
}
div.body {
- background-color: #ffffff;
+ background-color: #fff;
color: #3E4349;
padding: 0 30px 0 30px;
}
+div.body > .section {
+ text-align: left;
+}
+
div.footer {
width: 940px;
margin: 20px auto 30px auto;
@@ -71,10 +110,17 @@ div.footer a {
color: #888;
}
-div.related {
+p.caption {
+ font-family: inherit;
+ font-size: inherit;
+}
+
+
+div.relations {
display: none;
}
+
div.sphinxsidebar a {
color: #444;
text-decoration: none;
@@ -85,11 +131,6 @@ div.sphinxsidebar a:hover {
border-bottom: 1px solid #999;
}
-div.sphinxsidebar {
- font-size: 14px;
- line-height: 1.5;
-}
-
div.sphinxsidebarwrapper {
padding: 18px 10px;
}
@@ -169,8 +210,8 @@ div.sphinxsidebar input {
div.sphinxsidebar hr {
border: none;
height: 1px;
- color: #999;
- background: #999;
+ color: #AAA;
+ background: #AAA;
text-align: left;
margin-left: 0;
@@ -226,11 +267,12 @@ div.body p, div.body dd, div.body li {
div.admonition {
margin: 20px 0px;
padding: 10px 30px;
- background-color: #FCC;
- border: 1px solid #FAA;
+ background-color: #EEE;
+ border: 1px solid #CCC;
}
-div.admonition tt.xref, div.admonition a tt {
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+ background-color: ;
border-bottom: 1px solid #fafafa;
}
@@ -253,25 +295,71 @@ div.admonition p.last {
}
div.highlight {
- background-color: white;
+ background-color: #fff;
}
dt:target, .highlight {
background: #FAF3E8;
}
+div.warning {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.danger {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.error {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.caution {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.attention {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.important {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
div.note {
background-color: #EEE;
border: 1px solid #CCC;
}
+div.tip {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.hint {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
div.seealso {
background-color: #EEE;
border: 1px solid #CCC;
}
div.topic {
- background-color: #eee;
+ background-color: #EEE;
}
p.admonition-title {
@@ -306,16 +394,16 @@ tt.descname, code.descname {
}
img.screenshot {
- -moz-box-shadow: 2px 2px 4px #eee;
- -webkit-box-shadow: 2px 2px 4px #eee;
- box-shadow: 2px 2px 4px #eee;
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
}
table.docutils {
border: 1px solid #888;
- -moz-box-shadow: 2px 2px 4px #eee;
- -webkit-box-shadow: 2px 2px 4px #eee;
- box-shadow: 2px 2px 4px #eee;
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
}
table.docutils td, table.docutils th {
@@ -351,8 +439,12 @@ table.field-list td {
padding: 0;
}
+table.field-list p {
+ margin-bottom: 0.8em;
+}
+
table.footnote td.label {
- width: 0px;
+ width: .1px;
padding: 0.3em 0 0.3em 0.5em;
}
@@ -375,6 +467,7 @@ blockquote {
}
ul, ol {
+ /* Matches the 30px from the narrow-screen "li > ul" selector below */
margin: 10px 0 10px 30px;
padding: 0;
}
@@ -386,9 +479,13 @@ pre {
line-height: 1.3em;
}
+div.viewcode-block:target {
+ background: #ffd;
+}
+
dl pre, blockquote pre, li pre {
- margin-left: -60px;
- padding-left: 60px;
+ margin-left: 0;
+ padding-left: 30px;
}
dl dl pre {
@@ -404,7 +501,7 @@ tt, code {
tt.xref, code.xref, a tt {
background-color: #FBFBFB;
- border-bottom: 1px solid white;
+ border-bottom: 1px solid #fff;
}
a.reference {
@@ -412,6 +509,11 @@ a.reference {
border-bottom: 1px dotted #004B6B;
}
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+ border-bottom: none;
+}
+
a.reference:hover {
border-bottom: 1px solid #6D4100;
}
@@ -461,6 +563,11 @@ a:hover tt, a:hover code {
margin-left: 0;
}
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
+
.document {
width: auto;
}
@@ -496,7 +603,7 @@ a:hover tt, a:hover code {
div.documentwrapper {
float: none;
- background: white;
+ background: #fff;
}
div.sphinxsidebar {
@@ -511,7 +618,7 @@ a:hover tt, a:hover code {
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
div.sphinxsidebar h3 a {
- color: white;
+ color: #fff;
}
div.sphinxsidebar a {
@@ -527,18 +634,6 @@ a:hover tt, a:hover code {
margin: 0;
}
- div.related {
- display: block;
- margin: 0;
- padding: 10px 0 20px 0;
- }
-
- div.related ul,
- div.related ul li {
- margin: 0;
- padding: 0;
- }
-
div.footer {
display: none;
}
Modified: climate/site/trunk/content/api/current/_static/basic.css
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_static/basic.css?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_static/basic.css (original)
+++ climate/site/trunk/content/api/current/_static/basic.css Mon Apr 24 21:36:16 2017
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -52,6 +52,8 @@ div.sphinxsidebar {
width: 230px;
margin-left: -100%;
font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
}
div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type=
width: 170px;
}
-div.sphinxsidebar #searchbox input[type="submit"] {
- width: 30px;
-}
-
img {
border: 0;
max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
/* -- general body styles --------------------------------------------------- */
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
a.headerlink {
visibility: hidden;
}
@@ -489,6 +494,13 @@ pre {
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+}
+
td.linenos pre {
padding: 5px 0px;
border: 0;
Added: climate/site/trunk/content/api/current/_static/custom.css
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_static/custom.css?rev=1792548&view=auto
==============================================================================
--- climate/site/trunk/content/api/current/_static/custom.css (added)
+++ climate/site/trunk/content/api/current/_static/custom.css Mon Apr 24 21:36:16 2017
@@ -0,0 +1 @@
+/* This file intentionally left blank. */
Modified: climate/site/trunk/content/api/current/_static/doctools.js
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_static/doctools.js?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_static/doctools.js (original)
+++ climate/site/trunk/content/api/current/_static/doctools.js Mon Apr 24 21:36:16 2017
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -124,6 +124,7 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
+
},
/**
@@ -252,6 +253,29 @@ var Documentation = {
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+ },
+
+ initOnKeyListeners: function() {
+ $(document).keyup(function(event) {
+ var activeElementType = document.activeElement.tagName;
+ // don't navigate when in search box or textarea
+ if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
+ switch (event.keyCode) {
+ case 37: // left
+ var prevHref = $('link[rel="prev"]').prop('href');
+ if (prevHref) {
+ window.location.href = prevHref;
+ return false;
+ }
+ case 39: // right
+ var nextHref = $('link[rel="next"]').prop('href');
+ if (nextHref) {
+ window.location.href = nextHref;
+ return false;
+ }
+ }
+ }
+ });
}
};
@@ -260,4 +284,4 @@ _ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
-});
+});
\ No newline at end of file
Modified: climate/site/trunk/content/api/current/_static/pygments.css
URL: http://svn.apache.org/viewvc/climate/site/trunk/content/api/current/_static/pygments.css?rev=1792548&r1=1792547&r2=1792548&view=diff
==============================================================================
--- climate/site/trunk/content/api/current/_static/pygments.css (original)
+++ climate/site/trunk/content/api/current/_static/pygments.css Mon Apr 24 21:36:16 2017
@@ -4,8 +4,10 @@
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */