-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathspatialpy.stochss.html
More file actions
175 lines (132 loc) · 7.4 KB
/
spatialpy.stochss.html
File metadata and controls
175 lines (132 loc) · 7.4 KB
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>spatialpy.stochss package — SpatialPy 1.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/spatialpy_alabaster_customizations.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="spatialpy.solvers package" href="spatialpy.solvers.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<link rel="apple-touch-icon" href="../_static/img/SpatialPy_logo.svg" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="../index.html">
<img class="logo" src="../_static/img/SpatialPy_logo.png" alt="Logo"/>
</a>
</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=StochSS&repo=SpatialPy&type=watch&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">API reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="spatialpy.html">spatialpy package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="spatialpy.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="spatialpy.core.html">spatialpy.core package</a></li>
<li class="toctree-l3"><a class="reference internal" href="spatialpy.solvers.html">spatialpy.solvers package</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">spatialpy.stochss package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="spatialpy.html#module-spatialpy">Module contents</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="spatialpy.html">spatialpy package</a><ul>
<li>Previous: <a href="spatialpy.solvers.html" title="previous chapter">spatialpy.solvers package</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="spatialpy-stochss-package">
<h1>spatialpy.stochss package<a class="headerlink" href="#spatialpy-stochss-package" title="Permalink to this heading">¶</a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading">¶</a></h2>
</section>
<section id="module-spatialpy.stochss.stochss_export">
<span id="spatialpy-stochss-stochss-export-module"></span><h2>spatialpy.stochss.stochss_export module<a class="headerlink" href="#module-spatialpy.stochss.stochss_export" title="Permalink to this heading">¶</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="spatialpy.stochss.stochss_export.export">
<span class="sig-prename descclassname"><span class="pre">spatialpy.stochss.stochss_export.</span></span><span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_stochss_model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/spatialpy/stochss/stochss_export.html#export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#spatialpy.stochss.stochss_export.export" title="Permalink to this definition">¶</a></dt>
<dd><p>SpatialPy model to StochSS converter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>model</strong> (<a class="reference internal" href="spatialpy.core.html#spatialpy.core.model.Model" title="spatialpy.core.model.Model"><em>spatialpy.core.model.Model</em></a>) – SpatialPy model to be converted to StochSS.</p></li>
<li><p><strong>filename</strong> (<em>str</em>) – Path to the exported stochss model.</p></li>
<li><p><strong>return_stochss_model</strong> (<em>bool</em>) – Whether or not to return the model.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>StochSS model dict if return_stochss_model is True else path to StochSS model file.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict | str</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-spatialpy.stochss">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-spatialpy.stochss" title="Permalink to this heading">¶</a></h2>
</section>
</section>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="spatialpy.solvers.html" title="Previous document">spatialpy.solvers package</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©Copyright (C) 2019-2023.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="../_sources/classes/spatialpy.stochss.rst.txt"
rel="nofollow">Page source</a>
</div>
<a href="https://github.com/StochSS/SpatialPy" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>
</body>
</html>