-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
424 lines (403 loc) · 34.2 KB
/
index.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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
<!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>Introduction to OpenDrift — OpenDrift 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" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css" />
<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 async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></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="History" href="history_link.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">
OpenDrift
<img src="_static/opendrift_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 current"><a class="current reference internal" href="#">Introduction to OpenDrift</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="history_link.html">History</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="performance.html">Performance in OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html">Theory</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html#drift-in-the-ocean">Drift in the Ocean</a></li>
<li class="toctree-l1"><a class="reference internal" href="choosing_a_model.html">How to choose which model to use</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_a_new_model.html">How to write a new module</a></li>
<li class="toctree-l1"><a class="reference internal" href="gallery/index.html">Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="oil_types.html">Oil types</a></li>
<li class="toctree-l1"><a class="reference internal" href="interaction_with_coastline.html">Interaction with coastline</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using OpenDrift in a container</a></li>
<li class="toctree-l1"><a class="reference internal" href="gui.html">Graphical User Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="services.html">Services using OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="autoapi/index.html">API Reference</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="#">OpenDrift</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">Introduction to OpenDrift</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">
<div class="toctree-wrapper compound">
</div>
<section id="introduction-to-opendrift">
<h1>Introduction to OpenDrift<a class="headerlink" href="#introduction-to-opendrift" title="Link to this heading"></a></h1>
<p>OpenDrift is a software package for modeling the trajectories and fate of
objects or substances drifting in the ocean, or even in the atmosphere.</p>
<p>OpenDrift is open source (available on <a class="reference external" href="https://github.com/OpenDrift/opendrift/">GitHub</a>), and is programmed in Python. As the software is very
generic, it is rather a “framework” than a “trajectory model” in the
traditional sense. Trajectory models for specific purposes (e.g. <a class="reference internal" href="autoapi/opendrift/models/openoil/index.html#module-opendrift.models.openoil" title="opendrift.models.openoil"><code class="xref py py-mod docutils literal notranslate"><span class="pre">oil</span>
<span class="pre">drift</span></code></a>, <a class="reference internal" href="autoapi/opendrift/models/leeway/index.html#module-opendrift.models.leeway" title="opendrift.models.leeway"><code class="xref py py-mod docutils literal notranslate"><span class="pre">search</span> <span class="pre">and</span> <span class="pre">rescue</span></code></a>, <a class="reference internal" href="autoapi/opendrift/models/pelagicegg/index.html#module-opendrift.models.pelagicegg" title="opendrift.models.pelagicegg"><code class="xref py py-mod docutils literal notranslate"><span class="pre">larvae</span> <span class="pre">drift</span></code></a> etc) may reuse all common functionality from the
<a class="reference internal" href="autoapi/opendrift/models/basemodel/index.html#module-opendrift.models.basemodel" title="opendrift.models.basemodel"><code class="xref py py-mod docutils literal notranslate"><span class="pre">core</span> <span class="pre">model</span></code></a>, and need only implement a Python Class describing the
purpose-specific processes (physics/biology etc). See
<a class="reference internal" href="theory/specification.html"><span class="doc">Specifications and background requirements</span></a> and <a class="reference internal" href="theory/data_model.html"><span class="doc">Data model</span></a> for more detailed
information.</p>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference external" href="/gallery/example_depth.html"><img alt="ex1" src="_images/sphx_glr_example_depth_thumb.png" style="width: 250px;" /></a></p>
<p>Drift at different depths</p>
</td>
<td><p><a class="reference external" href="/gallery/example_oilspill_seafloor.html"><img alt="ex2" src="_images/example_oilspill_seafloor_0.gif" style="width: 250px;" /></a></p>
<p>Buoyancy and turbulence</p>
</td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="/gallery/example_oil_budget_noaa.html"><img alt="ex3" src="_images/sphx_glr_example_oil_budget_noaa_thumb.png" style="width: 250px;" /></a></p>
<p>Oil budget</p>
</td>
<td><p><a class="reference external" href="/gallery/example_leeway.html"><img alt="ex4" src="_images/sphx_glr_example_leeway_thumb.png" style="width: 250px;" /></a></p>
<p>Search and Rescue</p>
</td>
</tr>
</tbody>
</table>
<p>Some key features of OpenDrift are:</p>
<ul class="simple">
<li><p>Open source (GPLv2): providing full transparency.</p></li>
<li><p>Fast: optimised and vectorised Python code. Reading forcing data from disk/internet is normally the bottleneck.</p></li>
<li><p>Modular: may simulate transport and fate of any kind of particles (oil, ships, persons, icebergs, micro plastics…)</p></li>
<li><p>May use input forcing data (current, wind and waves) from any model, in many file formats and any map projection.</p></li>
<li><p>May use backup data sources if first choice is temporarily unavailable.</p></li>
<li><p>Can simulate backwards in time (specify a negative time step).</p></li>
<li><p>Output is saved to CF-compliant netCDF files.</p></li>
<li><p>Basic graphical user interface.</p></li>
<li><p>Can use input from ensemble models.</p></li>
</ul>
<p>Running a simulation can be as simple as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
<span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">opendrift.models.oceandrift</span><span class="w"> </span><span class="kn">import</span> <span class="n">OceanDrift</span>
<span class="gp">>>></span>
<span class="gp">>>> </span><span class="n">o</span> <span class="o">=</span> <span class="n">OceanDrift</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">add_readers_from_list</span><span class="p">(</span>
<span class="gp">>>> </span> <span class="p">[</span><span class="s1">'https://thredds.met.no/thredds/dodsC/sea/norkyst800m/1h/aggregate_be'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">seed_elements</span><span class="p">(</span><span class="n">lon</span><span class="o">=</span><span class="mf">4.85</span><span class="p">,</span> <span class="n">lat</span><span class="o">=</span><span class="mi">60</span><span class="p">,</span> <span class="n">time</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">(),</span> <span class="n">number</span><span class="o">=</span><span class="mi">10000</span><span class="p">,</span> <span class="n">radius</span><span class="o">=</span><span class="mi">1000</span><span class="p">)</span>
<span class="gp">>>></span>
<span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">duration</span><span class="o">=</span><span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span><span class="o">=</span><span class="mi">24</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">animation</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="s1">'animation.mp4'</span><span class="p">)</span>
</pre></div>
</div>
<img alt="_images/example_plot_0.gif" src="_images/example_plot_0.gif" />
<p>Once you have OpenDrift <a class="reference internal" href="install.html"><span class="doc">installed</span></a>, take a look at the
<a class="reference internal" href="tutorial.html"><span class="doc">Tutorial</span></a> on how to get started, or check out the <a class="reference internal" href="gallery/index.html"><span class="doc">gallery</span></a> for some examples. The details and physics of each model
is documented in the reference, along with specific examples for that model.
Models can be configured in nuanced ways which are important for more realistic
simulation (e.g. diffusion for <a class="reference internal" href="autoapi/opendrift/models/openoil/index.html#module-opendrift.models.openoil" title="opendrift.models.openoil"><code class="xref py py-mod docutils literal notranslate"><span class="pre">oil</span> <span class="pre">drift</span></code></a>
simulations). These should also be documented under the reference for the
particular model. See <a class="reference internal" href="autoapi/opendrift/models/index.html#module-opendrift.models" title="opendrift.models"><code class="xref py py-mod docutils literal notranslate"><span class="pre">opendrift.models</span></code></a> for an overview.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you found OpenDrift useful for your study, please cite it as:</p>
<ul class="simple">
<li><p>Dagestad, K.-F., Röhrs, J., Breivik, Ø., and Ådlandsvik, B.: <a class="reference external" href="https://www.geosci-model-dev.net/11/1405/2018/gmd-11-1405-2018.pdf">OpenDrift v1.0: a generic framework for trajectory modelling</a>, Geosci. Model Dev., 11, 1405-1420, <a class="reference external" href="https://doi.org/10.5194/gmd-11-1405-2018">https://doi.org/10.5194/gmd-11-1405-2018</a>, 2018.</p></li>
</ul>
<p>For the oil spill module, please cite in addition to the above:</p>
<ul class="simple">
<li><p>Röhrs, J., Dagestad, K.-F., Asbjørnsen, H., Nordam, T., Skancke, J., Jones, C. E., and Brekke, C.: <a class="reference external" href="https://www.ocean-sci.net/14/1581/2018/">The effect of vertical mixing on the horizontal drift of oil spills</a>, Ocean Sci., 14, 1581-1601, <a class="reference external" href="https://doi.org/10.5194/os-14-1581-2018">https://doi.org/10.5194/os-14-1581-2018</a>, 2018.</p></li>
</ul>
</div>
</section>
<section id="contents">
<h1>Contents<a class="headerlink" href="#contents" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="history_link.html">History</a><ul>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-12-0">2024-11-26 / Release v1.12.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-13">2024-07-24 / Release v1.11.13</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-12">2024-07-05 / Release v1.11.12</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-11">2024-07-04 / Release v1.11.11</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-10">2024-06-27 / Release v1.11.10</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-9">2024-06-27 / Release v1.11.9</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-8">2024-06-26 / Release v1.11.8</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-7">2024-06-25 / Release v1.11.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-6">2024-06-24 / Release v1.11.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-5">2024-06-18 / Release v1.11.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-4">2024-06-14 / Release v1.11.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-3">2024-06-14 / Release v1.11.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-2">2024-04-02 / Release v1.11.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-1">2024-01-25 / Release v1.11.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-11-0">2023-12-12 / Release v1.11.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-7">2023-05-02 / Release v1.10.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-6">2023-03-29 / Release v1.10.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-5">2023-01-26 / Release v1.10.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-4">2022-11-16 / Release v1.10.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-3">2022-11-16 / Release v1.10.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-2">2022-11-16 / Release v1.10.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-1">2022-09-27 / Release v1.10.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-10-0">2022-09-26 / Release v1.10.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-9-0">2022-03-18 / Release v1.9.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-8-4">2022-02-28 / Release v1.8.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-8-3">2022-01-31 / Release v1.8.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-8-2">2022-01-31 / Release v1.8.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-8-1">2022-01-27 / Release v1.8.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-8-0">2022-01-06 / Release v1.8.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-7-3">2021-11-08 / Release v1.7.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-7-2">2021-10-27 / Release v1.7.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-7-1">2021-09-01 / Release v1.7.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-7-0">2021-08-30 / Release v1.7.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-6-0">2021-05-03 / Release v1.6.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-5-6">2021-02-15 / Release v1.5.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-5-5">2021-01-26 / Release v1.5.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-5-4">2021-01-18 / Release v1.5.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-5-3">2021-01-15 / Release v1.5.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-5-2">2021-01-14 / Release v1.5.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-5-1">2021-01-05 / Release v1.5.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-5-0">2021-01-04 / Release v1.5.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-4-2">2020-11-01 / Release v1.4.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-4-1">2020-10-31 / Release v1.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-4-0">2020-10-27 / Release v1.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-3-3">2020-10-15 / Release v1.3.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-3-2">2020-08-21 / Release v1.3.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-3-1">2020-07-03 / Release v1.3.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-3-0">2020-06-24 / Release v1.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-2-3">2020-06-12 / Release v1.2.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-2-2">2020-06-08 / Release v1.2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-2-1">2020-05-14 / Release v1.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-2-0">2020-01-08 / Release v1.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history_link.html#release-v1-1-1">2019-11-27 / Release v1.1.1</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing OpenDrift</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#alternative-1-using-mambaforge-or-miniforge-and-git-recommended">Alternative 1: Using Mambaforge (or Miniforge) and Git (recommended)</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#alternative-2-using-mambaforge-or-miniforge">Alternative 2: Using Mambaforge (or Miniforge)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#modify-install-to-use-git-version">Modify install to use Git version</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#building-and-using-the-docker-image">Building and using the Docker image</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="performance.html">Performance in OpenDrift</a><ul>
<li class="toctree-l2"><a class="reference internal" href="performance.html#generic-settings">Generic settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="performance.html#addtitional-packages">Addtitional packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="performance.html#tuning-the-simulation">Tuning the simulation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="performance.html#some-notes-about-performance">Some notes about performance</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#import-a-specific-model-for-the-relevant-application">1. Import a specific <strong>model</strong> for the relevant application</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#adding-readers">2. Adding <strong>Readers</strong></a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#lazy-readers">2.1 Lazy Readers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#seeding-elements">3. Seeding elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#configuration">4. Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#running-the-model">5. Running the model</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#plotting-and-analysing-the-results">6. Plotting and analysing the results</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html">Theory</a><ul>
<li class="toctree-l2"><a class="reference internal" href="theory/lagrangian.html">Lagrangian simulation of drift trajectories</a></li>
<li class="toctree-l2"><a class="reference internal" href="theory/eulerian.html">Eulerian simulation of drift trajectories</a><ul>
<li class="toctree-l3"><a class="reference internal" href="theory/eulerian.html#convection">Convection</a></li>
<li class="toctree-l3"><a class="reference internal" href="theory/eulerian.html#diffusion">Diffusion</a></li>
<li class="toctree-l3"><a class="reference internal" href="theory/eulerian.html#numerical-schemes">Numerical schemes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="theory/specification.html">Specifications and background requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="theory/data_model.html">Data model</a><ul>
<li class="toctree-l3"><a class="reference internal" href="theory/data_model.html#reader">Reader</a></li>
<li class="toctree-l3"><a class="reference internal" href="theory/data_model.html#lagrangianarray">LagrangianArray</a></li>
<li class="toctree-l3"><a class="reference internal" href="theory/data_model.html#model-subclass-of-opendriftsimulation">Model (subclass of OpenDriftSimulation)</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html#drift-in-the-ocean">Drift in the Ocean</a><ul>
<li class="toctree-l2"><a class="reference internal" href="theory/index.html#methods-of-simulation">Methods of simulation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="choosing_a_model.html">How to choose which model to use</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_a_new_model.html">How to write a new module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="writing_a_new_model.html#moving-elements">1. Moving elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="writing_a_new_model.html#modifying-element-properties">2. Modifying element properties</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gallery/index.html">Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="oil_types.html">Oil types</a></li>
<li class="toctree-l1"><a class="reference internal" href="interaction_with_coastline.html">Interaction with coastline</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using OpenDrift in a container</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docker.html#pull">Pull</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#build">Build</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#singularity">Singularity</a><ul>
<li class="toctree-l3"><a class="reference internal" href="docker.html#installation">Installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="docker.html#pull-the-container">Pull the Container</a></li>
<li class="toctree-l3"><a class="reference internal" href="docker.html#using-the-image">Using the image</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gui.html">Graphical User Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gui.html#choosing-a-model-and-parameters">Choosing a model and parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui.html#seeding-of-particles">Seeding of particles</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui.html#simulation-time">Simulation time</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui.html#forcing-data">Forcing data</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui.html#simulation-and-analysis">Simulation and analysis</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="services.html">Services using OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="autoapi/index.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="autoapi/parse/index.html">parse</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/parse/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/parse/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/shyfem/index.html">shyfem</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/shyfem/index.html#attributes">Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/shyfem/index.html#classes">Classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/shyfem/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/opendrift/index.html">opendrift</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift/index.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift/index.html#attributes">Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift/index.html#package-contents">Package Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/hodograph/index.html">hodograph</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/hodograph/index.html#attributes">Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/hodograph/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/hodograph/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/readerinfo/index.html">readerinfo</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/readerinfo/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/readerinfo/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/NO00159_SVALE/index.html">NO00159_SVALE</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/NO00159_SVALE/index.html#attributes">Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/NO00159_SVALE/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/parse_oil_pdf/index.html">parse_oil_pdf</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/parse_oil_pdf/index.html#classes">Classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/parse_oil_pdf/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/parse_oil_pdf/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/opendrift_gui/index.html">opendrift_gui</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_gui/index.html#classes">Classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_gui/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_gui/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/opendrift_plot/index.html">opendrift_plot</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_plot/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_plot/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/opendrift_animate/index.html">opendrift_animate</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_animate/index.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_animate/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autoapi/opendrift_animate_profile/index.html">opendrift_animate_profile</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_animate_profile/index.html#attributes">Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="autoapi/opendrift_animate_profile/index.html#module-contents">Module Contents</a></li>
</ul>
</li>
</ul>
</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="search.html"><span class="std std-ref">Search Page</span></a></p></li>
<li><p><a class="reference internal" href="autoapi/index.html"><span class="doc">API Reference</span></a></p></li>
</ul>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="history_link.html" class="btn btn-neutral float-right" title="History" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020, Knut-Frode Dagestad ([email protected]) and Gaute Hope ([email protected])..</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>