Skip to content

Commit

Permalink
chore: Updating compiled documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
biosimulatorsdaemon committed Oct 14, 2021
1 parent 6713c95 commit 4970f3e
Show file tree
Hide file tree
Showing 12 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.1.66',
VERSION: '0.1.67',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion docs/about.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>About the BioSimulators test suite &#8212; BioSimulators test suite 0.1.66 documentation</title>
<title>About the BioSimulators test suite &#8212; BioSimulators test suite 0.1.67 documentation</title>

<link href="_static/css/theme.css" rel="stylesheet">
<link href="_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
Expand Down
2 changes: 1 addition & 1 deletion docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; BioSimulators test suite 0.1.66 documentation</title>
<title>Index &#8212; BioSimulators test suite 0.1.67 documentation</title>

<link href="_static/css/theme.css" rel="stylesheet">
<link href="_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>BioSimulators test suite documentation &#8212; BioSimulators test suite 0.1.66 documentation</title>
<title>BioSimulators test suite documentation &#8212; BioSimulators test suite 0.1.67 documentation</title>

<link href="_static/css/theme.css" rel="stylesheet">
<link href="_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>Installation instructions &#8212; BioSimulators test suite 0.1.66 documentation</title>
<title>Installation instructions &#8212; BioSimulators test suite 0.1.67 documentation</title>

<link href="_static/css/theme.css" rel="stylesheet">
<link href="_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
Expand Down
2 changes: 1 addition & 1 deletion docs/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &#8212; BioSimulators test suite 0.1.66 documentation</title>
<title>Python Module Index &#8212; BioSimulators test suite 0.1.67 documentation</title>

<link href="_static/css/theme.css" rel="stylesheet">
<link href="_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
Expand Down
2 changes: 1 addition & 1 deletion docs/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; BioSimulators test suite 0.1.66 documentation</title>
<title>Search &#8212; BioSimulators test suite 0.1.67 documentation</title>

<link href="_static/css/theme.css" rel="stylesheet">
<link href="_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/source/biosimulators_test_suite.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>biosimulators_test_suite package &#8212; BioSimulators test suite 0.1.66 documentation</title>
<title>biosimulators_test_suite package &#8212; BioSimulators test suite 0.1.67 documentation</title>

