-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_reference.html
More file actions
164 lines (143 loc) · 8.11 KB
/
api_reference.html
File metadata and controls
164 lines (143 loc) · 8.11 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
<!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>API Reference — EBM - Energibruksmodell 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/css/custom.css?v=9ed7352e" />
<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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="ebm package" href="modules/ebm.html" />
<link rel="prev" title="Calibrating the model" href="user_guide/calibrating_the_model.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="index.html" class="icon icon-home">
EBM - Energibruksmodell
</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="about_the_model.html">About EBM</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">User guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Result files</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/user_case.html">User case</a></li>
<li class="toctree-l1"><a class="reference internal" href="input_description.html">Input files</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/geographical_distribution.html">Geographical distribution</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/configuration.html">Model configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Model Functionality</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="model_description/index.html">Model Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="limitations.html">Limitations</a></li>
<li class="toctree-l1"><a class="reference internal" href="building_parameters/index.html">Building categories and building codes</a></li>
<li class="toctree-l1"><a class="reference internal" href="area/index.html">Area</a></li>
<li class="toctree-l1"><a class="reference internal" href="energy_need/index.html">Energy need</a></li>
<li class="toctree-l1"><a class="reference internal" href="heating_systems/index.html">Heating systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="energy_use/index.html">Energy use</a></li>
<li class="toctree-l1"><a class="reference internal" href="geographical_distribution/index.html">Geographical distribution</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="user_guide/calibrating_the_model.html">Calibrating the model</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/ebm.html">ebm package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</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="index.html">EBM - Energibruksmodell</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">API Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api_reference.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="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading"></a></h1>
<section id="core-apis">
<h2>Core APIs<a class="headerlink" href="#core-apis" title="Link to this heading"></a></h2>
<p>Description of the APIs provided by the Core including the events it emits</p>
<p>The Core Model consists of these core modules:</p>
<p>[Write up an overview of the modules here. Here is an example of how this could be done: ]</p>
<ul class="simple">
<li><p><strong>ebm.cmd</strong>: Handles … <a class="reference internal" href="modules/ebm.cmd.html"><span class="doc">(details)</span></a></p></li>
<li><p><strong>ebm.model</strong>: Handles … <a class="reference internal" href="modules/ebm.model.html"><span class="doc">(details)</span></a></p></li>
<li><p><strong>ebm.services</strong>: Handles … <a class="reference internal" href="modules/ebm.services.html"><span class="doc">(details)</span></a></p></li>
</ul>
</section>
<section id="full-module-documentation">
<h2>Full Module Documentation<a class="headerlink" href="#full-module-documentation" title="Link to this heading"></a></h2>
<p>Here is the full, generated documentation of the code:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules/ebm.html">ebm package</a></li>
</ul>
</div>
<p>…</p>
<p>Last Updated on 2026-03-26.</p>
<p>Version: .</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_guide/calibrating_the_model.html" class="btn btn-neutral float-left" title="Calibrating the model" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="modules/ebm.html" class="btn btn-neutral float-right" title="ebm 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 2025, The Norwegian Water Resources and Energy Directorate (NVE).</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>