searchindex.js

Search.setIndex({docnames:["api/dbtools","api/docker_scheduler","api/generate","api/index","api/lazyasd","api/main","api/scheduler","api/server","api/special_archs","gettingstarted","index"],envversion:53,filenames:["api/dbtools.rst","api/docker_scheduler.rst","api/generate.rst","api/index.rst","api/lazyasd.rst","api/main.rst","api/scheduler.rst","api/server.rst","api/special_archs.rst","gettingstarted.rst","index.rst"],objects:{"rickshaw.dbtools":{build_parser:[0,1,1,""],db_open:[0,1,1,""],main:[0,1,1,""],merge:[0,1,1,""],merge_action:[0,1,1,""]},"rickshaw.docker_scheduler":{DockerScheduler:[1,2,1,""]},"rickshaw.docker_scheduler.DockerScheduler":{cyclus_server_host:[1,3,1,""],cyclus_server_ready:[1,3,1,""],gathered_annotations:[1,3,1,""],ncpu:[1,3,1,""],queue:[1,4,1,""],schedule:[1,4,1,""],start_cyclus_server:[1,4,1,""],stop_cyclus_server:[1,4,1,""],want_n_more_jobs:[1,4,1,""]},"rickshaw.generate":{archetype_block:[2,1,1,""],choose_archetypes:[2,1,1,""],choose_commodities:[2,1,1,""],choose_commodity:[2,1,1,""],choose_recipes:[2,1,1,""],generate:[2,1,1,""],generate_archetype:[2,1,1,""],generate_nuclide:[2,1,1,""],random_niches:[2,1,1,""],up_hierarchy:[2,1,1,""]},"rickshaw.lazyasd":{BackgroundModuleLoader:[4,2,1,""],BackgroundModuleProxy:[4,2,1,""],LazyBool:[4,2,1,""],LazyDict:[4,2,1,""],LazyObject:[4,2,1,""],lazybool:[4,1,1,""],lazydict:[4,1,1,""],lazyobject:[4,1,1,""],load_module_in_background:[4,1,1,""]},"rickshaw.lazyasd.BackgroundModuleLoader":{daemon:[4,3,1,""],getName:[4,4,1,""],ident:[4,3,1,""],isAlive:[4,4,1,""],isDaemon:[4,4,1,""],is_alive:[4,4,1,""],join:[4,4,1,""],name:[4,3,1,""],run:[4,4,1,""],setDaemon:[4,4,1,""],setName:[4,4,1,""],start:[4,4,1,""]},"rickshaw.lazyasd.LazyDict":{clear:[4,4,1,""],get:[4,4,1,""],items:[4,4,1,""],keys:[4,4,1,""],pop:[4,4,1,""],popitem:[4,4,1,""],setdefault:[4,4,1,""],update:[4,4,1,""],values:[4,4,1,""]},"rickshaw.scheduler":{Scheduler:[6,2,1,""]},"rickshaw.scheduler.Scheduler":{cyclus_server_host:[6,3,1,""],cyclus_server_ready:[6,3,1,""],gathered_annotations:[6,3,1,""],ncpu:[6,3,1,""],queue:[6,4,1,""],schedule:[6,4,1,""],start_cyclus_server:[6,4,1,""],stop_cyclus_server:[6,4,1,""],want_n_more_jobs:[6,4,1,""]},"rickshaw.server":{all_archetypes:[7,1,1,""],gather_annotations:[7,1,1,""],get_send_data:[7,1,1,""],main:[7,1,1,""],make_parser:[7,1,1,""],queue_message_action:[7,1,1,""],schedule_sims:[7,1,1,""],start_annotations_server:[7,1,1,""],websocket_client:[7,1,1,""],websocket_handler:[7,1,1,""]},"rickshaw.special_archs":{enrich_tails:[8,1,1,""],ff_fill:[8,1,1,""],ff_fill_recipe:[8,1,1,""],generate_deploy:[8,1,1,""],generate_deploy_inst:[8,1,1,""],generate_deploy_lin:[8,1,1,""],generate_deploy_sch:[8,1,1,""],generate_region_inst:[8,1,1,""],generate_throwsink:[8,1,1,""],generate_throwsource:[8,1,1,""],sep_leftover:[8,1,1,""],sep_streams:[8,1,1,""],skip:[8,1,1,""],trans_init_facs:[8,1,1,""]},rickshaw:{dbtools:[0,0,0,"-"],docker_scheduler:[1,0,0,"-"],generate:[2,0,0,"-"],lazyasd:[4,0,0,"-"],scheduler:[6,0,0,"-"],server:[7,0,0,"-"],special_archs:[8,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute","4":"py:method"},terms:{"abstract":6,"boolean":4,"case":[4,8],"class":[1,3,4],"default":4,"float":4,"function":[3,4,8],"import":4,"int":[2,9],"new":1,"null":8,"return":[2,4,8],"true":4,For:[3,4,9],Its:4,LHS:4,RES:4,The:[2,4,7,8,9],Used:8,With:9,__xonsh_env__:4,abil:9,abov:9,acc:4,access:4,achiev:9,action:7,activ:4,actual:4,added:2,after:[4,8,9],aliv:4,all:[4,6,9],all_archetyp:7,allow:9,also:[4,9,10],alwai:4,ani:[4,9],anoth:4,api:10,appropri:2,arch:2,archetyp:[2,3,9,10],archetype_block:2,arg:[0,4,7],argument:[4,7],arrang:4,ask:[4,6],assign:[2,4],asynchron:7,attempt:4,attribut:4,author:10,avail:4,background:4,backgroundmoduleload:4,backgroundmoduleproxi:4,bar:4,base:[1,2,3],basi:9,basic:7,baz:4,becom:8,been:4,befor:4,begin:2,behavior:9,being:2,between:8,block:[2,4,9],both:9,build:[8,9],build_pars:0,bunch:4,call:4,callabl:4,can:[2,4,9,10],caus:4,chang:10,choic:2,choos:2,choose_archetyp:2,choose_commod:2,choose_nich:2,choose_recip:2,chosen:2,clear:4,client:7,cloud_spthem:9,cluster:10,com:9,command:[3,9,10],comment:10,commid:8,commod:[2,8,9],commod_nam:2,commod_recip:9,commun:7,comp:9,compil:4,complex:4,comput:4,config:[2,8],configur:10,connect:2,constrain:9,constraint:9,construct:4,constructor:4,consum:7,contain:[2,4,8],context:4,control:[2,4],correct:2,correctli:9,correspond:4,creat:[2,4,8,10],ctx:4,current:[1,2,4,6],cycamor:[2,9],cycl:[2,8,10],cyclu:[0,1,2,6,7,8,9,10],cyclus_server_host:[1,6],cyclus_server_readi:[1,6],daemon:4,data:[7,9],databas:3,db_open:0,dbtool:3,dead:4,deadlock:4,debug:[1,4],decid:4,decor:4,defin:[8,9],definit:9,delai:4,deploi:8,deploy:8,design:8,desir:[2,9],destruct:3,detail:3,determin:[1,2,8],dict:[2,4],dictionari:[2,4,8],directli:10,directori:9,disir:9,docker:[3,10],docker_schedul:3,dockerpi:9,dockerschedul:1,document:[9,10],doe:[2,4],dot:4,driver:10,each:[1,2,4,6,9,10],easi:10,effienc:8,either:[4,9],element:2,els:4,empti:4,encourag:10,enrich_tail:8,entir:4,entri:[3,4],enumer:4,env:4,environ:4,erg:9,error:4,etc:9,evalu:4,even:4,everi:9,exampl:[4,9],except:4,execut:[1,6],executor:7,exit:4,expreess:4,express:4,fabric:8,facil:8,fals:[1,4,6],ff_fill:8,ff_fill_recip:8,file:[2,7,8,10],file_nam:[0,9],first:[0,4,9],fit:9,flag:9,follow:[2,4,8,9],foo:4,fork:10,form:2,format:[2,8,9],found:4,fraction:4,frequenc:7,from:[2,4,7,9],fuel:[2,8,10],full:[2,10],fulli:[4,10],gather_annot:7,gathered_annot:[1,6],gener:[3,7,8,9,10],generate_archetyp:2,generate_deploi:8,generate_deploy_inst:8,generate_deploy_lin:8,generate_deploy_sch:8,generate_nuclid:2,generate_region_inst:8,generate_throwsink:8,generate_throwsourc:8,get:[4,9],get_id:4,get_send_data:7,getnam:4,git:9,github:[9,10],give:4,given:[4,8],global:4,grab:7,gritti:3,happen:4,has:4,have:[2,8,9,10],hdf5:9,helper:3,here:9,highli:10,hopper:7,host:7,how:[1,6],http:9,hwr:9,ident:4,identif:4,identifi:4,immedi:9,import_modul:4,importlib:4,in_commod:2,in_recip:2,includ:10,incommod:[2,8],index:10,indic:4,individu:2,inherit:4,initi:4,inp:2,input:[2,7,8,9,10],inst:8,instanc:[4,9],institut:8,integ:4,interfac:10,invok:4,is_al:4,isal:4,isdaemon:4,issu:10,item:4,iter:4,its:4,itself:4,job:[1,6,7],join:4,json:[2,9,10],just:[4,8],kei:[2,4,9],keyerror:4,keyfrom:2,keyto:2,keyword:4,kwarg:[1,4],lack:4,lambda:4,lazi:3,lazili:4,lazyasd:3,lazybool:4,lazydict:4,lazyobject:4,left:4,length:2,level:9,like:[4,10],line:[3,9,10],list:[2,4],liter:9,load:[4,7,9],load_module_in_background:4,loader:4,locat:[1,6],look:4,loop:7,lwr:9,made:4,mai:[4,9],main:[0,3,4,7],make:[7,9,10],make_pars:7,mani:[1,4,6],map:4,mass:9,materi:8,max_nich:2,max_num_nich:2,maximum:2,mean:4,merg:0,merge_act:0,messag:7,metaclass:6,metadata:2,method:4,mine:[2,9],mix:9,mode:[9,10],model:2,modnam:4,modul:[4,10],moduletyp:4,more:[1,4,6,8],most:4,moudl:4,multipl:4,must:4,name:[2,4,8,9],natur:2,ncpu:[1,6],necessari:[2,8],need:[6,7],next:7,nich:[2,8,9,10],niche_link:9,node:10,non:4,none:[0,1,2,4,6,7,9],nonzero:4,normal:4,notic:9,nuclear:2,nuclid:9,number:[2,4,8,9],numpydoc:9,object:4,obtain:[1,6],occur:4,onc:4,one:[8,9],onli:[4,9],open:10,oper:[4,8,10],option:[2,4],origin:[2,4],otherwis:4,out:[2,4],out_commod:2,out_recip:2,outcommod:[2,8],outfil:0,output:9,overrid:4,packag:4,page:10,pair:[2,4],paramet:[2,4,8],parser:7,pass:4,path:2,per:4,perform:4,physic:2,pick:10,place:[8,9],pleas:10,point:[2,3,4],pop:4,popitem:4,port:7,possibl:8,power:10,prebuild:8,present:4,preset:2,pretti:9,prevent:4,print:9,produc:[2,9],program:4,provid:[4,7,8],proxi:4,pull:[2,10],purpos:4,put:2,python:[4,9,10],qualifi:4,queri:6,question:10,queue:[1,6,7],queue_message_act:7,rais:4,random:[2,8,10],random_nich:2,randomli:[7,10],rang:[2,9],reach:2,reactor:9,read:9,receiv:[2,8],reciev:7,recip:[2,9],recycl:4,region:8,regular:4,remot:[1,6,7],remov:4,replac:4,repositori:[9,10],repres:[2,4,6,8,10],request:[6,10],respect:4,restrict:9,result:4,retun:[1,6],run:[1,4,6,7,8,10],runtimeerror:4,same:[2,4],save:9,schedul:[3,7],schedule_sim:7,schedulu:10,scheme:2,script:9,search:10,second:[0,4],section:2,see:4,select:10,self:3,semant:4,send:7,sent:8,sep_leftov:8,sep_stream:8,separ:[4,8],sequenti:[2,4],server:[1,3,6,10],set:[2,4,9],setdaemon:4,setdefault:4,setnam:4,setup:9,should:[4,6],sim:[1,6,8],sim_spec:[2,8],simspec:[2,8],simul:[1,2,6,8,9],sink:[8,9],site:4,skip:8,some:4,sourc:[0,1,2,4,6,7,8,9],space:8,speacial:3,special:8,special_arch:3,specif:[2,8],specifi:[4,9],speed:4,sphinx:9,split:0,sqlite:9,standard:4,start:[1,2,4,6,7,9],start_annotations_serv:7,start_cyclus_serv:[1,6],state:[2,10],statu:[1,6],step:[2,9],still:4,stochast:[2,10],stop:[1,6],stop_cyclus_serv:[1,6],str:[2,4],stream:8,string:[4,8],structur:[9,10],subclass:4,subset:9,suitabl:2,suppos:4,sure:9,swarm:10,symbol:4,sys:4,tail:8,tailcommd:8,taken:4,target:4,termin:4,test:[8,9],test_specification_input:9,than:[4,8],thei:4,therefor:4,thereof:4,thi:[2,4,8,9],those:[2,3,8,10],thread:4,through:[2,4],throwsink:8,throwsourc:8,time:[4,8,9],timeout:4,tool:3,top:9,total:2,trans_init_fac:8,transit:8,tupl:4,tutori:10,two:4,typic:4,uityp:2,unhandl:4,uniqu:2,unique_commod:2,until:4,up_hierarchi:2,updat:4,upon:4,use:[2,9],used:[2,4,8],user:2,using:9,val:8,valid:[2,10],valu:[4,10],variabl:[2,4,10],varieti:10,verbos:9,via:[1,4,7,9],view:4,wait:4,want:3,want_n_more_job:[1,6],wast:8,websocket:[7,9],websocket_cli:7,websocket_handl:7,well:2,what:8,when:4,where:9,whether:4,which:9,who:3,whose:4,within:2,work:[9,10],would:[4,10],you:[3,4,9,10],your:[9,10]},titles:["Database Tools (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.dbtools</span></code>)","Docker Scheduler (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.docker_scheduler</span></code>)","Generate Functions (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.Generate</span></code>)","Rickshaw API","Lazy and Self-destructive Tools (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.lazyasd</span></code>)","Command Line Entry Point (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.main</span></code>)","Scheduler Base Class (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.scheduler</span></code>)","Server Command Line Entry Point (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.server</span></code>)","Speacial Archetypes (<code class=\"docutils literal notranslate\"><span class=\"pre\">rickshaw.special_archs</span></code>)","Rickshaw Tutorial","Rickshaw"],titleterms:{"class":6,"function":2,api:3,archetyp:8,base:6,clone:9,command:[5,7],contact:10,content:10,contribut:10,cool:9,databas:0,dbtool:0,depend:9,destruct:4,docker:1,docker_schedul:1,entri:[5,7],file:9,gener:2,help:10,instal:9,lazi:4,lazyasd:4,line:[5,7],link:10,main:5,note:9,option:9,point:[5,7],repo:9,rickshaw:[0,1,2,3,4,5,6,7,8,9,10],run:9,schedul:[1,6],self:4,server:7,speacial:8,special_arch:8,specif:9,tool:[0,4],tutori:9,write:9}})