searchindex.js

Search.setIndex({docnames:["about","genindex","index","installation","source/biosimulators_opencor","source/biosimulators_pyneuroml","source/biosimulators_pyneuroml.api","source/biosimulators_pyneuroml.cli","tutorial"],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:["about.rst","genindex.rst","index.rst","installation.rst","source/biosimulators_opencor.rst","source/biosimulators_pyneuroml.rst","source/biosimulators_pyneuroml.api.rst","source/biosimulators_pyneuroml.cli.rst","tutorial.rst"],objects:{"":[[5,0,0,"-","biosimulators_pyneuroml"]],"biosimulators_pyneuroml.Simulator":[[5,2,1,"","brian2"],[5,2,1,"","netpyne"],[5,2,1,"","neuron"],[5,2,1,"","pyneuroml"]],"biosimulators_pyneuroml.api":[[6,0,0,"-","brian2"],[6,0,0,"-","netpyne"],[6,0,0,"-","neuron"],[6,0,0,"-","pyneuroml"]],"biosimulators_pyneuroml.api.brian2":[[6,3,1,"","exec_sed_doc"],[6,3,1,"","exec_sed_task"],[6,3,1,"","exec_sedml_docs_in_combine_archive"],[6,3,1,"","get_simulator_version"],[6,3,1,"","preprocess_sed_task"]],"biosimulators_pyneuroml.api.netpyne":[[6,3,1,"","exec_sed_doc"],[6,3,1,"","exec_sed_task"],[6,3,1,"","exec_sedml_docs_in_combine_archive"],[6,3,1,"","get_simulator_version"],[6,3,1,"","preprocess_sed_task"]],"biosimulators_pyneuroml.api.neuron":[[6,3,1,"","exec_sed_doc"],[6,3,1,"","exec_sed_task"],[6,3,1,"","exec_sedml_docs_in_combine_archive"],[6,3,1,"","get_simulator_version"],[6,3,1,"","preprocess_sed_task"]],"biosimulators_pyneuroml.api.pyneuroml":[[6,3,1,"","exec_sed_doc"],[6,3,1,"","exec_sed_task"],[6,3,1,"","exec_sedml_docs_in_combine_archive"],[6,3,1,"","get_simulator_version"],[6,3,1,"","preprocess_sed_task"]],"biosimulators_pyneuroml.cli":[[7,0,0,"-","brian2"],[7,0,0,"-","netpyne"],[7,0,0,"-","neuron"],[7,0,0,"-","pyneuroml"]],"biosimulators_pyneuroml.cli.brian2":[[7,3,1,"","main"]],"biosimulators_pyneuroml.cli.netpyne":[[7,3,1,"","main"]],"biosimulators_pyneuroml.cli.neuron":[[7,3,1,"","main"]],"biosimulators_pyneuroml.cli.pyneuroml":[[7,3,1,"","main"]],"biosimulators_pyneuroml.core":[[5,3,1,"","exec_sed_doc"],[5,3,1,"","exec_sed_task"],[5,3,1,"","exec_sedml_docs_in_combine_archive"],[5,3,1,"","preprocess_sed_task"]],"biosimulators_pyneuroml.data_model":[[5,1,1,"","RunLemsOptions"],[5,1,1,"","Simulator"]],"biosimulators_pyneuroml.data_model.RunLemsOptions":[[5,2,1,"","cleanup"],[5,2,1,"","compile_mods"],[5,2,1,"","exec_in_dir"],[5,2,1,"","exit_on_fail"],[5,2,1,"","load_saved_data"],[5,2,1,"","max_memory"],[5,2,1,"","no_gui"],[5,2,1,"","num_processors"],[5,2,1,"","only_generate_scripts"],[5,2,1,"","paths_to_include"],[5,2,1,"","plot"],[5,2,1,"","realtime_output"],[5,2,1,"","reload_events"],[5,2,1,"","show_plot_already"],[5,2,1,"","skip_run"],[5,4,1,"","to_kw_args"],[5,2,1,"","verbose"]],"biosimulators_pyneuroml.data_model.Simulator":[[5,2,1,"","brian2"],[5,2,1,"","netpyne"],[5,2,1,"","neuron"],[5,2,1,"","pyneuroml"]],"biosimulators_pyneuroml.utils":[[5,3,1,"","get_available_memory"],[5,3,1,"","get_available_processors"],[5,3,1,"","get_run_lems_options"],[5,3,1,"","get_simulator_run_lems_method"],[5,3,1,"","read_lems_output_files_configuration"],[5,3,1,"","read_xml_file"],[5,3,1,"","run_lems_xml"],[5,3,1,"","set_sim_in_lems_xml"],[5,3,1,"","validate_lems_document"],[5,3,1,"","validate_task"],[5,3,1,"","write_lems_output_files_configuration"],[5,3,1,"","write_xml_file"]],biosimulators_pyneuroml:[[5,1,1,"","Simulator"],[6,0,0,"-","api"],[7,0,0,"-","cli"],[5,0,0,"-","core"],[5,0,0,"-","data_model"],[5,3,1,"","exec_sed_doc"],[5,3,1,"","exec_sed_task"],[5,3,1,"","exec_sedml_docs_in_combine_archive"],[5,3,1,"","preprocess_sed_task"],[5,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","function","Python function"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:function","4":"py:method"},terms:{"0":[0,4,5,6],"02":5,"05":[4,5,7],"06":5,"2":[3,7],"2021":[4,5,7],"28":[4,5,7],"3":[0,3],"7":3,"byte":5,"class":[4,5],"default":3,"enum":[4,5],"export":5,"int":[4,5,6],"return":[4,5,6],"true":[4,5,6],A:[2,4,5,8],For:8,The:8,These:2,_element:5,about:[2,4,5,6,8],abov:[3,8],add:3,addit:3,after:3,algorithm:[2,5,8],all:[3,8],also:2,altern:5,amount:5,an:[4,5,6],ani:[0,4,5,6],api:[2,5],appli:[4,5,6],applic:[2,8],apply_xml_model_chang:[4,5,6],ar:[0,2,4,5,6],archiv:[2,4,5,6],archive_filenam:[4,5,6],argument:[5,7,8],argv:7,aspect:[4,5,6],author:[4,5,7],avail:[2,3,5,8],avoid:[4,5,6],base:[4,5],base_out_path:[4,5,6],befor:[4,5,6],below:8,bin:3,bind:8,biolog:2,biomed:[0,4,5],biosimul:[3,4,5,6,7,8],biosimulators_pyneuroml:2,bool:[4,5,6],brian2:[3,4,5],brian:[3,7],bsd:0,bundl:[],bundle_output:[],c:[4,5,6],call:[4,5,6],can:[4,5,6,8],center:[0,4,5],chang:[4,5,6],claus:0,cleanup:5,cli:5,colleg:0,com:8,combin:[2,4,5,6],combinearchivelog:[4,5,6],command:[0,2,7],comment:2,common:[4,5,6],compile_mod:5,compliant:[2,7,8],config:[4,5,6],configur:[4,5,6],consol:8,contact:0,contain:8,copyright:[4,5,7],core:2,could:[4,5,6,8],creat:2,csv:[4,5,6],cut:3,d:[3,8],data:5,data_model:2,datafram:5,date:[4,5,7],debug:8,defin:[4,5,6],degre:[4,5,6],describ:[2,8],dev:3,develop:2,dict:[4,5,6],dictionari:5,dir:8,directori:[3,4,5,6,8],displai:5,doc:[4,5,6],docker:[0,2],document:[4,5,6],downstat:0,e:3,each:[4,5,6],edu:[4,5,7],element:5,enabl:2,encapsul:[3,8],encod:2,entrypoint:2,etre:5,exampl:8,except:[],exec_in_dir:5,exec_sed_doc:[4,5,6],exec_sed_task:[4,5,6],exec_sedml_docs_in_combine_arch:[4,5,6],execut:[2,3,4,5,6,8],exit:8,exit_on_fail:5,experi:2,extra:5,f:3,fals:[4,5,6],featur:[4,5,6],file:[4,5,6,8],filenam:5,first:3,follow:[3,8],format:[2,5],four:3,frame:5,full:8,functiontyp:5,g:3,gcc:3,gener:[4,5,6],get:[5,6],get_available_memori:5,get_available_processor:5,get_run_lems_opt:5,get_simulator_run_lems_method:5,get_simulator_vers:6,ghcr:[3,8],github:8,gleeson:0,h5:[4,5,6],h:8,hdf5:[4,5,6],help:8,here:8,how:8,http:8,i:8,icahn:0,id:[4,5,6],illustr:8,imag:[0,2],includ:[3,4,5,6],indent:[4,5,6],index:2,individu:[],inform:[4,5,6,8],initi:[4,5,6],instal:2,instruct:2,interfac:[2,7,8],involv:[4,5,6],io:[3,8],its:[4,5,6],java:3,jneuroml:[0,2,3,8],jonathan:[4,5,7],karr:[0,4,5,7],keep:[],keep_individual_output:[],kei:[4,5,6],keyword:5,kisao:5,lab:0,latest:8,lem:[2,4,5],lems_filenam:5,lems_xml_root:5,level:[4,5,6],lgpl:0,libmpich:3,licens:[2,4,5,7],line:[0,2,7],list:[2,4,5,6,7,8],load_saved_data:5,locat:[4,5,6],log:[4,5,6],log_level:[4,5,6],london:0,lxml:5,main:7,make:3,map:5,max_memori:5,maximum:5,medic:0,medicin:0,memori:5,messag:[4,5,6,8],method:[4,5,6],mit:[0,4,5,7],ml:[2,4,5,6],mode:8,model:[0,2,4,5,6,8],modifi:[4,5,6],modul:2,more:[2,8],mount:[0,8],mpi:3,mpich:3,mssm:[4,5,7],netpyn:[0,2,3,4,5,8],neuroml:[2,5,8],neuron:[0,2,3,4,5,8],neuron_hom:3,neurosim:0,no_gui:5,none:[4,5,6,7],notimplementederror:[4,5,6],nrniv:3,num_processor:5,number:[5,8],o:8,object:5,omex:[2,4,5,6],one:[2,8],onli:5,only_generate_script:5,option:[3,4,5,6,7,8],out:8,out_dir:[4,5,6,8],output:[4,5,6,8],output_file_config:5,packag:[0,2],padraig:0,panda:5,paramet:[2,4,5,6,7,8],parent:3,path:[4,5,6,8],paths_to_includ:5,pdf:[],pip:3,pleas:0,plot:5,plot_format:[],possibl:[4,5,6],preprocess:[4,5,6],preprocess_sed_task:[4,5,6],preprocessed_task:[4,5,6],pretti:[4,5,6],pretty_print:5,pretty_print_modified_xml_model:[4,5,6],print:[4,5,6],processor:5,program:[0,2,7],provid:2,pull:3,pwd:8,pyneuroml:[3,4,5,8],python:3,q:8,question:2,quiet:8,rais:[4,5,6],raise_except:[],read:5,read_lems_output_files_configur:5,read_xml_fil:5,realtime_output:5,record:[4,5,6],rel:[4,5,6],rel_out_path:[4,5,6],releas:0,reload_ev:5,remov:5,remove_blank_text:5,repeat:[4,5,6],repeatedli:[4,5,6],report:[4,5,6],report_format:[],reportformat:[],reportresult:[4,5,6],reproduc:[0,4,5],request:[4,5,6],requir:5,result:[4,5,6,8],return_result:[],rev:3,rm:8,root:5,run:[3,5,7,8],run_lems_xml:5,runbiosimul:2,runlemsopt:5,s:8,same:[4,5,6,8],save:[4,5,6,8],school:0,second:3,sed:[2,4,5,6],seddocu:[4,5,6],seddocumentlog:[4,5,6],seddocumentresult:[4,5,6],servic:2,set:[3,5],set_sim_in_lems_xml:5,should:[4,5,6],show:8,show_plot_alreadi:5,simpl:2,simul:[2,4,5,6,7],simulation_xml:5,sinai:0,singl:[4,5,6],skip_run:5,so:5,sourc:[4,5,6,7,8],specifi:[4,5,6],standardoutputerrorcapturerlevel:[4,5,6],statu:[4,5,6],store:[4,5,6],str:[4,5,6,7],studi:8,submodul:2,subpackag:2,suni:0,support:[2,3,4,5,6,8],suppress:8,target:8,task:[4,5,6],task_execut:[4,5,6],tasklog:[4,5,6],team:[2,7],thi:[0,4,5,6,8],third:3,those:0,three:8,tmp:8,to_kw_arg:5,tool:[0,2],tty:8,tupl:[4,5,6],tutori:2,type:[4,5,6,8],under:0,univers:0,unsuport:[4,5,6],up:3,us:[2,3,4,5,6,8],usag:8,user:2,util:2,v:8,valid:[4,5,6],validate_lems_docu:5,validate_task:5,valu:[4,5],valueerror:[4,5,6],variabl:[4,5,6],variableresult:[4,5,6],verbos:5,version:[6,8],vizformat:[],wa:0,web:2,were:0,whether:5,which:[3,4,5,6,8],within:[4,5,6],work:[4,5,6,8],working_dir:[4,5,6],working_dirnam:5,write:5,write_lems_output_files_configur:5,write_xml_fil:5,xml:[4,5,6],xml_root:5,yale:0},titles:["About BioSimulators-pyNeuroML","Index","BioSimulators-pyNeuroML documentation","Installation instructions","biosimulators_pyneuroml package","biosimulators_pyneuroml package","biosimulators_pyneuroml.api package","biosimulators_pyneuroml.cli package","Tutorial"],titleterms:{about:0,api:6,archiv:8,biosimul:[0,2],biosimulators_pyneuroml:[4,5,6,7],brian2:[6,7],cli:7,combin:8,command:[3,8],comment:0,content:2,core:[4,5],creat:8,data_model:5,develop:0,docker:[3,8],document:2,encod:8,entrypoint:[3,8],experi:8,imag:[3,8],index:1,instal:3,instruct:3,licens:0,line:[3,8],ml:8,modul:[4,5,6,7],netpyn:[6,7],neuron:[6,7],omex:8,packag:[4,5,6,7],program:[3,8],pyneuroml:[0,2,6,7],question:0,sed:8,simul:8,submodul:[4,5,6,7],subpackag:5,team:0,tutori:8,util:5}})