diff --git a/docs/_build/doctrees/crow.utils.doctree b/docs/_build/doctrees/crow.utils.doctree index 04e059b..9caf85a 100644 Binary files a/docs/_build/doctrees/crow.utils.doctree and b/docs/_build/doctrees/crow.utils.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 6062867..c180a4e 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/html/crow.utils.html b/docs/_build/html/crow.utils.html index c490bc6..e0779f1 100644 --- a/docs/_build/html/crow.utils.html +++ b/docs/_build/html/crow.utils.html @@ -90,9 +90,16 @@

Submodules
crow.utils.ParseXML.ParseXML(filename)
-

One line passthrough to xml element tree, returns root of tree

-
-
filename: string which gives either the absolute or relative path

to an xml file

+

One line passthrough to xml element tree.

+
+
Parameters
+

filename (string) – the absolute or relative path to an xml file

+
+
Returns
+

root of tree

+
+
Return type
+

etree

@@ -107,12 +114,19 @@

crow.utils.RequestFiles module class crow.utils.crow_globals.crow_globals(config='config.yaml')

Bases: object

-

variables which are used by all tabs in the window, such as the path to -the server of raw data.

+

Class which initializes itself using the config.yaml file, making +variables which are used by all tabs of crow accesible in the ‘global’ +namespace (but without using global variables).

__init__(config='config.yaml')
-
+

Opens the configuration file and reads the contents into attritbutes.

+
+
Parameters
+

config (str, optional) – Configuration file. Defaults to “config.yaml”.

+
+
+

@@ -122,8 +136,12 @@

crow.utils.RequestFiles module
crow.utils.logger.mylog(e)
-

General purpose function for writing errors to an external .txt file

-

e: exception raised by Crow

+

General purpose function for writing errors to an external .txt file.

+
+
Parameters
+

e (exception) – exception raised by Crow

