forked from pathpy/pathpy.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.html
340 lines (314 loc) · 20.8 KB
/
api.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API reference — pathpy 3.0.22 documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/style.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pathpy.Node" href="generated/pathpy.Node.html" />
<link rel="prev" title="Epidemic Spreading in Temporal Networks" href="tutorial/temporal_spreading.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html"><span><img src="_static/pathpy_logo.png"></span>
</a>
<span class="navbar-text navbar-version pull-left"><b>3.0.22</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="examples/index.html">Gallery</a></li>
<li><a href="tutorial.html">Tutorial</a></li>
<li><a href="#">API</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="release.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/index.html">Example gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution.html">Contributing</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">API reference</a><ul>
<li><a class="reference internal" href="#base-classes">Base classes</a></li>
<li><a class="reference internal" href="#object-based-interoperability">Object-based interoperability</a></li>
<li><a class="reference internal" href="#visualisations">Visualisations</a></li>
<li><a class="reference internal" href="#reading-and-writing-network-data">Reading and writing network data</a></li>
<li><a class="reference internal" href="#generating-graphs">Generating graphs</a></li>
<li><a class="reference internal" href="#statistical-analysis">Statistical analysis</a></li>
<li><a class="reference internal" href="#algorithms-for-networks-and-paths">Algorithms for networks and paths</a></li>
<li><a class="reference internal" href="#simulating-dynamical-processes">Simulating dynamical processes</a></li>
</ul>
</li>
</ul>
</ul>
</li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="api-reference">
<span id="api-ref"></span><h1>API reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
<div class="section" id="base-classes">
<span id="classes-api"></span><h2>Base classes<a class="headerlink" href="#base-classes" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.Node.html#pathpy.Node" title="pathpy.Node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Node</span></code></a></p></td>
<td><p>Base class for a single node.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.Edge.html#pathpy.Edge" title="pathpy.Edge"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Edge</span></code></a></p></td>
<td><p>Base class for an single edge.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.Path.html#pathpy.Path" title="pathpy.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a></p></td>
<td><p>Base class for a path.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.Network.html#pathpy.Network" title="pathpy.Network"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network</span></code></a></p></td>
<td><p>Class for a network.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="object-based-interoperability">
<span id="converters-api"></span><h2>Object-based interoperability<a class="headerlink" href="#object-based-interoperability" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.converters.to_networkx.html#pathpy.converters.to_networkx" title="pathpy.converters.to_networkx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">converters.to_networkx</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.converters.from_networkx.html#pathpy.converters.from_networkx" title="pathpy.converters.from_networkx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">converters.from_networkx</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="visualisations">
<span id="plotting-api"></span><h2>Visualisations<a class="headerlink" href="#visualisations" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.visualisations.plot.html#pathpy.visualisations.plot" title="pathpy.visualisations.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">visualisations.plot</span></code></a></p></td>
<td><p>Plot the object</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.visualisations.layout.Layout.html#pathpy.visualisations.layout.layout" title="pathpy.visualisations.layout.layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">visualisations.layout.layout</span></code></a></p></td>
<td><p>Function to generate a layout for the network.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">visualisations.layout.Layout</span></code></p></td>
<td><p>Default class to create layouts</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="reading-and-writing-network-data">
<span id="io-api"></span><h2>Reading and writing network data<a class="headerlink" href="#reading-and-writing-network-data" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.io.pandas.html#module-pathpy.io.pandas" title="pathpy.io.pandas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io.pandas</span></code></a></p></td>
<td><p>Functions to read and write network and path data to/from pandas data frames</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.io.csv.html#module-pathpy.io.csv" title="pathpy.io.csv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io.csv</span></code></a></p></td>
<td><p>Functions to read and write csv tables.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.io.sql.html#module-pathpy.io.sql" title="pathpy.io.sql"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io.sql</span></code></a></p></td>
<td><p>Functions to read and write sql database tables.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.io.graphtool.html#module-pathpy.io.graphtool" title="pathpy.io.graphtool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io.graphtool</span></code></a></p></td>
<td><p>Functions to read networks from graphtool binary format and to retrieve network data from the netzschleuder repository</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.io.graphml.html#module-pathpy.io.graphml" title="pathpy.io.graphml"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io.graphml</span></code></a></p></td>
<td><p>Functions to read and write graphml files.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.io.konect.html#module-pathpy.io.konect" title="pathpy.io.konect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io.konect</span></code></a></p></td>
<td><p>Functions to read files from the Koblenz Network Collection (konect.cc).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.io.infomap.html#module-pathpy.io.infomap" title="pathpy.io.infomap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io.infomap</span></code></a></p></td>
<td><p>Functions to export paths and higher-order models to state files used by InfoMap</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="generating-graphs">
<span id="generators-api"></span><h2>Generating graphs<a class="headerlink" href="#generating-graphs" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.generators.lattice.html#module-pathpy.generators.lattice" title="pathpy.generators.lattice"><code class="xref py py-obj docutils literal notranslate"><span class="pre">generators.lattice</span></code></a></p></td>
<td><p>Methods to generate regular lattice networks with different dimensions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.generators.random_graphs.html#module-pathpy.generators.random_graphs" title="pathpy.generators.random_graphs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">generators.random_graphs</span></code></a></p></td>
<td><p>Methhods to generate random graphs according to different models</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="statistical-analysis">
<span id="statistics-api"></span><h2>Statistical analysis<a class="headerlink" href="#statistical-analysis" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.statistics.clustering.html#module-pathpy.statistics.clustering" title="pathpy.statistics.clustering"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statistics.clustering</span></code></a></p></td>
<td><p>Methods to analyze clustering patterns in networks</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.statistics.degrees.html#module-pathpy.statistics.degrees" title="pathpy.statistics.degrees"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statistics.degrees</span></code></a></p></td>
<td><p>Methods to calculate degree statistics and assortativity in static networks.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.statistics.likelihoods.html#module-pathpy.statistics.likelihoods" title="pathpy.statistics.likelihoods"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statistics.likelihoods</span></code></a></p></td>
<td><p>Methods to calculate model likelihoods based on observed paths.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.statistics.modularity.html#module-pathpy.statistics.modularity" title="pathpy.statistics.modularity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statistics.modularity</span></code></a></p></td>
<td><p>Methods to assess the modular structure of networks</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.statistics.subpaths.html#module-pathpy.statistics.subpaths" title="pathpy.statistics.subpaths"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statistics.subpaths</span></code></a></p></td>
<td><p>Methods to calculate sub-path statistics in Paths and PathCollections</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="algorithms-for-networks-and-paths">
<span id="algorithms-api"></span><h2>Algorithms for networks and paths<a class="headerlink" href="#algorithms-for-networks-and-paths" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.algorithms.centralities.html#module-pathpy.algorithms.centralities" title="pathpy.algorithms.centralities"><code class="xref py py-obj docutils literal notranslate"><span class="pre">algorithms.centralities</span></code></a></p></td>
<td><p>Algorithms for centrality calculations.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.algorithms.community_detection.html#module-pathpy.algorithms.community_detection" title="pathpy.algorithms.community_detection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">algorithms.community_detection</span></code></a></p></td>
<td><p>Algorithms to find community structures in networks.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.algorithms.components.html#module-pathpy.algorithms.components" title="pathpy.algorithms.components"><code class="xref py py-obj docutils literal notranslate"><span class="pre">algorithms.components</span></code></a></p></td>
<td><p>Algorithms for component calculations.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.algorithms.shortest_paths.html#module-pathpy.algorithms.shortest_paths" title="pathpy.algorithms.shortest_paths"><code class="xref py py-obj docutils literal notranslate"><span class="pre">algorithms.shortest_paths</span></code></a></p></td>
<td><p>Algorithms for shortest paths calculations.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.algorithms.path_extraction.html#module-pathpy.algorithms.path_extraction" title="pathpy.algorithms.path_extraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">algorithms.path_extraction</span></code></a></p></td>
<td><p>Algorithms to compute paths in temporal networks.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.algorithms.trees.html#module-pathpy.algorithms.trees" title="pathpy.algorithms.trees"><code class="xref py py-obj docutils literal notranslate"><span class="pre">algorithms.trees</span></code></a></p></td>
<td><p>Pathpy tree algorithms.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.algorithms.evaluation.html#module-pathpy.algorithms.evaluation" title="pathpy.algorithms.evaluation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">algorithms.evaluation</span></code></a></p></td>
<td><p>Algorithms for model evaluation.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="simulating-dynamical-processes">
<span id="processes-api"></span><h2>Simulating dynamical processes<a class="headerlink" href="#simulating-dynamical-processes" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.processes.process.BaseProcess.html#pathpy.processes.process.BaseProcess" title="pathpy.processes.process.BaseProcess"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processes.process.BaseProcess</span></code></a></p></td>
<td><p>Abstract base class for all implementations of discrete-time dynamical processes.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.processes.random_walk.html#module-pathpy.processes.random_walk" title="pathpy.processes.random_walk"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processes.random_walk</span></code></a></p></td>
<td><p>Classes to simlate random walks on static, temporal, and higher-order networks.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pathpy.processes.epidemic_spreading.html#module-pathpy.processes.epidemic_spreading" title="pathpy.processes.epidemic_spreading"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processes.epidemic_spreading</span></code></a></p></td>
<td><p>Classes to simulate epidemic spreading on networks</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pathpy.processes.sampling.html#module-pathpy.processes.sampling" title="pathpy.processes.sampling"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processes.sampling</span></code></a></p></td>
<td><p>Classes for efficient random sampling from discrete distributions</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
<br/>
</p>
<p>
© Copyright 2016-2021, Pathpy Developers.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.<br/>
</p>
</div>
</footer>
</body>
</html>