<link href="../_static/css/theme.css" rel="stylesheet">
<link href="../_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
Expand Down Expand Up @@ -870,7 +870,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="biosimulators_test_suite.exec_cli.BaseController.Meta.arguments">
<span class="sig-name descname"><span class="pre">arguments</span></span><em class="property"> <span class="pre">=</span> <span class="pre">[(['specifications'],</span> <span class="pre">{'type':</span> <span class="pre">&lt;class</span> <span class="pre">'str'&gt;,</span> <span class="pre">'help':</span> <span class="pre">'Path</span> <span class="pre">or</span> <span class="pre">URL</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">specifications</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">simulator'}),</span> <span class="pre">(['-c',</span> <span class="pre">'--test-case'],</span> <span class="pre">{'type':</span> <span class="pre">&lt;class</span> <span class="pre">'str'&gt;,</span> <span class="pre">'nargs':</span> <span class="pre">'+',</span> <span class="pre">'default':</span> <span class="pre">None,</span> <span class="pre">'dest':</span> <span class="pre">'case_ids',</span> <span class="pre">'help':</span> <span class="pre">&quot;Ids</span> <span class="pre">of</span> <span class="pre">test</span> <span class="pre">cases</span> <span class="pre">of</span> <span class="pre">evaluate</span> <span class="pre">(e.g.,</span> <span class="pre">'sedml.SimulatorSupportsModelAttributeChanges',</span> <span class="pre">'published_project.SimulatorCanExecutePublishedProject:sbml-core/Caravagna-J-Theor-Biol-2010-tumor-suppressive-oscillations').</span> <span class="pre">Default:</span> <span class="pre">evaluate</span> <span class="pre">all</span> <span class="pre">test</span> <span class="pre">cases&quot;}),</span> <span class="pre">(['--cli'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Command-line</span> <span class="pre">interface</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">to</span> <span class="pre">execute</span> <span class="pre">the</span> <span class="pre">tests</span> <span class="pre">involving</span> <span class="pre">the</span> <span class="pre">simulation</span> <span class="pre">of</span> <span class="pre">COMBINE/OMEX</span> <span class="pre">archives</span> <span class="pre">rather</span> <span class="pre">than</span> <span class="pre">a</span> <span class="pre">Docker</span> <span class="pre">image'}),</span> <span class="pre">(['--synthetic-archives-dir'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Directory</span> <span class="pre">to</span> <span class="pre">save</span> <span class="pre">the</span> <span class="pre">synthetic</span> <span class="pre">COMBINE/OMEX</span> <span class="pre">archives</span> <span class="pre">generated</span> <span class="pre">by</span> <span class="pre">the</span> <span class="pre">test</span> <span class="pre">cases'}),</span> <span class="pre">(['--report'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Path</span> <span class="pre">to</span> <span class="pre">save</span> <span class="pre">a</span> <span class="pre">report</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">results</span> <span class="pre">in</span> <span class="pre">JSON</span> <span class="pre">format'}),</span> <span class="pre">(['--verbose'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">'If</span> <span class="pre">set,</span> <span class="pre">print</span> <span class="pre">the</span> <span class="pre">stdout</span> <span class="pre">and</span> <span class="pre">stderr</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">execution</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">tests</span> <span class="pre">in</span> <span class="pre">real</span> <span class="pre">time.'}),</span> <span class="pre">(['--work-dir'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Working</span> <span class="pre">directory</span> <span class="pre">for</span> <span class="pre">files</span> <span class="pre">for</span> <span class="pre">evaluating</span> <span class="pre">tests.</span> <span class="pre">This</span> <span class="pre">option</span> <span class="pre">enables</span> <span class="pre">intermediate</span> <span class="pre">files</span> <span class="pre">to</span> <span class="pre">be</span> <span class="pre">inspected</span> <span class="pre">rather</span> <span class="pre">than</span> <span class="pre">automatically</span> <span class="pre">cleaned</span> <span class="pre">up.'}),</span> <span class="pre">(['--do-not-validate-specs'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">&quot;If</span> <span class="pre">set,</span> <span class="pre">don't</span> <span class="pre">validate</span> <span class="pre">the</span> <span class="pre">specifications</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">simulator.&quot;}),</span> <span class="pre">(['--do-not-log-std-out-err'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">&quot;If</span> <span class="pre">set,</span> <span class="pre">don't</span> <span class="pre">use</span> <span class="pre">capturer</span> <span class="pre">to</span> <span class="pre">collect</span> <span class="pre">stdout</span> <span class="pre">and</span> <span class="pre">stderr.&quot;}),</span> <span class="pre">(['--dry-run'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">'If</span> <span class="pre">set,</span> <span class="pre">create</span> <span class="pre">synthetic</span> <span class="pre">archives,</span> <span class="pre">but</span> <span class="pre">do</span> <span class="pre">not</span> <span class="pre">use</span> <span class="pre">the</span> <span class="pre">simulator</span> <span class="pre">to</span> <span class="pre">execute</span> <span class="pre">them.'}),</span> <span class="pre">(['-v',</span> <span class="pre">'--version'],</span> <span class="pre">{'action':</span> <span class="pre">'version',</span> <span class="pre">'version':</span> <span class="pre">'0.1.66'})]</span></em><a class="reference external" href="https://github.com/biosimulators/Biosimulators_test_suite/blob/dev/biosimulators_test_suite/exec_cli.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#biosimulators_test_suite.exec_cli.BaseController.Meta.arguments" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">arguments</span></span><em class="property"> <span class="pre">=</span> <span class="pre">[(['specifications'],</span> <span class="pre">{'type':</span> <span class="pre">&lt;class</span> <span class="pre">'str'&gt;,</span> <span class="pre">'help':</span> <span class="pre">'Path</span> <span class="pre">or</span> <span class="pre">URL</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">specifications</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">simulator'}),</span> <span class="pre">(['-c',</span> <span class="pre">'--test-case'],</span> <span class="pre">{'type':</span> <span class="pre">&lt;class</span> <span class="pre">'str'&gt;,</span> <span class="pre">'nargs':</span> <span class="pre">'+',</span> <span class="pre">'default':</span> <span class="pre">None,</span> <span class="pre">'dest':</span> <span class="pre">'case_ids',</span> <span class="pre">'help':</span> <span class="pre">&quot;Ids</span> <span class="pre">of</span> <span class="pre">test</span> <span class="pre">cases</span> <span class="pre">of</span> <span class="pre">evaluate</span> <span class="pre">(e.g.,</span> <span class="pre">'sedml.SimulatorSupportsModelAttributeChanges',</span> <span class="pre">'published_project.SimulatorCanExecutePublishedProject:sbml-core/Caravagna-J-Theor-Biol-2010-tumor-suppressive-oscillations').</span> <span class="pre">Default:</span> <span class="pre">evaluate</span> <span class="pre">all</span> <span class="pre">test</span> <span class="pre">cases&quot;}),</span> <span class="pre">(['--cli'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Command-line</span> <span class="pre">interface</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">to</span> <span class="pre">execute</span> <span class="pre">the</span> <span class="pre">tests</span> <span class="pre">involving</span> <span class="pre">the</span> <span class="pre">simulation</span> <span class="pre">of</span> <span class="pre">COMBINE/OMEX</span> <span class="pre">archives</span> <span class="pre">rather</span> <span class="pre">than</span> <span class="pre">a</span> <span class="pre">Docker</span> <span class="pre">image'}),</span> <span class="pre">(['--synthetic-archives-dir'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Directory</span> <span class="pre">to</span> <span class="pre">save</span> <span class="pre">the</span> <span class="pre">synthetic</span> <span class="pre">COMBINE/OMEX</span> <span class="pre">archives</span> <span class="pre">generated</span> <span class="pre">by</span> <span class="pre">the</span> <span class="pre">test</span> <span class="pre">cases'}),</span> <span class="pre">(['--report'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Path</span> <span class="pre">to</span> <span class="pre">save</span> <span class="pre">a</span> <span class="pre">report</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">results</span> <span class="pre">in</span> <span class="pre">JSON</span> <span class="pre">format'}),</span> <span class="pre">(['--verbose'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">'If</span> <span class="pre">set,</span> <span class="pre">print</span> <span class="pre">the</span> <span class="pre">stdout</span> <span class="pre">and</span> <span class="pre">stderr</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">execution</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">tests</span> <span class="pre">in</span> <span class="pre">real</span> <span class="pre">time.'}),</span> <span class="pre">(['--work-dir'],</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'help':</span> <span class="pre">'Working</span> <span class="pre">directory</span> <span class="pre">for</span> <span class="pre">files</span> <span class="pre">for</span> <span class="pre">evaluating</span> <span class="pre">tests.</span> <span class="pre">This</span> <span class="pre">option</span> <span class="pre">enables</span> <span class="pre">intermediate</span> <span class="pre">files</span> <span class="pre">to</span> <span class="pre">be</span> <span class="pre">inspected</span> <span class="pre">rather</span> <span class="pre">than</span> <span class="pre">automatically</span> <span class="pre">cleaned</span> <span class="pre">up.'}),</span> <span class="pre">(['--do-not-validate-specs'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">&quot;If</span> <span class="pre">set,</span> <span class="pre">don't</span> <span class="pre">validate</span> <span class="pre">the</span> <span class="pre">specifications</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">simulator.&quot;}),</span> <span class="pre">(['--do-not-log-std-out-err'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">&quot;If</span> <span class="pre">set,</span> <span class="pre">don't</span> <span class="pre">use</span> <span class="pre">capturer</span> <span class="pre">to</span> <span class="pre">collect</span> <span class="pre">stdout</span> <span class="pre">and</span> <span class="pre">stderr.&quot;}),</span> <span class="pre">(['--dry-run'],</span> <span class="pre">{'action':</span> <span class="pre">'store_true',</span> <span class="pre">'help':</span> <span class="pre">'If</span> <span class="pre">set,</span> <span class="pre">create</span> <span class="pre">synthetic</span> <span class="pre">archives,</span> <span class="pre">but</span> <span class="pre">do</span> <span class="pre">not</span> <span class="pre">use</span> <span class="pre">the</span> <span class="pre">simulator</span> <span class="pre">to</span> <span class="pre">execute</span> <span class="pre">them.'}),</span> <span class="pre">(['-v',</span> <span class="pre">'--version'],</span> <span class="pre">{'action':</span> <span class="pre">'version',</span> <span class="pre">'version':</span> <span class="pre">'0.1.67'})]</span></em><a class="reference external" href="https://github.com/biosimulators/Biosimulators_test_suite/blob/dev/biosimulators_test_suite/exec_cli.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#biosimulators_test_suite.exec_cli.BaseController.Meta.arguments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
Expand Down
Loading

0 comments on commit 4970f3e

Please sign in to comment.