-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
196 lines (175 loc) · 13.6 KB
/
index.html
File metadata and controls
196 lines (175 loc) · 13.6 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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to gorder’s Python API documentation! — gorder "1.2.0" documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=784e175d"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="introduction.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
gorder
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="gorder.html">Performing the analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis_types.html">Analysis types</a></li>
<li class="toctree-l1"><a class="reference internal" href="leaflets.html">Order parameters for individual leaflets</a></li>
<li class="toctree-l1"><a class="reference internal" href="ordermap.html">Maps of order parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="estimate_error.html">Estimating error</a></li>
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Order parameters for specific membrane region</a></li>
<li class="toctree-l1"><a class="reference internal" href="membrane_normal.html">Specifying membrane normal</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Accessing the results</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Errors you can encounter</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">gorder</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to gorder’s Python API documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-gorder-s-python-api-documentation">
<h1>Welcome to gorder’s Python API documentation!<a class="headerlink" href="#welcome-to-gorder-s-python-api-documentation" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#using-uv">Using uv</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#using-pip">Using pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#optional-dependencies">Optional dependencies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gorder.html">Performing the analysis</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gorder.html#gorder.Analysis"><code class="docutils literal notranslate"><span class="pre">Analysis</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="analysis_types.html">Analysis types</a><ul>
<li class="toctree-l2"><a class="reference internal" href="analysis_types.html#gorder.analysis_types.AAOrder"><code class="docutils literal notranslate"><span class="pre">AAOrder</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="analysis_types.html#gorder.analysis_types.CGOrder"><code class="docutils literal notranslate"><span class="pre">CGOrder</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="analysis_types.html#gorder.analysis_types.UAOrder"><code class="docutils literal notranslate"><span class="pre">UAOrder</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="leaflets.html">Order parameters for individual leaflets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="leaflets.html#gorder.leaflets.ClusteringClassification"><code class="docutils literal notranslate"><span class="pre">ClusteringClassification</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="leaflets.html#gorder.leaflets.GlobalClassification"><code class="docutils literal notranslate"><span class="pre">GlobalClassification</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="leaflets.html#gorder.leaflets.IndividualClassification"><code class="docutils literal notranslate"><span class="pre">IndividualClassification</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="leaflets.html#gorder.leaflets.LocalClassification"><code class="docutils literal notranslate"><span class="pre">LocalClassification</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="leaflets.html#gorder.leaflets.ManualClassification"><code class="docutils literal notranslate"><span class="pre">ManualClassification</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="leaflets.html#gorder.leaflets.NdxClassification"><code class="docutils literal notranslate"><span class="pre">NdxClassification</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="leaflets.html#gorder.leaflets.SphericalClusteringClassification"><code class="docutils literal notranslate"><span class="pre">SphericalClusteringClassification</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ordermap.html">Maps of order parameters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ordermap.html#gorder.ordermap.OrderMap"><code class="docutils literal notranslate"><span class="pre">OrderMap</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="estimate_error.html">Estimating error</a><ul>
<li class="toctree-l2"><a class="reference internal" href="estimate_error.html#gorder.estimate_error.EstimateError"><code class="docutils literal notranslate"><span class="pre">EstimateError</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Order parameters for specific membrane region</a><ul>
<li class="toctree-l2"><a class="reference internal" href="geometry.html#gorder.geometry.Cuboid"><code class="docutils literal notranslate"><span class="pre">Cuboid</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="geometry.html#gorder.geometry.Cylinder"><code class="docutils literal notranslate"><span class="pre">Cylinder</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="geometry.html#gorder.geometry.Sphere"><code class="docutils literal notranslate"><span class="pre">Sphere</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="membrane_normal.html">Specifying membrane normal</a><ul>
<li class="toctree-l2"><a class="reference internal" href="membrane_normal.html#gorder.membrane_normal.DynamicNormal"><code class="docutils literal notranslate"><span class="pre">DynamicNormal</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Accessing the results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.AnalysisResults"><code class="docutils literal notranslate"><span class="pre">AnalysisResults</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.AtomResults"><code class="docutils literal notranslate"><span class="pre">AtomResults</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.BondResults"><code class="docutils literal notranslate"><span class="pre">BondResults</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.Convergence"><code class="docutils literal notranslate"><span class="pre">Convergence</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.LeafletsData"><code class="docutils literal notranslate"><span class="pre">LeafletsData</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.Map"><code class="docutils literal notranslate"><span class="pre">Map</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.MoleculeResults"><code class="docutils literal notranslate"><span class="pre">MoleculeResults</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.Order"><code class="docutils literal notranslate"><span class="pre">Order</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.OrderCollection"><code class="docutils literal notranslate"><span class="pre">OrderCollection</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html#gorder.results.OrderMapsCollection"><code class="docutils literal notranslate"><span class="pre">OrderMapsCollection</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Errors you can encounter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#gorder.exceptions.APIError"><code class="docutils literal notranslate"><span class="pre">APIError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#gorder.exceptions.AnalysisError"><code class="docutils literal notranslate"><span class="pre">AnalysisError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#gorder.exceptions.ConfigError"><code class="docutils literal notranslate"><span class="pre">ConfigError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#gorder.exceptions.WriteError"><code class="docutils literal notranslate"><span class="pre">WriteError</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="introduction.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2025, Ladislav Bartos.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>