+
+
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index a243c93..1857edf 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["README","crow","crow.uitabs","crow.utils","crow.utils.popupwindows","index","modules","setup","test"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["README.rst","crow.rst","crow.uitabs.rst","crow.utils.rst","crow.utils.popupwindows.rst","index.rst","modules.rst","setup.rst","test.rst"],objects:{"":[[1,0,0,"-","crow"],[8,0,0,"-","test"]],"crow.utils":[[3,0,0,"-","ParseXML"],[3,0,0,"-","crow_globals"],[3,0,0,"-","logger"],[4,0,0,"-","popupwindows"]],"crow.utils.ParseXML":[[3,1,1,"","ParseXML"]],"crow.utils.crow_globals":[[3,2,1,"","crow_globals"]],"crow.utils.crow_globals.crow_globals":[[3,3,1,"","__init__"]],"crow.utils.logger":[[3,1,1,"","mylog"]],crow:[[2,0,0,"-","uitabs"],[3,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2019":0,"2020":0,"class":3,"function":3,"new":0,"return":3,A:0,For:0,If:0,One:3,To:0,__init__:3,absolut:3,acceler:5,access:0,activ:0,again:0,agil:0,all:[0,3],an:[0,3],ar:3,area:0,avail:0,base:3,bug:0,burn:0,calcul:0,can:0,code:0,command:0,comprehens:0,config:[0,3],configur:0,content:6,contribut:0,crow_glob:[1,6],crowht:0,cutoff:[1,3],data:[0,3],delawar:0,depth:0,design:0,detail:0,develop:0,diagnos:0,donald:0,e:3,either:3,element:3,eluat:0,environ:0,error:3,everi:0,exampl:0,except:3,exclud:[1,3],experi:0,experiment:5,extern:3,featur:0,file:[0,3],filenam:3,find:0,follow:0,from:0,gc:0,gener:3,give:3,help:0,here:0,high:5,how:0,hte:0,includ:0,index:[0,5],instal:5,instrument:0,jackson:0,lab:0,line:[0,3],local:0,logger:[1,6],me:0,messag:0,modifi:0,modul:[5,6],mylog:3,need:0,numberofcutoff:[1,3],object:3,one:0,open:0,our:0,out:0,output:0,packag:[0,6],page:5,pars:0,parsexml:[1,6],passthrough:3,path:3,peak:0,pip:0,pleas:0,popupwindow:[1,3],prepul:[1,6],present:[0,1,6],program:0,project:0,provid:0,pull:[0,1,6],purpos:3,pypi:0,python:0,rais:3,raw:3,rel:3,report:0,repositori:0,request:0,requestfil:[1,6],retriev:0,root:3,run:0,search:5,see:0,send:0,server:3,set:0,setup:[5,6],shadebyyield:[1,3],softwar:0,stage:0,start:0,step:0,still:0,string:3,submodul:6,subpackag:6,support:5,tab:3,templat:0,test:6,test_crow:6,thi:0,throughput:5,tree:3,tutori:0,txt:3,type:0,uitab:[1,6],under:0,univers:0,up:0,us:[3,5],util:[1,6],variabl:3,variou:0,video:0,watson:0,websit:0,which:3,window:3,work:0,workflow:0,write:3,xml:[0,3],yaml:[0,3],you:0,your:0},titles:["Crow - Accelerating High Throughput Experimentation","crow package","crow.uitabs package","crow.utils package","crow.utils.popupwindows package","Welcome to Crow\u2019s documentation!","Crow","setup module","test package"],titleterms:{acceler:0,content:[1,2,3,4,5,8],crow:[0,1,2,3,4,5,6],crow_glob:3,cutoff:4,document:5,exclud:4,experiment:0,high:0,indic:5,instal:0,logger:3,modul:[1,2,3,4,7,8],numberofcutoff:4,packag:[1,2,3,4,8],parsexml:3,popupwindow:4,prepul:2,present:2,pull:2,requestfil:3,s:5,setup:[0,7],shadebyyield:4,submodul:[1,2,3,4,8],subpackag:[1,3],support:0,tabl:5,test:8,test_crow:8,throughput:0,uitab:2,us:0,util:[3,4],welcom:5}}) \ No newline at end of file +Search.setIndex({docnames:["README","crow","crow.uitabs","crow.utils","crow.utils.popupwindows","index","modules","setup","test"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["README.rst","crow.rst","crow.uitabs.rst","crow.utils.rst","crow.utils.popupwindows.rst","index.rst","modules.rst","setup.rst","test.rst"],objects:{"":[[1,0,0,"-","crow"],[8,0,0,"-","test"]],"crow.utils":[[3,0,0,"-","ParseXML"],[3,0,0,"-","crow_globals"],[3,0,0,"-","logger"],[4,0,0,"-","popupwindows"]],"crow.utils.ParseXML":[[3,1,1,"","ParseXML"]],"crow.utils.crow_globals":[[3,2,1,"","crow_globals"]],"crow.utils.crow_globals.crow_globals":[[3,3,1,"","__init__"]],"crow.utils.logger":[[3,1,1,"","mylog"]],crow:[[2,0,0,"-","uitabs"],[3,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2019":0,"2020":0,"class":3,"default":3,"function":3,"new":0,"return":3,A:0,For:0,If:0,One:3,To:0,__init__:3,absolut:3,acceler:5,acces:3,access:0,activ:0,again:0,agil:0,all:[0,3],an:[0,3],ar:3,area:0,attritbut:3,avail:0,base:3,bug:0,burn:0,calcul:0,can:0,code:0,command:0,comprehens:0,config:[0,3],configur:[0,3],content:6,contribut:0,crow_glob:[1,6],crowht:0,cutoff:[1,3],data:0,delawar:0,depth:0,design:0,detail:0,develop:0,diagnos:0,donald:0,e:3,element:3,eluat:0,environ:0,error:3,etre:3,everi:0,exampl:0,except:3,exclud:[1,3],experi:0,experiment:5,extern:3,featur:0,file:[0,3],filenam:3,find:0,follow:0,from:0,gc:0,gener:3,global:3,help:0,here:0,high:5,how:0,hte:0,includ:0,index:[0,5],initi:3,instal:5,instrument:0,itself:3,jackson:0,lab:0,line:[0,3],local:0,logger:[1,6],make:3,me:0,messag:0,modifi:0,modul:[5,6],mylog:3,namespac:3,need:0,numberofcutoff:[1,3],object:3,one:0,open:[0,3],option:3,our:0,out:0,output:0,packag:[0,6],page:5,paramet:3,pars:0,parsexml:[1,6],passthrough:3,path:3,peak:0,pip:0,pleas:0,popupwindow:[1,3],prepul:[1,6],present:[0,1,6],program:0,project:0,provid:0,pull:[0,1,6],purpos:3,pypi:0,python:0,rais:3,read:3,rel:3,report:0,repositori:0,request:0,requestfil:[1,6],retriev:0,root:3,run:0,search:5,see:0,send:0,set:0,setup:[5,6],shadebyyield:[1,3],softwar:0,stage:0,start:0,step:0,still:0,str:3,string:3,submodul:6,subpackag:6,support:5,tab:3,templat:0,test:6,test_crow:6,thi:0,throughput:5,tree:3,tutori:0,txt:3,type:[0,3],uitab:[1,6],under:0,univers:0,up:0,us:[3,5],util:[1,6],variabl:3,variou:0,video:0,watson:0,websit:0,which:3,without:3,work:0,workflow:0,write:3,xml:[0,3],yaml:[0,3],you:0,your:0},titles:["Crow - Accelerating High Throughput Experimentation","crow package","crow.uitabs package","crow.utils package","crow.utils.popupwindows package","Welcome to Crow\u2019s documentation!","Crow","setup module","test package"],titleterms:{acceler:0,content:[1,2,3,4,5,8],crow:[0,1,2,3,4,5,6],crow_glob:3,cutoff:4,document:5,exclud:4,experiment:0,high:0,indic:5,instal:0,logger:3,modul:[1,2,3,4,7,8],numberofcutoff:4,packag:[1,2,3,4,8],parsexml:3,popupwindow:4,prepul:2,present:2,pull:2,requestfil:3,s:5,setup:[0,7],shadebyyield:4,submodul:[1,2,3,4,8],subpackag:[1,3],support:0,tabl:5,test:8,test_crow:8,throughput:0,uitab:2,us:0,util:[3,4],welcom:5}}) \ No newline at end of file diff --git a/docs/crow.utils.doctree b/docs/crow.utils.doctree index 04e059b..9caf85a 100644 Binary files a/docs/crow.utils.doctree and b/docs/crow.utils.doctree differ diff --git a/docs/crow.utils.html b/docs/crow.utils.html index c490bc6..e0779f1 100644 --- a/docs/crow.utils.html +++ b/docs/crow.utils.html @@ -90,9 +90,16 @@

Submodules
crow.utils.ParseXML.ParseXML(filename)
-

One line passthrough to xml element tree, returns root of tree

-
-
filename: string which gives either the absolute or relative path

to an xml file

+

One line passthrough to xml element tree.

+
+
Parameters
+

filename (string) – the absolute or relative path to an xml file

+
+
Returns
+

root of tree

+
+
Return type
+

etree

@@ -107,12 +114,19 @@

crow.utils.RequestFiles module class crow.utils.crow_globals.crow_globals(config='config.yaml')

Bases: object

-

variables which are used by all tabs in the window, such as the path to -the server of raw data.

+

Class which initializes itself using the config.yaml file, making +variables which are used by all tabs of crow accesible in the ‘global’ +namespace (but without using global variables).

__init__(config='config.yaml')
-
+

Opens the configuration file and reads the contents into attritbutes.

+
+
Parameters
+

config (str, optional) – Configuration file. Defaults to “config.yaml”.

+
+
+

@@ -122,8 +136,12 @@

crow.utils.RequestFiles module
crow.utils.logger.mylog(e)
-

General purpose function for writing errors to an external .txt file

-

e: exception raised by Crow

+

General purpose function for writing errors to an external .txt file.

+
+
Parameters
+

e (exception) – exception raised by Crow

+
+
diff --git a/docs/environment.pickle b/docs/environment.pickle index 6062867..c180a4e 100644 Binary files a/docs/environment.pickle and b/docs/environment.pickle differ diff --git a/docs/searchindex.js b/docs/searchindex.js index a243c93..1857edf 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["README","crow","crow.uitabs","crow.utils","crow.utils.popupwindows","index","modules","setup","test"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["README.rst","crow.rst","crow.uitabs.rst","crow.utils.rst","crow.utils.popupwindows.rst","index.rst","modules.rst","setup.rst","test.rst"],objects:{"":[[1,0,0,"-","crow"],[8,0,0,"-","test"]],"crow.utils":[[3,0,0,"-","ParseXML"],[3,0,0,"-","crow_globals"],[3,0,0,"-","logger"],[4,0,0,"-","popupwindows"]],"crow.utils.ParseXML":[[3,1,1,"","ParseXML"]],"crow.utils.crow_globals":[[3,2,1,"","crow_globals"]],"crow.utils.crow_globals.crow_globals":[[3,3,1,"","__init__"]],"crow.utils.logger":[[3,1,1,"","mylog"]],crow:[[2,0,0,"-","uitabs"],[3,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2019":0,"2020":0,"class":3,"function":3,"new":0,"return":3,A:0,For:0,If:0,One:3,To:0,__init__:3,absolut:3,acceler:5,access:0,activ:0,again:0,agil:0,all:[0,3],an:[0,3],ar:3,area:0,avail:0,base:3,bug:0,burn:0,calcul:0,can:0,code:0,command:0,comprehens:0,config:[0,3],configur:0,content:6,contribut:0,crow_glob:[1,6],crowht:0,cutoff:[1,3],data:[0,3],delawar:0,depth:0,design:0,detail:0,develop:0,diagnos:0,donald:0,e:3,either:3,element:3,eluat:0,environ:0,error:3,everi:0,exampl:0,except:3,exclud:[1,3],experi:0,experiment:5,extern:3,featur:0,file:[0,3],filenam:3,find:0,follow:0,from:0,gc:0,gener:3,give:3,help:0,here:0,high:5,how:0,hte:0,includ:0,index:[0,5],instal:5,instrument:0,jackson:0,lab:0,line:[0,3],local:0,logger:[1,6],me:0,messag:0,modifi:0,modul:[5,6],mylog:3,need:0,numberofcutoff:[1,3],object:3,one:0,open:0,our:0,out:0,output:0,packag:[0,6],page:5,pars:0,parsexml:[1,6],passthrough:3,path:3,peak:0,pip:0,pleas:0,popupwindow:[1,3],prepul:[1,6],present:[0,1,6],program:0,project:0,provid:0,pull:[0,1,6],purpos:3,pypi:0,python:0,rais:3,raw:3,rel:3,report:0,repositori:0,request:0,requestfil:[1,6],retriev:0,root:3,run:0,search:5,see:0,send:0,server:3,set:0,setup:[5,6],shadebyyield:[1,3],softwar:0,stage:0,start:0,step:0,still:0,string:3,submodul:6,subpackag:6,support:5,tab:3,templat:0,test:6,test_crow:6,thi:0,throughput:5,tree:3,tutori:0,txt:3,type:0,uitab:[1,6],under:0,univers:0,up:0,us:[3,5],util:[1,6],variabl:3,variou:0,video:0,watson:0,websit:0,which:3,window:3,work:0,workflow:0,write:3,xml:[0,3],yaml:[0,3],you:0,your:0},titles:["Crow - Accelerating High Throughput Experimentation","crow package","crow.uitabs package","crow.utils package","crow.utils.popupwindows package","Welcome to Crow\u2019s documentation!","Crow","setup module","test package"],titleterms:{acceler:0,content:[1,2,3,4,5,8],crow:[0,1,2,3,4,5,6],crow_glob:3,cutoff:4,document:5,exclud:4,experiment:0,high:0,indic:5,instal:0,logger:3,modul:[1,2,3,4,7,8],numberofcutoff:4,packag:[1,2,3,4,8],parsexml:3,popupwindow:4,prepul:2,present:2,pull:2,requestfil:3,s:5,setup:[0,7],shadebyyield:4,submodul:[1,2,3,4,8],subpackag:[1,3],support:0,tabl:5,test:8,test_crow:8,throughput:0,uitab:2,us:0,util:[3,4],welcom:5}}) \ No newline at end of file +Search.setIndex({docnames:["README","crow","crow.uitabs","crow.utils","crow.utils.popupwindows","index","modules","setup","test"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["README.rst","crow.rst","crow.uitabs.rst","crow.utils.rst","crow.utils.popupwindows.rst","index.rst","modules.rst","setup.rst","test.rst"],objects:{"":[[1,0,0,"-","crow"],[8,0,0,"-","test"]],"crow.utils":[[3,0,0,"-","ParseXML"],[3,0,0,"-","crow_globals"],[3,0,0,"-","logger"],[4,0,0,"-","popupwindows"]],"crow.utils.ParseXML":[[3,1,1,"","ParseXML"]],"crow.utils.crow_globals":[[3,2,1,"","crow_globals"]],"crow.utils.crow_globals.crow_globals":[[3,3,1,"","__init__"]],"crow.utils.logger":[[3,1,1,"","mylog"]],crow:[[2,0,0,"-","uitabs"],[3,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2019":0,"2020":0,"class":3,"default":3,"function":3,"new":0,"return":3,A:0,For:0,If:0,One:3,To:0,__init__:3,absolut:3,acceler:5,acces:3,access:0,activ:0,again:0,agil:0,all:[0,3],an:[0,3],ar:3,area:0,attritbut:3,avail:0,base:3,bug:0,burn:0,calcul:0,can:0,code:0,command:0,comprehens:0,config:[0,3],configur:[0,3],content:6,contribut:0,crow_glob:[1,6],crowht:0,cutoff:[1,3],data:0,delawar:0,depth:0,design:0,detail:0,develop:0,diagnos:0,donald:0,e:3,element:3,eluat:0,environ:0,error:3,etre:3,everi:0,exampl:0,except:3,exclud:[1,3],experi:0,experiment:5,extern:3,featur:0,file:[0,3],filenam:3,find:0,follow:0,from:0,gc:0,gener:3,global:3,help:0,here:0,high:5,how:0,hte:0,includ:0,index:[0,5],initi:3,instal:5,instrument:0,itself:3,jackson:0,lab:0,line:[0,3],local:0,logger:[1,6],make:3,me:0,messag:0,modifi:0,modul:[5,6],mylog:3,namespac:3,need:0,numberofcutoff:[1,3],object:3,one:0,open:[0,3],option:3,our:0,out:0,output:0,packag:[0,6],page:5,paramet:3,pars:0,parsexml:[1,6],passthrough:3,path:3,peak:0,pip:0,pleas:0,popupwindow:[1,3],prepul:[1,6],present:[0,1,6],program:0,project:0,provid:0,pull:[0,1,6],purpos:3,pypi:0,python:0,rais:3,read:3,rel:3,report:0,repositori:0,request:0,requestfil:[1,6],retriev:0,root:3,run:0,search:5,see:0,send:0,set:0,setup:[5,6],shadebyyield:[1,3],softwar:0,stage:0,start:0,step:0,still:0,str:3,string:3,submodul:6,subpackag:6,support:5,tab:3,templat:0,test:6,test_crow:6,thi:0,throughput:5,tree:3,tutori:0,txt:3,type:[0,3],uitab:[1,6],under:0,univers:0,up:0,us:[3,5],util:[1,6],variabl:3,variou:0,video:0,watson:0,websit:0,which:3,without:3,work:0,workflow:0,write:3,xml:[0,3],yaml:[0,3],you:0,your:0},titles:["Crow - Accelerating High Throughput Experimentation","crow package","crow.uitabs package","crow.utils package","crow.utils.popupwindows package","Welcome to Crow\u2019s documentation!","Crow","setup module","test package"],titleterms:{acceler:0,content:[1,2,3,4,5,8],crow:[0,1,2,3,4,5,6],crow_glob:3,cutoff:4,document:5,exclud:4,experiment:0,high:0,indic:5,instal:0,logger:3,modul:[1,2,3,4,7,8],numberofcutoff:4,packag:[1,2,3,4,8],parsexml:3,popupwindow:4,prepul:2,present:2,pull:2,requestfil:3,s:5,setup:[0,7],shadebyyield:4,submodul:[1,2,3,4,8],subpackag:[1,3],support:0,tabl:5,test:8,test_crow:8,throughput:0,uitab:2,us:0,util:[3,4],welcom:5}}) \ No newline at end of file