-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbiosimulators_pyneuroml.cli.html
354 lines (274 loc) · 16.9 KB
/
biosimulators_pyneuroml.cli.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
<!DOCTYPE html>
<html lang="en">
<head>
<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_pyneuroml.cli package — BioSimulators-pyNeuroML 0.0.16 documentation</title>
<link href="../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link href="../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link rel="stylesheet"
href="../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/styles/pydata-sphinx-theme.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/biosimulators.css" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf">
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="About BioSimulators-pyNeuroML" href="../about.html" />
<link rel="prev" title="biosimulators_pyneuroml.api package" href="biosimulators_pyneuroml.api.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<link rel="icon" sizes="16x16" href="https://github.com/biosimulations/biosimulations/raw/dev/libs/shared/assets/src/assets/icons/favicon-16x16.png">
<link rel="icon" sizes="32x32" href="https://github.com/biosimulations/biosimulations/raw/dev/libs/shared/assets/src/assets/icons/favicon-32x32.png">
<!-- Google Analytics -->
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl">
<div id="navbar-start">
<a class="navbar-brand" href="../index.html">
<img src="../_static/biosimulators-logo.svg" class="logo" alt="logo">
</a>
</div>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
<div id="navbar-center" class="mr-auto">
</div>
<div id="navbar-end">
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Quick links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/biosimulators/Biosimulators_pyNeuroML" rel="noopener" target="_blank" title="GitHub"><span><i class="fab fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://twitter.com/biosimulators" rel="noopener" target="_blank" title="Twitter"><span><i class="fab fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
<li class="nav-item">
<a class="nav-link" href="mailto:info@biosimulators.org" rel="noopener" target="_blank" title="Email"><span><i class="fas fa-envelope"></i></span>
<label class="sr-only">Email</label></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="col-12 col-md-3 bd-sidebar">
<div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Enter text to search for ..." aria-label="Enter text to search for ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<ul class="current nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="biosimulators_pyneuroml.api.html">
biosimulators_pyneuroml.api package
</a>
</li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
biosimulators_pyneuroml.cli package
</a>
</li>
</ul>
</div>
</nav>
</div>
<div class="sidebar-end-items">
</div>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<div class="toc-item">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i> On this page
</div>
<nav id="bd-toc-nav">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#submodules">
Submodules
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#module-biosimulators_pyneuroml.cli.brian2">
biosimulators_pyneuroml.cli.brian2 module
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#module-biosimulators_pyneuroml.cli.netpyne">
biosimulators_pyneuroml.cli.netpyne module
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#module-biosimulators_pyneuroml.cli.neuron">
biosimulators_pyneuroml.cli.neuron module
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#module-biosimulators_pyneuroml.cli.pyneuroml">
biosimulators_pyneuroml.cli.pyneuroml module
</a>
</li>
</ul>
</nav>
</div>
<div class="toc-item">
<div class="tocsection editthispage">
<a href="https://github.com/biosimulators/Biosimulators_pyNeuroML/edit/dev/docs-src/source/biosimulators_pyneuroml.cli.rst">
<i class="fas fa-pencil-alt"></i> Edit this page
</a>
</div>
</div>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<section id="module-biosimulators_pyneuroml.cli">
<span id="biosimulators-pyneuroml-cli-package"></span><h1>biosimulators_pyneuroml.cli package<a class="headerlink" href="#module-biosimulators_pyneuroml.cli" title="Permalink to this headline">¶</a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</section>
<section id="module-biosimulators_pyneuroml.cli.brian2">
<span id="biosimulators-pyneuroml-cli-brian2-module"></span><h2>biosimulators_pyneuroml.cli.brian2 module<a class="headerlink" href="#module-biosimulators_pyneuroml.cli.brian2" title="Permalink to this headline">¶</a></h2>
<p>BioSimulators-compliant command-line interface to the <a class="reference external" href="https://briansimulator.org">Brian 2</a> simulation program.</p>
<dl class="field-list simple">
<dt class="field-odd">Author</dt>
<dd class="field-odd"><p>Jonathan Karr <<a class="reference external" href="mailto:karr%40mssm.edu">karr<span>@</span>mssm<span>.</span>edu</a>></p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>2021-05-28</p>
</dd>
<dt class="field-odd">Copyright</dt>
<dd class="field-odd"><p>2021, BioSimulators Team</p>
</dd>
<dt class="field-even">License</dt>
<dd class="field-even"><p>MIT</p>
</dd>
</dl>
<dl class="py function">
<dt class="sig sig-object py" id="biosimulators_pyneuroml.cli.brian2.main">
<span class="sig-prename descclassname"><span class="pre">biosimulators_pyneuroml.cli.brian2.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/biosimulators/Biosimulators_pyNeuroML/blob/dev/biosimulators_pyneuroml/cli/brian2.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#biosimulators_pyneuroml.cli.brian2.main" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the command-line interface to Brian 2</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>argv</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>, optional) – command-line arguments</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-biosimulators_pyneuroml.cli.netpyne">
<span id="biosimulators-pyneuroml-cli-netpyne-module"></span><h2>biosimulators_pyneuroml.cli.netpyne module<a class="headerlink" href="#module-biosimulators_pyneuroml.cli.netpyne" title="Permalink to this headline">¶</a></h2>
<p>BioSimulators-compliant command-line interface to the <a class="reference external" href="http://netpyne.org">NetPyNe</a> simulation program.</p>
<dl class="field-list simple">
<dt class="field-odd">Author</dt>
<dd class="field-odd"><p>Jonathan Karr <<a class="reference external" href="mailto:karr%40mssm.edu">karr<span>@</span>mssm<span>.</span>edu</a>></p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>2021-05-28</p>
</dd>
<dt class="field-odd">Copyright</dt>
<dd class="field-odd"><p>2021, BioSimulators Team</p>
</dd>
<dt class="field-even">License</dt>
<dd class="field-even"><p>MIT</p>
</dd>
</dl>
<dl class="py function">
<dt class="sig sig-object py" id="biosimulators_pyneuroml.cli.netpyne.main">
<span class="sig-prename descclassname"><span class="pre">biosimulators_pyneuroml.cli.netpyne.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/biosimulators/Biosimulators_pyNeuroML/blob/dev/biosimulators_pyneuroml/cli/netpyne.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#biosimulators_pyneuroml.cli.netpyne.main" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the command-line interface to NetPyNe</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>argv</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>, optional) – command-line arguments</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-biosimulators_pyneuroml.cli.neuron">
<span id="biosimulators-pyneuroml-cli-neuron-module"></span><h2>biosimulators_pyneuroml.cli.neuron module<a class="headerlink" href="#module-biosimulators_pyneuroml.cli.neuron" title="Permalink to this headline">¶</a></h2>
<p>BioSimulators-compliant command-line interface to the <a class="reference external" href="https://neuron.yale.edu">NEURON</a> simulation program.</p>
<dl class="field-list simple">
<dt class="field-odd">Author</dt>
<dd class="field-odd"><p>Jonathan Karr <<a class="reference external" href="mailto:karr%40mssm.edu">karr<span>@</span>mssm<span>.</span>edu</a>></p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>2021-05-28</p>
</dd>
<dt class="field-odd">Copyright</dt>
<dd class="field-odd"><p>2021, BioSimulators Team</p>
</dd>
<dt class="field-even">License</dt>
<dd class="field-even"><p>MIT</p>
</dd>
</dl>
<dl class="py function">
<dt class="sig sig-object py" id="biosimulators_pyneuroml.cli.neuron.main">
<span class="sig-prename descclassname"><span class="pre">biosimulators_pyneuroml.cli.neuron.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/biosimulators/Biosimulators_pyNeuroML/blob/dev/biosimulators_pyneuroml/cli/neuron.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#biosimulators_pyneuroml.cli.neuron.main" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the command-line interface to NEURON</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>argv</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>, optional) – command-line arguments</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-biosimulators_pyneuroml.cli.pyneuroml">
<span id="biosimulators-pyneuroml-cli-pyneuroml-module"></span><h2>biosimulators_pyneuroml.cli.pyneuroml module<a class="headerlink" href="#module-biosimulators_pyneuroml.cli.pyneuroml" title="Permalink to this headline">¶</a></h2>
<p>BioSimulators-compliant command-line interface to the <a class="reference external" href="https://github.com/NeuroML/pyNeuroML">pyNeuroML</a> simulation program.</p>
<dl class="field-list simple">
<dt class="field-odd">Author</dt>
<dd class="field-odd"><p>Jonathan Karr <<a class="reference external" href="mailto:karr%40mssm.edu">karr<span>@</span>mssm<span>.</span>edu</a>></p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>2021-05-28</p>
</dd>
<dt class="field-odd">Copyright</dt>
<dd class="field-odd"><p>2021, BioSimulators Team</p>
</dd>
<dt class="field-even">License</dt>
<dd class="field-even"><p>MIT</p>
</dd>
</dl>
<dl class="py function">
<dt class="sig sig-object py" id="biosimulators_pyneuroml.cli.pyneuroml.main">
<span class="sig-prename descclassname"><span class="pre">biosimulators_pyneuroml.cli.pyneuroml.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/biosimulators/Biosimulators_pyNeuroML/blob/dev/biosimulators_pyneuroml/cli/pyneuroml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#biosimulators_pyneuroml.cli.pyneuroml.main" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the command-line interface to pyNeuroML</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>argv</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>, optional) – command-line arguments</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</main>
</div>
</div>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<div class="footer-item">
<p class="copyright">
© Copyright 2022, BioSimulators Team.<br>
</p>
</div>
</div>
</footer>
</body>
</html>