-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfaq.html
205 lines (190 loc) · 13.7 KB
/
faq.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>FAQ — MDAL documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/mdal.css" type="text/css" />
<link rel="canonical" href="https://mdal.xyzfaq.html"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" 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/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="Software using MDAL" href="software_using_mdal.html" />
<link rel="prev" title="Sphinx RST Style guide" href="contributing/rst_style.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: white" >
<a href="index.html">
<img src="_static/LogoHorizontal_01_color_400x123.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" />
<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="download.html">Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="programs/index.html">Programs</a></li>
<li class="toctree-l1"><a class="reference internal" href="drivers/index.html">MDAL drivers</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/index.html">User</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/index.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="community.html">Community</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">How to contribute?</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-does-mdal-stand-for">What does MDAL stand for?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#when-would-i-use-it">When would I use it?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#when-was-the-mdal-project-started">When was the MDAL project started?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#is-mdal-proprietary-software">Is MDAL proprietary software?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#what-license-does-mdal-use">What license does MDAL use?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#what-operating-systems-does-mdal-run-on">What operating systems does MDAL run on?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#is-there-a-graphical-user-interface-to-mdal">Is there a graphical user interface to MDAL?</a><ul>
<li class="toctree-l3"><a class="reference internal" href="software_using_mdal.html">Software using MDAL</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#what-compiler-can-i-use-to-build-mdal">What compiler can I use to build MDAL?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#i-have-a-question-that-s-not-answered-here-where-can-i-get-more-information">I have a question that’s not answered here. Where can I get more information?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-do-i-add-support-for-a-new-format">How do I add support for a new format?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-do-i-cite-mdal">How do I cite MDAL ?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</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: white" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">MDAL</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"></a> »</li>
<li>FAQ</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/lutraconsulting/mdal/edit//master/docs/source/faq.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
<a href="contributing/rst_style.html" class="btn btn-neutral float-left" title="Sphinx RST Style guide" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="software_using_mdal.html" class="btn btn-neutral float-right" title="Software using MDAL" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="faq">
<span id="id1"></span><h1>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline"></a></h1>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#faq" id="id2">FAQ</a></p>
<ul>
<li><p><a class="reference internal" href="#what-does-mdal-stand-for" id="id3">What does MDAL stand for?</a></p></li>
<li><p><a class="reference internal" href="#when-would-i-use-it" id="id4">When would I use it?</a></p></li>
<li><p><a class="reference internal" href="#when-was-the-mdal-project-started" id="id5">When was the MDAL project started?</a></p></li>
<li><p><a class="reference internal" href="#is-mdal-proprietary-software" id="id6">Is MDAL proprietary software?</a></p></li>
<li><p><a class="reference internal" href="#what-license-does-mdal-use" id="id7">What license does MDAL use?</a></p></li>
<li><p><a class="reference internal" href="#what-operating-systems-does-mdal-run-on" id="id8">What operating systems does MDAL run on?</a></p></li>
<li><p><a class="reference internal" href="#is-there-a-graphical-user-interface-to-mdal" id="id9">Is there a graphical user interface to MDAL?</a></p></li>
<li><p><a class="reference internal" href="#what-compiler-can-i-use-to-build-mdal" id="id10">What compiler can I use to build MDAL?</a></p></li>
<li><p><a class="reference internal" href="#i-have-a-question-that-s-not-answered-here-where-can-i-get-more-information" id="id11">I have a question that’s not answered here. Where can I get more information?</a></p></li>
<li><p><a class="reference internal" href="#how-do-i-add-support-for-a-new-format" id="id12">How do I add support for a new format?</a></p></li>
<li><p><a class="reference internal" href="#how-do-i-cite-mdal" id="id13">How do I cite MDAL ?</a></p></li>
</ul>
</li>
</ul>
</div>
<section id="what-does-mdal-stand-for">
<h2>What does MDAL stand for?<a class="headerlink" href="#what-does-mdal-stand-for" title="Permalink to this headline"></a></h2>
<p>MDAL - Mesh Data Abstraction Library</p>
</section>
<section id="when-would-i-use-it">
<h2>When would I use it?<a class="headerlink" href="#when-would-i-use-it" title="Permalink to this headline"></a></h2>
<p>Most often this kind of representation is used when preparing data for simulation software or when viewing results of physical simulations, typically for meteorology, oceanography, hydrological or hydraulic models. All computation in such software is done on meshes, with values (physical quantities) usually stored in vertices (less commonly in edges or faces). Results usually comprise of various quantities (e.g. wind speed, water depth) which may be also time-varying (e.g. calculated water flow estimates in 5 minute intervals).</p>
<p>Some of the modelling software packages are free and open source (e.g. AnuGA, EPANET), there are some freeware packages (e.g. Basement, HEC-RAS) as well as many commercial pieces of software.</p>
</section>
<section id="when-was-the-mdal-project-started">
<h2>When was the MDAL project started?<a class="headerlink" href="#when-was-the-mdal-project-started" title="Permalink to this headline"></a></h2>
<p>In 2012, Peter Wells and Saber Razmjooei started QGIS Crayfish plugin.</p>
<p>In 2018, Lutra Consulting Ltd. ported and rewritten some parts of Crayfish plugin for separate C++ library that
was used in the early QGIS 3.x released as base for QGIS’s Mesh Layer.</p>
</section>
<section id="is-mdal-proprietary-software">
<h2>Is MDAL proprietary software?<a class="headerlink" href="#is-mdal-proprietary-software" title="Permalink to this headline"></a></h2>
<p>No, MDAL is a Free and Open Source Software.</p>
</section>
<section id="what-license-does-mdal-use">
<h2>What license does MDAL use?<a class="headerlink" href="#what-license-does-mdal-use" title="Permalink to this headline"></a></h2>
<p>See <a class="reference internal" href="license.html#license"><span class="std std-ref">License</span></a></p>
</section>
<section id="what-operating-systems-does-mdal-run-on">
<h2>What operating systems does MDAL run on?<a class="headerlink" href="#what-operating-systems-does-mdal-run-on" title="Permalink to this headline"></a></h2>
<p>You can use MDAL on all modern flavors of Unix: Linux, FreeBSD, Mac OS X; all supported versions of Microsoft Windows; mobile environements (Android and iOS).</p>
</section>
<section id="is-there-a-graphical-user-interface-to-mdal">
<h2>Is there a graphical user interface to MDAL?<a class="headerlink" href="#is-there-a-graphical-user-interface-to-mdal" title="Permalink to this headline"></a></h2>
<p>See <a class="reference internal" href="software_using_mdal.html#software-using-mdal"><span class="std std-ref">Software using MDAL</span></a></p>
<div class="toctree-wrapper compound">
</div>
</section>
<section id="what-compiler-can-i-use-to-build-mdal">
<h2>What compiler can I use to build MDAL?<a class="headerlink" href="#what-compiler-can-i-use-to-build-mdal" title="Permalink to this headline"></a></h2>
<p>MDAL can be compiled with a C++11 capable compiler.</p>
</section>
<section id="i-have-a-question-that-s-not-answered-here-where-can-i-get-more-information">
<h2>I have a question that’s not answered here. Where can I get more information?<a class="headerlink" href="#i-have-a-question-that-s-not-answered-here-where-can-i-get-more-information" title="Permalink to this headline"></a></h2>
<p>See <a class="reference internal" href="community.html#community"><span class="std std-ref">Community</span></a></p>
<p>Keep in mind, the quality of the answer you get does bear some relation to the quality of the question. If you need more detailed explanation of this, you can find it in essay <a class="reference external" href="http://www.catb.org/~esr/faqs/smart-questions.html">How To Ask Questions The Smart Way</a> by Eric S. Raymond.</p>
</section>
<section id="how-do-i-add-support-for-a-new-format">
<h2>How do I add support for a new format?<a class="headerlink" href="#how-do-i-add-support-for-a-new-format" title="Permalink to this headline"></a></h2>
<p>To some extent this is now covered by the <a class="reference internal" href="tutorials/add_driver_tut.html#add-driver-tut"><span class="std std-ref">MDAL driver implementation tutorial</span></a></p>
</section>
<section id="how-do-i-cite-mdal">
<h2>How do I cite MDAL ?<a class="headerlink" href="#how-do-i-cite-mdal" title="Permalink to this headline"></a></h2>
<p>See <a class="reference external" href="https://github.com/lutraconsulting/MDAL/blob/master/CITATION">CITATION</a></p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="contributing/rst_style.html" class="btn btn-neutral float-left" title="Sphinx RST Style guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="software_using_mdal.html" class="btn btn-neutral float-right" title="Software using MDAL" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2018-2020.</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>