diff --git a/docs/_static/basic.css b/docs/_static/basic.css index 6157296..b97662d 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -670,6 +670,16 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -738,6 +748,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 9d86028..86ceac3 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.33', + VERSION: '0.1.34', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/about.html b/docs/about.html index 09e21bb..7bb0914 100644 --- a/docs/about.html +++ b/docs/about.html @@ -8,7 +8,7 @@ - About BioSimulators-tellurium — BioSimulators-tellurium 0.1.33 documentation + About BioSimulators-tellurium — BioSimulators-tellurium 0.1.34 documentation @@ -28,18 +28,18 @@ - + - + - - - + + + diff --git a/docs/genindex.html b/docs/genindex.html index 4a11bbe..c77b579 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -7,7 +7,7 @@ - Index — BioSimulators-tellurium 0.1.33 documentation + Index — BioSimulators-tellurium 0.1.34 documentation @@ -27,18 +27,18 @@ - + - + - - - + + + @@ -316,10 +316,18 @@

Index

A

+ @@ -418,10 +426,16 @@

M

  • (biosimulators_tellurium.PlottingEngine attribute)
    • -
  • model_change_target_tellurium_id_map (biosimulators_tellurium.data_model.PreprocesssedTask attribute), [1] +
  • model_change_target_tellurium_id_map (biosimulators_tellurium.data_model.PreprocesssedTask attribute) + +
    • +
  • model_change_target_tellurium_id_maps (biosimulators_tellurium.data_model.PreprocesssedTask attribute)
    • @@ -479,10 +493,10 @@

    P

    R

    @@ -501,10 +515,16 @@

    S

    @@ -525,10 +545,10 @@

    T

    V

    diff --git a/docs/index.html b/docs/index.html index c725680..99432aa 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,7 +8,7 @@ - BioSimulators-tellurium documentation — BioSimulators-tellurium 0.1.33 documentation + BioSimulators-tellurium documentation — BioSimulators-tellurium 0.1.34 documentation @@ -28,18 +28,18 @@ - + - + - - - + + + diff --git a/docs/installation.html b/docs/installation.html index 47b6e31..889fcc9 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -8,7 +8,7 @@ - Installation instructions — BioSimulators-tellurium 0.1.33 documentation + Installation instructions — BioSimulators-tellurium 0.1.34 documentation @@ -28,18 +28,18 @@ - + - + - - - + + + diff --git a/docs/py-modindex.html b/docs/py-modindex.html index 71cb4f8..53b393d 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -7,7 +7,7 @@ - Python Module Index — BioSimulators-tellurium 0.1.33 documentation + Python Module Index — BioSimulators-tellurium 0.1.34 documentation @@ -27,18 +27,18 @@ - + - + - - - + + + diff --git a/docs/search.html b/docs/search.html index 51dfc95..cfdd6e7 100644 --- a/docs/search.html +++ b/docs/search.html @@ -6,7 +6,7 @@ - Search - BioSimulators-tellurium 0.1.33 documentation + Search - BioSimulators-tellurium 0.1.34 documentation @@ -26,18 +26,18 @@ - + - + - - - + + + diff --git a/docs/searchindex.js b/docs/searchindex.js index e006c3c..0c974b9 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["about", "genindex", "index", "installation", "source/biosimulators_tellurium", "tutorial"], "filenames": ["about.rst", "genindex.rst", "index.rst", "installation.rst", "source/biosimulators_tellurium.rst", "tutorial.rst"], "titles": ["About BioSimulators-tellurium", "Index", "BioSimulators-tellurium documentation", "Installation instructions", "biosimulators_tellurium package", "Tutorial"], "terms": {"thi": [0, 2, 4, 5], "packag": [0, 2], "i": [0, 2, 3, 4, 5], "releas": 0, "under": 0, "mit": [0, 4], "apach": 0, "2": 0, "0": [0, 4], "wa": 0, "karr": [0, 4], "lab": 0, "icahn": 0, "school": 0, "medicin": 0, "mount": [0, 5], "sinai": 0, "center": [0, 4], "reproduc": [0, 4], "biomed": [0, 4], "model": [0, 2, 4, 5], "sauro": 0, "univers": 0, "washington": 0, "pleas": 0, "contact": 0, "ani": [0, 4], "command": [0, 2], "line": [0, 2], "program": [0, 2], "docker": [0, 2], "imag": [0, 2], "provid": 2, "compliant": [2, 5], "interfac": [2, 5], "biolog": 2, "simul": 2, "tool": 2, "A": [2, 5], "also": 2, "avail": [2, 3, 5], "enabl": 2, "user": 2, "us": [2, 4, 5], "execut": [2, 4, 5], "combin": [2, 4], "omex": [2, 4], "archiv": [2, 4], "describ": [2, 5], "one": [2, 5], "more": [2, 5], "experi": 2, "sed": [2, 4], "ml": [2, 4], "format": 2, "sbml": 2, "list": [2, 4, 5], "algorithm": [2, 4, 5], "paramet": [2, 4, 5], "support": [2, 4, 5], "simpl": 2, "web": 2, "applic": [2, 5], "servic": 2, "runbiosimul": 2, "instal": 2, "instruct": 2, "entrypoint": 2, "tutori": 2, "creat": 2, "encod": 2, "api": 2, "plottingengin": [2, 4], "preprocesssedtask": [2, 4], "sedmlinterpret": [2, 4], "exec_sed_doc": [2, 4], "exec_sed_task": [2, 4], "exec_sedml_docs_in_combine_arch": [2, 4], "get_simulator_vers": [2, 4], "preprocess_sed_task": [2, 4], "submodul": 2, "biosimulators_tellurium": 2, "config": 2, "modul": 2, "core": 2, "data_model": 2, "about": [2, 4, 5], "licens": [2, 4], "develop": 2, "team": 2, "question": 2, "comment": 2, "index": [2, 4], "biosimul": [3, 4, 5], "tellurium": [3, 4, 5], "encapsul": [3, 5], "after": 3, "python": 3, "3": 3, "7": 3, "pip": 3, "libncurs": 3, "libxml": 3, "run": [3, 5], "follow": [3, 5], "pull": 3, "ghcr": [3, 5], "io": [3, 5], "class": 4, "valu": 4, "sourc": [4, 5], "base": 4, "str": 4, "enum": 4, "engin": 4, "plott": 4, "matplotlib": 4, "plotli": 4, "road_runn": 4, "roadrunn": 4, "solver": 4, "integr": 4, "steadystatesolv": 4, "model_change_target_tellurium_id_map": 4, "dict": 4, "algorithm_kisao_id": 4, "variable_target_tellurium_observable_map": 4, "object": 4, "process": 4, "inform": [4, 5], "task": 4, "road": 4, "runner": 4, "instanc": 4, "type": [4, 5], "dictionari": 4, "map": 4, "target": [4, 5], "chang": 4, "correspond": 4, "identifi": 4, "tupl": 4, "within": 4, "kisao": 4, "id": 4, "variabl": 4, "symbol": 4, "observ": 4, "code": 4, "interpret": 4, "doc": 4, "working_dir": 4, "base_out_path": 4, "rel_out_path": 4, "none": 4, "apply_xml_model_chang": 4, "fals": 4, "log": 4, "indent": 4, "pretty_print_modified_xml_model": 4, "log_level": 4, "standardoutputerrorcapturerlevel": 4, "c": 4, "simulator_config": 4, "specifi": 4, "document": 4, "gener": 4, "output": [4, 5], "seddocu": 4, "path": [4, 5], "file": [4, 5], "which": [4, 5], "defin": 4, "work": [4, 5], "directori": [4, 5], "rel": 4, "ar": 4, "locat": 4, "store": 4, "csv": 4, "save": [4, 5], "report": 4, "hdf5": 4, "singl": 4, "h5": 4, "kei": 4, "option": [4, 5], "bool": 4, "true": 4, "appli": 4, "befor": 4, "call": 4, "task_execut": 4, "seddocumentlog": 4, "int": 4, "degre": 4, "statu": 4, "messag": [4, 5], "pretti": 4, "print": 4, "modifi": 4, "xml": 4, "level": 4, "common": 4, "configur": 4, "simulatorconfig": 4, "return": 4, "reportresult": 4, "result": [4, 5], "each": 4, "preprocessed_task": 4, "its": 4, "should": 4, "record": 4, "preprocessedtask": 4, "preprocess": 4, "includ": 4, "possibl": 4, "can": [4, 5], "avoid": 4, "repeatedli": 4, "same": [4, 5], "initi": 4, "repeat": 4, "method": 4, "tasklog": 4, "variableresult": 4, "rais": 4, "valueerror": 4, "an": 4, "aspect": 4, "valid": 4, "request": 4, "could": [4, 5], "notimplementederror": 4, "involv": 4, "unsuport": 4, "featur": 4, "archive_filenam": 4, "out_dir": [4, 5], "seddocumentresult": 4, "combinearchivelog": 4, "get": 4, "version": [4, 5], "author": 4, "jonathan": 4, "mssm": 4, "edu": 4, "date": 4, "2021": 4, "01": 4, "04": 4, "copyright": 4, "sedml_interpret": 4, "plotting_engin": 4, "plot": 4, "2020": 4, "data": 4, "08": 4, "23": 4, "how": 5, "here": 5, "The": 5, "illustr": 5, "below": 5, "usag": 5, "h": 5, "d": 5, "q": 5, "o": 5, "v": 5, "http": 5, "analogmachin": 5, "org": 5, "argument": 5, "help": 5, "show": 5, "exit": 5, "debug": 5, "full": 5, "mode": 5, "quiet": 5, "suppress": 5, "all": 5, "consol": 5, "contain": 5, "out": 5, "dir": 5, "": 5, "number": 5, "For": 5, "exampl": 5, "studi": 5, "abov": 5, "tty": 5, "rm": 5, "bind": 5, "pwd": 5, "tmp": 5, "latest": 5, "name": 4, "qualnam": 4, "start": 4, "1": 4, "boundari": 4}, "objects": {"": [[4, 0, 0, "-", "biosimulators_tellurium"]], "biosimulators_tellurium": [[4, 1, 1, "", "PlottingEngine"], [4, 1, 1, "", "PreprocesssedTask"], [4, 1, 1, "", "SedmlInterpreter"], [4, 0, 0, "-", "config"], [4, 0, 0, "-", "core"], [4, 0, 0, "-", "data_model"], [4, 3, 1, "", "exec_sed_doc"], [4, 3, 1, "", "exec_sed_task"], [4, 3, 1, "", "exec_sedml_docs_in_combine_archive"], [4, 3, 1, "", "get_simulator_version"], [4, 3, 1, "", "preprocess_sed_task"]], "biosimulators_tellurium.PlottingEngine": [[4, 2, 1, "", "matplotlib"], [4, 2, 1, "", "plotly"]], "biosimulators_tellurium.PreprocesssedTask": [[4, 2, 1, "id0", "algorithm_kisao_id"], [4, 2, 1, "id1", "model_change_target_tellurium_id_map"], [4, 2, 1, "id2", "road_runner"], [4, 2, 1, "id3", "solver"], [4, 2, 1, "id4", "variable_target_tellurium_observable_map"]], "biosimulators_tellurium.SedmlInterpreter": [[4, 2, 1, "", "biosimulators"], [4, 2, 1, "", "tellurium"]], "biosimulators_tellurium.config": [[4, 1, 1, "", "Config"]], "biosimulators_tellurium.config.Config": [[4, 2, 1, "", "plotting_engine"], [4, 2, 1, "", "sedml_interpreter"]], "biosimulators_tellurium.core": [[4, 3, 1, "", "exec_sed_doc"], [4, 3, 1, "", "exec_sed_task"], [4, 3, 1, "", "exec_sedml_docs_in_combine_archive"], [4, 3, 1, "", "preprocess_sed_task"]], "biosimulators_tellurium.data_model": [[4, 1, 1, "", "PlottingEngine"], [4, 1, 1, "", "PreprocesssedTask"], [4, 1, 1, "", "SedmlInterpreter"]], "biosimulators_tellurium.data_model.PlottingEngine": [[4, 2, 1, "", "matplotlib"], [4, 2, 1, "", "plotly"]], "biosimulators_tellurium.data_model.PreprocesssedTask": [[4, 2, 1, "id5", "algorithm_kisao_id"], [4, 2, 1, "id6", "model_change_target_tellurium_id_map"], [4, 2, 1, "id7", "road_runner"], [4, 2, 1, "id8", "solver"], [4, 2, 1, "id9", "variable_target_tellurium_observable_map"]], "biosimulators_tellurium.data_model.SedmlInterpreter": [[4, 2, 1, "", "biosimulators"], [4, 2, 1, "", "tellurium"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"]}, "titleterms": {"about": 0, "biosimul": [0, 2], "tellurium": [0, 2], "licens": 0, "develop": 0, "team": 0, "question": 0, "comment": 0, "index": 1, "document": 2, "content": 2, "instal": 3, "instruct": 3, "command": [3, 5], "line": [3, 5], "program": [3, 5], "docker": [3, 5], "imag": [3, 5], "entrypoint": [3, 5], "biosimulators_tellurium": 4, "packag": 4, "submodul": 4, "config": 4, "modul": 4, "core": 4, "data_model": 4, "tutori": 5, "creat": 5, "combin": 5, "omex": 5, "archiv": 5, "encod": 5, "simul": 5, "experi": 5, "sed": 5, "ml": 5}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "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": 57}, "alltitles": {"About BioSimulators-tellurium": [[0, "about-biosimulators-tellurium"]], "License": [[0, "license"]], "Development team": [[0, "development-team"]], "Questions and comments": [[0, "questions-and-comments"]], "Index": [[1, "index"]], "BioSimulators-tellurium documentation": [[2, "biosimulators-tellurium-documentation"]], "Contents": [[2, "contents"]], "Installation instructions": [[3, "installation-instructions"]], "Command-line program": [[3, "command-line-program"], [5, "command-line-program"]], "Docker image with a command-line entrypoint": [[3, "docker-image-with-a-command-line-entrypoint"], [5, "docker-image-with-a-command-line-entrypoint"]], "biosimulators_tellurium package": [[4, "module-biosimulators_tellurium"]], "Submodules": [[4, "submodules"]], "biosimulators_tellurium.config module": [[4, "module-biosimulators_tellurium.config"]], "biosimulators_tellurium.core module": [[4, "module-biosimulators_tellurium.core"]], "biosimulators_tellurium.data_model module": [[4, "module-biosimulators_tellurium.data_model"]], "Tutorial": [[5, "tutorial"]], "Creating COMBINE/OMEX archives and encoding simulation experiments into SED-ML": [[5, "creating-combine-omex-archives-and-encoding-simulation-experiments-into-sed-ml"]]}, "indexentries": {"config (class in biosimulators_tellurium.config)": [[4, "biosimulators_tellurium.config.Config"]], "plottingengine (class in biosimulators_tellurium)": [[4, "biosimulators_tellurium.PlottingEngine"]], "plottingengine (class in biosimulators_tellurium.data_model)": [[4, "biosimulators_tellurium.data_model.PlottingEngine"]], "preprocesssedtask (class in biosimulators_tellurium)": [[4, "biosimulators_tellurium.PreprocesssedTask"]], "preprocesssedtask (class in biosimulators_tellurium.data_model)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask"]], "sedmlinterpreter (class in biosimulators_tellurium)": [[4, "biosimulators_tellurium.SedmlInterpreter"]], "sedmlinterpreter (class in biosimulators_tellurium.data_model)": [[4, "biosimulators_tellurium.data_model.SedmlInterpreter"]], "algorithm_kisao_id (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.algorithm_kisao_id"], [4, "id0"]], "algorithm_kisao_id (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.algorithm_kisao_id"], [4, "id5"]], "biosimulators (biosimulators_tellurium.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.SedmlInterpreter.biosimulators"]], "biosimulators (biosimulators_tellurium.data_model.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.data_model.SedmlInterpreter.biosimulators"]], "biosimulators_tellurium": [[4, "module-biosimulators_tellurium"]], "biosimulators_tellurium.config": [[4, "module-biosimulators_tellurium.config"]], "biosimulators_tellurium.core": [[4, "module-biosimulators_tellurium.core"]], "biosimulators_tellurium.data_model": [[4, "module-biosimulators_tellurium.data_model"]], "exec_sed_doc() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.exec_sed_doc"]], "exec_sed_doc() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.exec_sed_doc"]], "exec_sed_task() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.exec_sed_task"]], "exec_sed_task() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.exec_sed_task"]], "exec_sedml_docs_in_combine_archive() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.exec_sedml_docs_in_combine_archive"]], "exec_sedml_docs_in_combine_archive() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.exec_sedml_docs_in_combine_archive"]], "get_simulator_version() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.get_simulator_version"]], "matplotlib (biosimulators_tellurium.plottingengine attribute)": [[4, "biosimulators_tellurium.PlottingEngine.matplotlib"]], "matplotlib (biosimulators_tellurium.data_model.plottingengine attribute)": [[4, "biosimulators_tellurium.data_model.PlottingEngine.matplotlib"]], "model_change_target_tellurium_id_map (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.model_change_target_tellurium_id_map"], [4, "id1"]], "model_change_target_tellurium_id_map (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.model_change_target_tellurium_id_map"], [4, "id6"]], "module": [[4, "module-biosimulators_tellurium"], [4, "module-biosimulators_tellurium.config"], [4, "module-biosimulators_tellurium.core"], [4, "module-biosimulators_tellurium.data_model"]], "plotly (biosimulators_tellurium.plottingengine attribute)": [[4, "biosimulators_tellurium.PlottingEngine.plotly"]], "plotly (biosimulators_tellurium.data_model.plottingengine attribute)": [[4, "biosimulators_tellurium.data_model.PlottingEngine.plotly"]], "plotting_engine (biosimulators_tellurium.config.config attribute)": [[4, "biosimulators_tellurium.config.Config.plotting_engine"]], "preprocess_sed_task() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.preprocess_sed_task"]], "preprocess_sed_task() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.preprocess_sed_task"]], "road_runner (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.road_runner"], [4, "id2"]], "road_runner (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.road_runner"], [4, "id7"]], "sedml_interpreter (biosimulators_tellurium.config.config attribute)": [[4, "biosimulators_tellurium.config.Config.sedml_interpreter"]], "solver (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.solver"], [4, "id3"]], "solver (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.solver"], [4, "id8"]], "tellurium (biosimulators_tellurium.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.SedmlInterpreter.tellurium"]], "tellurium (biosimulators_tellurium.data_model.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.data_model.SedmlInterpreter.tellurium"]], "variable_target_tellurium_observable_map (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.variable_target_tellurium_observable_map"], [4, "id4"]], "variable_target_tellurium_observable_map (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.variable_target_tellurium_observable_map"], [4, "id9"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["about", "genindex", "index", "installation", "source/biosimulators_tellurium", "tutorial"], "filenames": ["about.rst", "genindex.rst", "index.rst", "installation.rst", "source/biosimulators_tellurium.rst", "tutorial.rst"], "titles": ["About BioSimulators-tellurium", "Index", "BioSimulators-tellurium documentation", "Installation instructions", "biosimulators_tellurium package", "Tutorial"], "terms": {"thi": [0, 2, 4, 5], "packag": [0, 2], "i": [0, 2, 3, 4, 5], "releas": 0, "under": 0, "mit": [0, 4], "apach": 0, "2": 0, "0": [0, 4], "wa": 0, "karr": [0, 4], "lab": 0, "icahn": 0, "school": 0, "medicin": 0, "mount": [0, 5], "sinai": 0, "center": [0, 4], "reproduc": [0, 4], "biomed": [0, 4], "model": [0, 2, 4, 5], "sauro": 0, "univers": 0, "washington": 0, "pleas": 0, "contact": 0, "ani": [0, 4], "command": [0, 2], "line": [0, 2], "program": [0, 2], "docker": [0, 2], "imag": [0, 2], "provid": 2, "compliant": [2, 5], "interfac": [2, 5], "biolog": 2, "simul": 2, "tool": 2, "A": [2, 5], "also": 2, "avail": [2, 3, 5], "enabl": 2, "user": 2, "us": [2, 4, 5], "execut": [2, 4, 5], "combin": [2, 4], "omex": [2, 4], "archiv": [2, 4], "describ": [2, 5], "one": [2, 5], "more": [2, 5], "experi": 2, "sed": [2, 4], "ml": [2, 4], "format": 2, "sbml": 2, "list": [2, 4, 5], "algorithm": [2, 4, 5], "paramet": [2, 4, 5], "support": [2, 4, 5], "simpl": 2, "web": 2, "applic": [2, 5], "servic": 2, "runbiosimul": 2, "instal": 2, "instruct": 2, "entrypoint": 2, "tutori": 2, "creat": 2, "encod": 2, "api": 2, "plottingengin": [2, 4], "preprocesssedtask": [2, 4], "sedmlinterpret": [2, 4], "exec_sed_doc": [2, 4], "exec_sed_task": [2, 4], "exec_sedml_docs_in_combine_arch": [2, 4], "get_simulator_vers": [2, 4], "preprocess_sed_task": [2, 4], "submodul": 2, "biosimulators_tellurium": 2, "config": 2, "modul": 2, "core": 2, "data_model": 2, "about": [2, 4, 5], "licens": [2, 4], "develop": 2, "team": 2, "question": 2, "comment": 2, "index": [2, 4], "biosimul": [3, 4, 5], "tellurium": [3, 4, 5], "encapsul": [3, 5], "after": 3, "python": 3, "3": 3, "7": 3, "pip": 3, "libncurs": 3, "libxml": 3, "run": [3, 5], "follow": [3, 5], "pull": 3, "ghcr": [3, 5], "io": [3, 5], "class": 4, "valu": 4, "name": 4, "none": 4, "qualnam": 4, "type": [4, 5], "start": 4, "1": 4, "boundari": 4, "sourc": [4, 5], "base": 4, "str": 4, "enum": 4, "engin": 4, "plott": 4, "matplotlib": 4, "plotli": 4, "road_runn": 4, "dict": 4, "solver": 4, "model_change_target_tellurium_id_map": 4, "algorithm_kisao_id": 4, "variable_target_tellurium_observable_map": 4, "object": 4, "process": 4, "inform": [4, 5], "task": 4, "road": 4, "runner": 4, "instanc": 4, "per": 4, "roadrunn": 4, "integr": 4, "steadystatesolv": 4, "dictionari": 4, "map": 4, "target": [4, 5], "chang": 4, "correspond": 4, "identifi": 4, "tupl": 4, "within": 4, "kisao": 4, "id": 4, "variabl": 4, "symbol": 4, "observ": 4, "code": 4, "interpret": 4, "doc": 4, "working_dir": 4, "base_out_path": 4, "rel_out_path": 4, "apply_xml_model_chang": 4, "fals": 4, "log": 4, "indent": 4, "pretty_print_modified_xml_model": 4, "log_level": 4, "standardoutputerrorcapturerlevel": 4, "c": 4, "simulator_config": 4, "specifi": 4, "document": 4, "gener": 4, "output": [4, 5], "seddocu": 4, "path": [4, 5], "file": [4, 5], "which": [4, 5], "defin": 4, "work": [4, 5], "directori": [4, 5], "rel": 4, "ar": 4, "locat": 4, "store": 4, "csv": 4, "save": [4, 5], "report": 4, "hdf5": 4, "singl": 4, "h5": 4, "kei": 4, "option": [4, 5], "bool": 4, "true": 4, "appli": 4, "befor": 4, "call": 4, "task_execut": 4, "seddocumentlog": 4, "int": 4, "degre": 4, "statu": 4, "messag": [4, 5], "pretti": 4, "print": 4, "modifi": 4, "xml": 4, "level": 4, "common": 4, "configur": 4, "simulatorconfig": 4, "return": 4, "reportresult": 4, "result": [4, 5], "each": 4, "preprocessed_task": 4, "its": 4, "should": 4, "record": 4, "preprocessedtask": 4, "preprocess": 4, "includ": 4, "possibl": 4, "can": [4, 5], "avoid": 4, "repeatedli": 4, "same": [4, 5], "initi": 4, "repeat": 4, "method": 4, "tasklog": 4, "variableresult": 4, "rais": 4, "valueerror": 4, "an": 4, "aspect": 4, "valid": 4, "request": 4, "could": [4, 5], "notimplementederror": 4, "involv": 4, "unsuport": 4, "featur": 4, "archive_filenam": 4, "out_dir": [4, 5], "seddocumentresult": 4, "combinearchivelog": 4, "get": 4, "version": [4, 5], "author": 4, "jonathan": 4, "mssm": 4, "edu": 4, "date": 4, "2021": 4, "01": 4, "04": 4, "copyright": 4, "sedml_interpret": 4, "plotting_engin": 4, "plot": 4, "2020": 4, "data": 4, "08": 4, "23": 4, "how": 5, "here": 5, "The": 5, "illustr": 5, "below": 5, "usag": 5, "h": 5, "d": 5, "q": 5, "o": 5, "v": 5, "http": 5, "analogmachin": 5, "org": 5, "argument": 5, "help": 5, "show": 5, "exit": 5, "debug": 5, "full": 5, "mode": 5, "quiet": 5, "suppress": 5, "all": 5, "consol": 5, "contain": 5, "out": 5, "dir": 5, "": 5, "number": 5, "For": 5, "exampl": 5, "studi": 5, "abov": 5, "tty": 5, "rm": 5, "bind": 5, "pwd": 5, "tmp": 5, "latest": 5}, "objects": {"": [[4, 0, 0, "-", "biosimulators_tellurium"]], "biosimulators_tellurium": [[4, 1, 1, "", "PlottingEngine"], [4, 1, 1, "", "PreprocesssedTask"], [4, 1, 1, "", "SedmlInterpreter"], [4, 0, 0, "-", "config"], [4, 0, 0, "-", "core"], [4, 0, 0, "-", "data_model"], [4, 3, 1, "", "exec_sed_doc"], [4, 3, 1, "", "exec_sed_task"], [4, 3, 1, "", "exec_sedml_docs_in_combine_archive"], [4, 3, 1, "", "get_simulator_version"], [4, 3, 1, "", "preprocess_sed_task"]], "biosimulators_tellurium.PlottingEngine": [[4, 2, 1, "", "matplotlib"], [4, 2, 1, "", "plotly"]], "biosimulators_tellurium.PreprocesssedTask": [[4, 2, 1, "", "algorithm_kisao_id"], [4, 2, 1, "", "algorithm_kisao_ids"], [4, 2, 1, "", "model_change_target_tellurium_id_map"], [4, 2, 1, "", "model_change_target_tellurium_id_maps"], [4, 2, 1, "id0", "road_runners"], [4, 2, 1, "", "solver"], [4, 2, 1, "", "solvers"], [4, 2, 1, "id1", "variable_target_tellurium_observable_maps"]], "biosimulators_tellurium.SedmlInterpreter": [[4, 2, 1, "", "biosimulators"], [4, 2, 1, "", "tellurium"]], "biosimulators_tellurium.config": [[4, 1, 1, "", "Config"]], "biosimulators_tellurium.config.Config": [[4, 2, 1, "", "plotting_engine"], [4, 2, 1, "", "sedml_interpreter"]], "biosimulators_tellurium.core": [[4, 3, 1, "", "exec_sed_doc"], [4, 3, 1, "", "exec_sed_task"], [4, 3, 1, "", "exec_sedml_docs_in_combine_archive"], [4, 3, 1, "", "preprocess_sed_task"]], "biosimulators_tellurium.data_model": [[4, 1, 1, "", "PlottingEngine"], [4, 1, 1, "", "PreprocesssedTask"], [4, 1, 1, "", "SedmlInterpreter"]], "biosimulators_tellurium.data_model.PlottingEngine": [[4, 2, 1, "", "matplotlib"], [4, 2, 1, "", "plotly"]], "biosimulators_tellurium.data_model.PreprocesssedTask": [[4, 2, 1, "", "algorithm_kisao_id"], [4, 2, 1, "", "algorithm_kisao_ids"], [4, 2, 1, "", "model_change_target_tellurium_id_map"], [4, 2, 1, "", "model_change_target_tellurium_id_maps"], [4, 2, 1, "id2", "road_runners"], [4, 2, 1, "", "solver"], [4, 2, 1, "", "solvers"], [4, 2, 1, "id3", "variable_target_tellurium_observable_maps"]], "biosimulators_tellurium.data_model.SedmlInterpreter": [[4, 2, 1, "", "biosimulators"], [4, 2, 1, "", "tellurium"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"]}, "titleterms": {"about": 0, "biosimul": [0, 2], "tellurium": [0, 2], "licens": 0, "develop": 0, "team": 0, "question": 0, "comment": 0, "index": 1, "document": 2, "content": 2, "instal": 3, "instruct": 3, "command": [3, 5], "line": [3, 5], "program": [3, 5], "docker": [3, 5], "imag": [3, 5], "entrypoint": [3, 5], "biosimulators_tellurium": 4, "packag": 4, "submodul": 4, "config": 4, "modul": 4, "core": 4, "data_model": 4, "tutori": 5, "creat": 5, "combin": 5, "omex": 5, "archiv": 5, "encod": 5, "simul": 5, "experi": 5, "sed": 5, "ml": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 58}, "alltitles": {"About BioSimulators-tellurium": [[0, "about-biosimulators-tellurium"]], "License": [[0, "license"]], "Development team": [[0, "development-team"]], "Questions and comments": [[0, "questions-and-comments"]], "Index": [[1, "index"]], "BioSimulators-tellurium documentation": [[2, "biosimulators-tellurium-documentation"]], "Contents": [[2, "contents"]], "Installation instructions": [[3, "installation-instructions"]], "Command-line program": [[3, "command-line-program"], [5, "command-line-program"]], "Docker image with a command-line entrypoint": [[3, "docker-image-with-a-command-line-entrypoint"], [5, "docker-image-with-a-command-line-entrypoint"]], "biosimulators_tellurium package": [[4, "module-biosimulators_tellurium"]], "Submodules": [[4, "submodules"]], "biosimulators_tellurium.config module": [[4, "module-biosimulators_tellurium.config"]], "biosimulators_tellurium.core module": [[4, "module-biosimulators_tellurium.core"]], "biosimulators_tellurium.data_model module": [[4, "module-biosimulators_tellurium.data_model"]], "Tutorial": [[5, "tutorial"]], "Creating COMBINE/OMEX archives and encoding simulation experiments into SED-ML": [[5, "creating-combine-omex-archives-and-encoding-simulation-experiments-into-sed-ml"]]}, "indexentries": {"config (class in biosimulators_tellurium.config)": [[4, "biosimulators_tellurium.config.Config"]], "plottingengine (class in biosimulators_tellurium)": [[4, "biosimulators_tellurium.PlottingEngine"]], "plottingengine (class in biosimulators_tellurium.data_model)": [[4, "biosimulators_tellurium.data_model.PlottingEngine"]], "preprocesssedtask (class in biosimulators_tellurium)": [[4, "biosimulators_tellurium.PreprocesssedTask"]], "preprocesssedtask (class in biosimulators_tellurium.data_model)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask"]], "sedmlinterpreter (class in biosimulators_tellurium)": [[4, "biosimulators_tellurium.SedmlInterpreter"]], "sedmlinterpreter (class in biosimulators_tellurium.data_model)": [[4, "biosimulators_tellurium.data_model.SedmlInterpreter"]], "algorithm_kisao_id (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.algorithm_kisao_id"]], "algorithm_kisao_id (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.algorithm_kisao_id"]], "algorithm_kisao_ids (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.algorithm_kisao_ids"]], "algorithm_kisao_ids (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.algorithm_kisao_ids"]], "biosimulators (biosimulators_tellurium.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.SedmlInterpreter.biosimulators"]], "biosimulators (biosimulators_tellurium.data_model.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.data_model.SedmlInterpreter.biosimulators"]], "biosimulators_tellurium": [[4, "module-biosimulators_tellurium"]], "biosimulators_tellurium.config": [[4, "module-biosimulators_tellurium.config"]], "biosimulators_tellurium.core": [[4, "module-biosimulators_tellurium.core"]], "biosimulators_tellurium.data_model": [[4, "module-biosimulators_tellurium.data_model"]], "exec_sed_doc() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.exec_sed_doc"]], "exec_sed_doc() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.exec_sed_doc"]], "exec_sed_task() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.exec_sed_task"]], "exec_sed_task() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.exec_sed_task"]], "exec_sedml_docs_in_combine_archive() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.exec_sedml_docs_in_combine_archive"]], "exec_sedml_docs_in_combine_archive() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.exec_sedml_docs_in_combine_archive"]], "get_simulator_version() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.get_simulator_version"]], "matplotlib (biosimulators_tellurium.plottingengine attribute)": [[4, "biosimulators_tellurium.PlottingEngine.matplotlib"]], "matplotlib (biosimulators_tellurium.data_model.plottingengine attribute)": [[4, "biosimulators_tellurium.data_model.PlottingEngine.matplotlib"]], "model_change_target_tellurium_id_map (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.model_change_target_tellurium_id_map"]], "model_change_target_tellurium_id_map (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.model_change_target_tellurium_id_map"]], "model_change_target_tellurium_id_maps (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.model_change_target_tellurium_id_maps"]], "model_change_target_tellurium_id_maps (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.model_change_target_tellurium_id_maps"]], "module": [[4, "module-biosimulators_tellurium"], [4, "module-biosimulators_tellurium.config"], [4, "module-biosimulators_tellurium.core"], [4, "module-biosimulators_tellurium.data_model"]], "plotly (biosimulators_tellurium.plottingengine attribute)": [[4, "biosimulators_tellurium.PlottingEngine.plotly"]], "plotly (biosimulators_tellurium.data_model.plottingengine attribute)": [[4, "biosimulators_tellurium.data_model.PlottingEngine.plotly"]], "plotting_engine (biosimulators_tellurium.config.config attribute)": [[4, "biosimulators_tellurium.config.Config.plotting_engine"]], "preprocess_sed_task() (in module biosimulators_tellurium)": [[4, "biosimulators_tellurium.preprocess_sed_task"]], "preprocess_sed_task() (in module biosimulators_tellurium.core)": [[4, "biosimulators_tellurium.core.preprocess_sed_task"]], "road_runners (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.road_runners"], [4, "id0"]], "road_runners (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.road_runners"], [4, "id2"]], "sedml_interpreter (biosimulators_tellurium.config.config attribute)": [[4, "biosimulators_tellurium.config.Config.sedml_interpreter"]], "solver (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.solver"]], "solver (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.solver"]], "solvers (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.solvers"]], "solvers (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.solvers"]], "tellurium (biosimulators_tellurium.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.SedmlInterpreter.tellurium"]], "tellurium (biosimulators_tellurium.data_model.sedmlinterpreter attribute)": [[4, "biosimulators_tellurium.data_model.SedmlInterpreter.tellurium"]], "variable_target_tellurium_observable_maps (biosimulators_tellurium.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.PreprocesssedTask.variable_target_tellurium_observable_maps"], [4, "id1"]], "variable_target_tellurium_observable_maps (biosimulators_tellurium.data_model.preprocesssedtask attribute)": [[4, "biosimulators_tellurium.data_model.PreprocesssedTask.variable_target_tellurium_observable_maps"], [4, "id3"]]}}) \ No newline at end of file diff --git a/docs/source/biosimulators_tellurium.html b/docs/source/biosimulators_tellurium.html index 6a42b1f..01d0198 100644 --- a/docs/source/biosimulators_tellurium.html +++ b/docs/source/biosimulators_tellurium.html @@ -8,7 +8,7 @@ - biosimulators_tellurium package — BioSimulators-tellurium 0.1.33 documentation + biosimulators_tellurium package — BioSimulators-tellurium 0.1.34 documentation @@ -28,18 +28,18 @@ - + - + - - - + + + @@ -350,13 +350,13 @@
    -class biosimulators_tellurium.PreprocesssedTask(road_runner: RoadRunner, solver: Integrator | SteadyStateSolver, model_change_target_tellurium_id_map: dict, algorithm_kisao_id: str, variable_target_tellurium_observable_map: dict)[source]#
    +class biosimulators_tellurium.PreprocesssedTask(road_runners: dict, solvers: dict, model_change_target_tellurium_id_maps: dict, algorithm_kisao_ids: dict, variable_target_tellurium_observable_maps: dict)[source]#

    Bases: object

    Processed information about a SED task

    -
    -road_runner[source]#
    -

    Road Runner instance with model

    +
    +road_runners[source]#
    +

    Road Runner instances with model, per task

    Type:

    roadrunner.RoadRunner

    @@ -367,7 +367,7 @@
    solver[source]#
    -

    solver

    +

    solver, per task

    Type:

    roadrunner.Integrator or roadrunner.SteadyStateSolver

    @@ -378,8 +378,8 @@
    model_change_target_tellurium_id_map[source]#
    -

    dictionary that maps the targets of -changes to their corresponding tellurium identifiers (tuples of their type and index within their type)

    +

    dictionaries that map the targets of +changes to their corresponding tellurium identifiers (tuples of their type and index within their type), per task

    Type:

    dict

    @@ -390,7 +390,7 @@
    algorithm_kisao_id[source]#
    -

    KiSAO id of algorithm to execute

    +

    dictionaries of KiSAO id of algorithm to execute, per task

    Type:

    str

    @@ -399,10 +399,10 @@
    -
    -variable_target_tellurium_observable_map[source]#
    -

    dictionary that maps tuples of variable targets and -symbols to their corresponding tellurium observable identifiers

    +
    +variable_target_tellurium_observable_maps[source]#
    +

    dictionary of dictionaries that map tuples of variable targets and +symbols to their corresponding tellurium observable identifiers, per task

    Type:

    dict

    @@ -411,28 +411,28 @@
    -
    -algorithm_kisao_id: str[source]#
    +
    +algorithm_kisao_ids: dict[source]#
    -
    -model_change_target_tellurium_id_map: dict[source]#
    +
    +model_change_target_tellurium_id_maps: dict[source]#
    -
    -road_runner: RoadRunner[source]#
    +
    +road_runners: dict[source]#
    -
    -solver: Integrator | SteadyStateSolver[source]#
    +
    +solvers: dict[source]#
    -
    -variable_target_tellurium_observable_map: dict[source]#
    +
    +variable_target_tellurium_observable_maps: dict[source]#
    @@ -834,13 +834,13 @@

    Submodules
    -class biosimulators_tellurium.data_model.PreprocesssedTask(road_runner: RoadRunner, solver: Integrator | SteadyStateSolver, model_change_target_tellurium_id_map: dict, algorithm_kisao_id: str, variable_target_tellurium_observable_map: dict)[source]#
    +class biosimulators_tellurium.data_model.PreprocesssedTask(road_runners: dict, solvers: dict, model_change_target_tellurium_id_maps: dict, algorithm_kisao_ids: dict, variable_target_tellurium_observable_maps: dict)[source]#

    Bases: object

    Processed information about a SED task

    -
    -road_runner[source]#
    -

    Road Runner instance with model

    +
    +road_runners[source]#
    +

    Road Runner instances with model, per task

    Type:

    roadrunner.RoadRunner

    @@ -851,7 +851,7 @@

    Submodules
    solver[source]#
    -

    solver

    +

    solver, per task

    Type:

    roadrunner.Integrator or roadrunner.SteadyStateSolver

    @@ -862,8 +862,8 @@

    Submodules
    model_change_target_tellurium_id_map[source]#
    -

    dictionary that maps the targets of -changes to their corresponding tellurium identifiers (tuples of their type and index within their type)

    +

    dictionaries that map the targets of +changes to their corresponding tellurium identifiers (tuples of their type and index within their type), per task

    Type:

    dict

    @@ -874,7 +874,7 @@

    Submodules
    algorithm_kisao_id[source]#
    -

    KiSAO id of algorithm to execute

    +

    dictionaries of KiSAO id of algorithm to execute, per task

    Type:

    str

    @@ -883,10 +883,10 @@

    Submodules -
    -variable_target_tellurium_observable_map[source]#
    -

    dictionary that maps tuples of variable targets and -symbols to their corresponding tellurium observable identifiers

    +
    +variable_target_tellurium_observable_maps[source]#
    +

    dictionary of dictionaries that map tuples of variable targets and +symbols to their corresponding tellurium observable identifiers, per task

    Type:

    dict

    @@ -895,28 +895,28 @@

    Submodules -
    -algorithm_kisao_id: str[source]#
    +
    +algorithm_kisao_ids: dict[source]#

    -
    -model_change_target_tellurium_id_map: dict[source]#
    +
    +model_change_target_tellurium_id_maps: dict[source]#
    -
    -road_runner: RoadRunner[source]#
    +
    +road_runners: dict[source]#
    -
    -solver: Integrator | SteadyStateSolver[source]#
    +
    +solvers: dict[source]#
    -
    -variable_target_tellurium_observable_map: dict[source]#
    +
    +variable_target_tellurium_observable_maps: dict[source]#

    @@ -964,16 +964,16 @@

    SubmodulesPreprocesssedTask
  • SedmlInterpreter