diff --git a/docs/.buildinfo b/docs/.buildinfo index bdcbcdd..6de0b97 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 8ba9a54c0c7a6de6277f5d70d0e03f6b +config: 9d50a20107797c095eee9d00b208dcb0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_static/basic.css b/docs/_static/basic.css index 24a49f0..be19270 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js index 7d88f80..144884e 100644 --- a/docs/_static/doctools.js +++ b/docs/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index f14072f..51c1fd7 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.1.16', + VERSION: '0.1.17', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js index d2b4ee9..0e7dc7e 100644 --- a/docs/_static/language_data.js +++ b/docs/_static/language_data.js @@ -5,7 +5,7 @@ * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 261ecaa..6fc9e7f 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/about.html b/docs/about.html index 1b24ecd..4781c9e 100644 --- a/docs/about.html +++ b/docs/about.html @@ -5,14 +5,13 @@ - About BioSimulators-GillesPy2 — BioSimulators-GillesPy2 0.1.16 documentation + About BioSimulators-GillesPy2 — BioSimulators-GillesPy2 0.1.17 documentation - diff --git a/docs/genindex.html b/docs/genindex.html index 9db5eda..5e16010 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -5,14 +5,13 @@ - Index — BioSimulators-GillesPy2 0.1.16 documentation + Index — BioSimulators-GillesPy2 0.1.17 documentation - diff --git a/docs/index.html b/docs/index.html index 068b4b3..fc8f72e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,14 +5,13 @@ - BioSimulators-GillesPy2 documentation — BioSimulators-GillesPy2 0.1.16 documentation + BioSimulators-GillesPy2 documentation — BioSimulators-GillesPy2 0.1.17 documentation - diff --git a/docs/installation.html b/docs/installation.html index f20805b..3688ca1 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -5,14 +5,13 @@ - Installation instructions — BioSimulators-GillesPy2 0.1.16 documentation + Installation instructions — BioSimulators-GillesPy2 0.1.17 documentation - diff --git a/docs/objects.inv b/docs/objects.inv index 5ff203c..4d93a69 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/py-modindex.html b/docs/py-modindex.html index 5b1d53f..4550e31 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -5,14 +5,13 @@ - Python Module Index — BioSimulators-GillesPy2 0.1.16 documentation + Python Module Index — BioSimulators-GillesPy2 0.1.17 documentation - diff --git a/docs/search.html b/docs/search.html index 9c2023c..810fe02 100644 --- a/docs/search.html +++ b/docs/search.html @@ -5,7 +5,7 @@ - Search — BioSimulators-GillesPy2 0.1.16 documentation + Search — BioSimulators-GillesPy2 0.1.17 documentation @@ -13,8 +13,8 @@ - + diff --git a/docs/searchindex.js b/docs/searchindex.js index 711692e..4526e39 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["about","genindex","index","installation","source/biosimulators_gillespy2","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["about.rst","genindex.rst","index.rst","installation.rst","source/biosimulators_gillespy2.rst","tutorial.rst"],objects:{"":{biosimulators_gillespy2:[4,0,0,"-"]},"biosimulators_gillespy2.core":{exec_sed_task:[4,1,1,""],exec_sedml_docs_in_combine_archive:[4,1,1,""]},"biosimulators_gillespy2.data_model":{Algorithm:[4,2,1,""],AlgorithmParameter:[4,2,1,""],HybridTauIntegrationMethod:[4,2,1,""],VodeMethod:[4,2,1,""]},"biosimulators_gillespy2.data_model.Algorithm":{name:[4,3,1,""],parameters:[4,3,1,""],solver:[4,3,1,""],solver_args:[4,3,1,""]},"biosimulators_gillespy2.data_model.AlgorithmParameter":{"default":[4,3,1,""],data_type:[4,3,1,""],key:[4,3,1,""],name:[4,3,1,""],set_value:[4,4,1,""]},"biosimulators_gillespy2.data_model.HybridTauIntegrationMethod":{BDF:[4,3,1,""],LSODA:[4,3,1,""],RK23:[4,3,1,""],RK45:[4,3,1,""],Radau:[4,3,1,""]},"biosimulators_gillespy2.data_model.VodeMethod":{adams:[4,3,1,""],bdf:[4,3,1,""]},biosimulators_gillespy2:{core:[4,0,0,"-"],data_model:[4,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:{"2020":4,"class":4,"default":4,"enum":4,"import":[],"return":4,"true":4,For:5,The:5,about:[2,5],abov:5,adam:4,after:3,algorithm:[2,4,5],algorithmparamet:4,all:5,also:2,ani:0,api:2,appli:4,applic:[2,5],archiv:[2,4],archive_fil:[],archive_filenam:4,argument:[4,5],ashevil:0,aspect:4,author:4,avail:[2,3,5],base:4,bdf:4,below:5,bilal:4,bilalshaikh42:4,bind:5,biolog:2,biomd0000000297:[],biomed:[0,4],biosimul:[3,5],biosimulators_gillespy2:2,blob:[],block:[],bool:4,bundl:4,bundle_output:4,can:5,carolina:0,center:[0,4],code:[],column:[],com:4,combin:[2,4],command:[0,2],comment:2,compliant:[2,5],concentr:[],consol:5,contact:0,contain:5,content:[],copyright:4,core:2,could:[4,5],count:[],creat:2,csv:4,data:4,data_model:2,data_typ:4,datafram:[],datageneratorvari:4,datageneratorvariableresult:4,date:4,debug:5,defin:4,defualt:4,describ:[2,5],dev:[],develop:2,dict:4,dictionari:4,dir:5,directori:[4,5],docker:[0,2],drawert:0,edit:[],edu:4,enabl:2,encapsul:[3,5],encod:2,entrypoint:2,enumer:4,error:[],exampl:5,except:[],exec_combine_arch:[],exec_sed_task:4,exec_sedml_docs_in_combine_arch:4,exec_simul:[],execut:[2,4,5],exit:5,experi:2,express:[],featur:4,file:[4,5],fixtur:[],follow:[3,5],format:[2,4],full:5,ghcr:[3,5],gillespi:[],gillespy2:[3,4,5],github:5,gmail:4,gpl:0,hdf5:4,help:5,highlight:[],how:5,http:5,hybrid:4,hybridtauintegrationmethod:4,icahn:0,ids:4,illustr:5,imag:[0,2],index:2,individu:4,info:[],inform:5,inputerror:[],instal:2,instruct:2,integr:4,interfac:[2,5],involv:4,its:4,jonathan:4,karr:[0,4],karrlab:[],keep:4,keep_individual_output:4,kei:4,kisao:4,kisao_0000032:4,kisao_0000088:4,kisao_0000288:4,kisao_0000289:4,kisao_0000304:4,kisao_0000537:4,lab:0,languag:[],latest:5,licens:[2,4],line:[0,2],list:[2,4,5],lsoda:4,mailto:[],map:4,medicin:0,messag:5,method:4,mit:[0,4],mode:5,model:[0,2,4,5],model_filenam:[],model_sed_urn:[],modul:2,more:[2,5],mount:[0,5],mssm:4,name:4,none:4,north:0,notimplementederror:4,number:5,obj:[],object:4,omex:[2,4],one:[2,5],option:[4,5],org:[],out:5,out_dir:[4,5],out_filenam:[],out_format:[],output:[4,5],packag:[0,2],page:[],panda:[],paramet:[2,4,5],pars:[],path:[4,5],pdf:4,pip:3,pleas:0,plot:4,plot_format:4,plotformat:4,point:[],predict:[],prevent:[],program:[0,2],provid:2,pull:3,pwd:5,python:3,question:2,quiet:5,radau:4,rais:4,readonli:[],record:4,rel:4,releas:0,report:4,report_format:4,reportformat:4,represent:4,reproduc:[0,4],reproduciblebiomodel:[],request:4,requir:[],result:[4,5],rk23:4,rk45:4,root:[],row:[],run:[3,5],runbiosimul:2,same:5,save:[4,5],sbml:2,school:0,search:[],sed:[2,4],sedml:[],servic:2,set_valu:4,shaikh:4,shell:[],should:4,show:5,simpl:2,simul:[2,4],sinai:0,singl:4,solver:4,solver_arg:4,sourc:[4,5],speci:[],start:[],stochss:5,store:4,str:4,str_valu:4,string:4,structur:4,studi:5,submodul:2,support:[2,4,5],suppress:5,target:5,task:4,tau:4,team:2,test:[],text:[],thi:[0,2,5],time:[],tmp:5,tool:2,trigger:[],tty:5,tutori:2,type:[4,5],under:0,univers:0,unsuport:4,unsupport:[],urn:[],usag:5,use:[2,5],used:5,user:2,uses:[],using:[2,4],valid:4,valu:4,valueerror:4,variabl:4,version:5,vode:4,vodemethod:4,web:2,which:[4,5],within:4,work:5,working_dir:[],www:[],zero:[]},titles:["About BioSimulators-GillesPy2","Index","BioSimulators-GillesPy2 documentation","Installation instructions","biosimulators_gillespy2 package","Tutorial"],titleterms:{about:0,archiv:5,biosimul:[0,2],biosimulators_gillespy2:4,combin:5,command:[3,5],comment:0,content:2,core:4,creat:5,data_model:4,develop:0,docker:[3,5],document:2,encod:5,entrypoint:[3,5],experi:5,gillespy2:[0,2],imag:[3,5],index:1,indic:[],instal:3,instruct:3,licens:0,line:[3,5],modul:4,omex:5,packag:4,program:[3,5],question:0,sed:5,simul:5,submodul:4,tabl:[],team:0,tutori:5,welcom:[]}}) \ No newline at end of file +Search.setIndex({docnames:["about","genindex","index","installation","source/biosimulators_gillespy2","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["about.rst","genindex.rst","index.rst","installation.rst","source/biosimulators_gillespy2.rst","tutorial.rst"],objects:{"":{biosimulators_gillespy2:[4,0,0,"-"]},"biosimulators_gillespy2.core":{exec_sed_task:[4,1,1,""],exec_sedml_docs_in_combine_archive:[4,1,1,""]},"biosimulators_gillespy2.data_model":{Algorithm:[4,2,1,""],AlgorithmParameter:[4,2,1,""],HybridTauIntegrationMethod:[4,2,1,""],VodeMethod:[4,2,1,""]},"biosimulators_gillespy2.data_model.Algorithm":{name:[4,3,1,""],parameters:[4,3,1,""],solver:[4,3,1,""],solver_args:[4,3,1,""]},"biosimulators_gillespy2.data_model.AlgorithmParameter":{"default":[4,3,1,""],data_type:[4,3,1,""],key:[4,3,1,""],name:[4,3,1,""],set_value:[4,4,1,""]},"biosimulators_gillespy2.data_model.HybridTauIntegrationMethod":{BDF:[4,3,1,""],LSODA:[4,3,1,""],RK23:[4,3,1,""],RK45:[4,3,1,""],Radau:[4,3,1,""]},"biosimulators_gillespy2.data_model.VodeMethod":{adams:[4,3,1,""],bdf:[4,3,1,""]},biosimulators_gillespy2:{core:[4,0,0,"-"],data_model:[4,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:{"2020":4,"class":4,"default":4,"enum":4,"import":[],"return":4,"true":4,For:5,The:5,about:[2,5],abov:5,adam:4,after:3,algorithm:[2,4,5],algorithmparamet:4,all:5,also:2,ani:0,api:2,appli:4,applic:[2,5],archiv:[2,4],archive_fil:[],archive_filenam:4,argument:[4,5],ashevil:0,aspect:4,author:4,avail:[2,3,5],base:4,bdf:4,below:5,bilal:4,bilalshaikh42:4,bind:5,biolog:2,biomd0000000297:[],biomed:[0,4],biosimul:[3,5],biosimulators_gillespy2:2,blob:[],block:[],bool:4,bundl:4,bundle_output:4,can:5,carolina:0,center:[0,4],code:[],column:[],com:4,combin:[2,4],combinearchivelog:4,command:[0,2],comment:2,compliant:[2,5],concentr:[],consol:5,contact:0,contain:5,content:[],copyright:4,core:2,could:[4,5],count:[],creat:2,csv:4,data:4,data_model:2,data_typ:4,datafram:[],datageneratorvari:4,datageneratorvariableresult:4,date:4,debug:5,defin:4,defualt:4,describ:[2,5],dev:[],develop:2,dict:4,dictionari:4,dir:5,directori:[4,5],docker:[0,2],drawert:0,edit:[],edu:4,enabl:2,encapsul:[3,5],encod:2,entrypoint:2,enumer:4,error:[],exampl:5,except:[],exec_combine_arch:[],exec_sed_task:4,exec_sedml_docs_in_combine_arch:4,exec_simul:[],execut:[2,4,5],exit:5,experi:2,express:[],featur:4,file:[4,5],fixtur:[],follow:[3,5],format:[2,4],full:5,ghcr:[3,5],gillespi:[],gillespy2:[3,4,5],github:5,gmail:4,gpl:0,hdf5:4,help:5,highlight:[],how:5,http:5,hybrid:4,hybridtauintegrationmethod:4,icahn:0,ids:4,illustr:5,imag:[0,2],index:2,individu:4,info:[],inform:5,inputerror:[],instal:2,instruct:2,integr:4,interfac:[2,5],involv:4,its:4,jonathan:4,karr:[0,4],karrlab:[],keep:4,keep_individual_output:4,kei:4,kisao:4,kisao_0000032:4,kisao_0000088:4,kisao_0000288:4,kisao_0000289:4,kisao_0000304:4,kisao_0000537:4,lab:0,languag:[],latest:5,licens:[2,4],line:[0,2],list:[2,4,5],log:4,lsoda:4,mailto:[],map:4,medicin:0,messag:5,method:4,mit:[0,4],mode:5,model:[0,2,4,5],model_filenam:[],model_sed_urn:[],modul:2,more:[2,5],mount:[0,5],mssm:4,name:4,none:4,north:0,notimplementederror:4,number:5,obj:[],object:4,omex:[2,4],one:[2,5],option:[4,5],org:[],out:5,out_dir:[4,5],out_filenam:[],out_format:[],output:[4,5],packag:[0,2],page:[],panda:[],paramet:[2,4,5],pars:[],path:[4,5],pdf:4,pip:3,pleas:0,plot:4,plot_format:4,plotformat:4,point:[],predict:[],prevent:[],program:[0,2],provid:2,pull:3,pwd:5,python:3,question:2,quiet:5,radau:4,rais:4,readonli:[],record:4,rel:4,releas:0,report:4,report_format:4,reportformat:4,represent:4,reproduc:[0,4],reproduciblebiomodel:[],request:4,requir:[],result:[4,5],rk23:4,rk45:4,root:[],row:[],run:[3,5],runbiosimul:2,same:5,save:[4,5],sbml:2,school:0,search:[],sed:[2,4],sedml:[],servic:2,set_valu:4,shaikh:4,shell:[],should:4,show:5,simpl:2,simul:[2,4],sinai:0,singl:4,solver:4,solver_arg:4,sourc:[4,5],speci:[],start:[],stochss:5,store:4,str:4,str_valu:4,string:4,structur:4,studi:5,submodul:2,support:[2,4,5],suppress:5,target:5,task:4,tasklog:4,tau:4,team:2,test:[],text:[],thi:[0,2,5],time:[],tmp:5,tool:2,trigger:[],tty:5,tupl:4,tutori:2,type:[4,5],under:0,univers:0,unsuport:4,unsupport:[],urn:[],usag:5,use:[2,5],used:5,user:2,uses:[],using:[2,4],valid:4,valu:4,valueerror:4,variabl:4,version:5,vode:4,vodemethod:4,web:2,which:[4,5],within:4,work:5,working_dir:[],www:[],zero:[]},titles:["About BioSimulators-GillesPy2","Index","BioSimulators-GillesPy2 documentation","Installation instructions","biosimulators_gillespy2 package","Tutorial"],titleterms:{about:0,archiv:5,biosimul:[0,2],biosimulators_gillespy2:4,combin:5,command:[3,5],comment:0,content:2,core:4,creat:5,data_model:4,develop:0,docker:[3,5],document:2,encod:5,entrypoint:[3,5],experi:5,gillespy2:[0,2],imag:[3,5],index:1,indic:[],instal:3,instruct:3,licens:0,line:[3,5],modul:4,omex:5,packag:4,program:[3,5],question:0,sed:5,simul:5,submodul:4,tabl:[],team:0,tutori:5,welcom:[]}}) \ No newline at end of file diff --git a/docs/source/biosimulators_gillespy2.html b/docs/source/biosimulators_gillespy2.html index 8ed1aeb..4f6c8a5 100644 --- a/docs/source/biosimulators_gillespy2.html +++ b/docs/source/biosimulators_gillespy2.html @@ -5,14 +5,13 @@ - biosimulators_gillespy2 package — BioSimulators-GillesPy2 0.1.16 documentation + biosimulators_gillespy2 package — BioSimulators-GillesPy2 0.1.17 documentation - @@ -134,20 +133,22 @@

Submodules
-biosimulators_gillespy2.core.exec_sed_task(task, variables)[source]
+biosimulators_gillespy2.core.exec_sed_task(task, variables, log=None)[source]

Execute a task and save its results

Parameters

  • task (Task) – task

  • variables (list of DataGeneratorVariable) – variables that should be recorded

    • +

  • log (TaskLog, optional) – log for the task

Returns
-

results of variables

+

DataGeneratorVariableResults: results of variables +TaskLog: log

Return type
-

DataGeneratorVariableResults

+

tuple

Raises
+
Returns
+

log

+
+
Return type
+

CombineArchiveLog

+
diff --git a/docs/tutorial.html b/docs/tutorial.html index 67982d3..1f703c4 100644 --- a/docs/tutorial.html +++ b/docs/tutorial.html @@ -5,14 +5,13 @@ - Tutorial — BioSimulators-GillesPy2 0.1.16 documentation + Tutorial — BioSimulators-GillesPy2 0.1.17 documentation -