-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathapi.html
166 lines (144 loc) · 7.84 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
<!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>pyopmspe11 Python API — pyopmspe11 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" />
<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=5929fcd5"></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="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="pyopmspe11 package" href="pyopmspe11.html" />
<link rel="prev" title="Benchmark" href="benchmark.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" style="background: #aaaaaa" >
<a href="index.html">
<img src="_static/logo.png" class="logo" alt="Logo"/>
</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 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="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration_file.html">Configuration file</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">pyopmspe11 Python API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pyopmspe11">pyopmspe11</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyopmspe11.html">pyopmspe11 package</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="output_folder.html">Output folder</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="related.html">Related</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About pyopmspe11</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" style="background: #aaaaaa" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyopmspe11</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">pyopmspe11 Python API</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.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="pyopmspe11-python-api">
<h1>pyopmspe11 Python API<a class="headerlink" href="#pyopmspe11-python-api" title="Link to this heading"></a></h1>
<p>The main script for the <strong>pyopmspe11</strong> executable is located in the core folder.
The reference_mesh folder contains <a class="reference external" href="https://gmsh.info">Gmsh</a> files to obtain the
coordinates used for the location of the different facies and generation of the corner-point grid.
The scripts in the utils folder process the input configuration
file, creates the geological model, and write the input files by using the files in the templates folder.
The visualization folder contains files for the postprocessing of the results.</p>
<figure class="align-default" id="id1">
<img alt="_images/contents.png" src="_images/contents.png" />
<figcaption>
<p><span class="caption-text">Files in the pyopmspe11 package.</span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
</figcaption>
</figure>
<section id="pyopmspe11">
<h2>pyopmspe11<a class="headerlink" href="#pyopmspe11" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pyopmspe11.html">pyopmspe11 package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyopmspe11.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyopmspe11.core.html">pyopmspe11.core package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyopmspe11.core.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="pyopmspe11.core.html#module-pyopmspe11.core">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyopmspe11.utils.html">pyopmspe11.utils package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyopmspe11.utils.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="pyopmspe11.utils.html#module-pyopmspe11.utils">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyopmspe11.visualization.html">pyopmspe11.visualization package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyopmspe11.visualization.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="pyopmspe11.visualization.html#module-pyopmspe11.visualization">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyopmspe11.html#module-pyopmspe11">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="benchmark.html" class="btn btn-neutral float-left" title="Benchmark" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pyopmspe11.html" class="btn btn-neutral float-right" title="pyopmspe11 package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023-2025, NORCE Norwegian Research Centre AS.</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>