-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopendrift.html
318 lines (273 loc) · 36.5 KB
/
opendrift.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
<!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.0" />
<title>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 src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.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">
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>
<li class="toctree-l1"><a class="reference internal" href="../index.html">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="../index.html">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="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Module code</a></li>
<li class="breadcrumb-item active">opendrift</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for opendrift</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">Opendrift module</span>
<span class="sd">.. currentmodule:: opendrift</span>
<span class="sd">.. doctest::</span>
<span class="sd"> >>> import opendrift</span>
<span class="sd">"""</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span><span class="p">;</span> <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">importlib</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">__version__</span>
<span class="c1"># For automated access to available drift classes, e.g. for GUI</span>
<span class="c1"># Hardcoded for now</span>
<span class="n">_available_models</span> <span class="o">=</span> \
<span class="p">[</span><span class="s1">'leeway.Leeway'</span><span class="p">,</span>
<span class="s1">'openoil.OpenOil'</span><span class="p">,</span>
<span class="s1">'larvalfish.LarvalFish'</span><span class="p">,</span>
<span class="s1">'plastdrift.PlastDrift'</span><span class="p">,</span>
<span class="s1">'shipdrift.ShipDrift'</span><span class="p">,</span>
<span class="s1">'openberg_old.OpenBergOld'</span><span class="p">]</span>
<div class="viewcode-block" id="get_model_names">
<a class="viewcode-back" href="../autoapi/opendrift/index.html#opendrift.get_model_names">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_model_names</span><span class="p">():</span>
<span class="k">return</span> <span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">_available_models</span><span class="p">]</span></div>
<div class="viewcode-block" id="get_model">
<a class="viewcode-back" href="../autoapi/opendrift/index.html#opendrift.get_model">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_model</span><span class="p">(</span><span class="n">model_name</span><span class="p">):</span>
<span class="k">if</span> <span class="n">model_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">get_model_names</span><span class="p">():</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'No drift model named </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">model_name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">_available_models</span><span class="p">:</span>
<span class="k">if</span> <span class="n">m</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">model_name</span><span class="p">:</span>
<span class="n">module</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span>
<span class="s1">'opendrift.models.'</span> <span class="o">+</span> <span class="n">m</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">model</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">model_name</span><span class="p">)</span>
<span class="k">return</span> <span class="n">model</span></div>
<div class="viewcode-block" id="open">
<a class="viewcode-back" href="../autoapi/opendrift/index.html#opendrift.open">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">open</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
<span class="w"> </span><span class="sd">'''Import netCDF output file as OpenDrift object of correct class'''</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">pydoc</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">netCDF4</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dataset</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'File does not exist, trying to retrieve from URL'</span><span class="p">)</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">urllib</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">urllib</span><span class="o">.</span><span class="n">urlretrieve</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'opendrift_tmp.nc'</span><span class="p">)</span>
<span class="n">filename</span> <span class="o">=</span> <span class="s1">'opendrift_tmp.nc'</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1"> does not exist'</span> <span class="o">%</span> <span class="n">filename</span><span class="p">)</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Dataset</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">module_name</span> <span class="o">=</span> <span class="n">n</span><span class="o">.</span><span class="n">opendrift_module</span>
<span class="n">class_name</span> <span class="o">=</span> <span class="n">n</span><span class="o">.</span><span class="n">opendrift_class</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">filename</span> <span class="o">+</span> <span class="s1">' does not contain global attributes '</span>
<span class="s1">'opendrift_module and opendrift_class, defaulting to OceanDrift'</span><span class="p">)</span>
<span class="n">module_name</span> <span class="o">=</span> <span class="s1">'oceandrift'</span>
<span class="n">class_name</span> <span class="o">=</span> <span class="s1">'OceanDrift'</span>
<span class="n">n</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">if</span> <span class="n">class_name</span> <span class="o">==</span> <span class="s1">'OpenOil3D'</span><span class="p">:</span>
<span class="n">class_name</span> <span class="o">=</span> <span class="s1">'OpenOil'</span>
<span class="n">module_name</span> <span class="o">=</span> <span class="s1">'opendrift.models.openoil'</span>
<span class="k">if</span> <span class="n">class_name</span> <span class="o">==</span> <span class="s1">'OceanDrift3D'</span><span class="p">:</span>
<span class="n">class_name</span> <span class="o">=</span> <span class="s1">'OceanDrift'</span>
<span class="n">module_name</span> <span class="o">=</span> <span class="s1">'opendrift.models.oceandrift'</span>
<span class="bp">cls</span> <span class="o">=</span> <span class="n">pydoc</span><span class="o">.</span><span class="n">locate</span><span class="p">(</span><span class="n">module_name</span> <span class="o">+</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="n">class_name</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">cls</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opendrift.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">oceandrift</span>
<span class="bp">cls</span> <span class="o">=</span> <span class="n">oceandrift</span><span class="o">.</span><span class="n">OceanDrift</span>
<span class="n">o</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
<span class="n">o</span><span class="o">.</span><span class="n">io_import_file</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="c1">#, times=times, elements=elements, load_history=load_history)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Returning '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">o</span><span class="p">))</span> <span class="o">+</span> <span class="s1">' object'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">o</span></div>
<div class="viewcode-block" id="versions">
<a class="viewcode-back" href="../autoapi/opendrift/index.html#opendrift.versions">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">versions</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">version</span><span class="p">(</span><span class="n">package</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">importlib</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">version</span><span class="p">(</span><span class="n">package</span><span class="p">)</span>
<span class="k">except</span> <span class="n">importlib</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">PackageNotFoundError</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">"N/A"</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">multiprocessing</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">platform</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="n">s</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">------------------------------------------------------</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">'Software and hardware:</span><span class="se">\n</span><span class="s1">'</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' OpenDrift version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">__version__</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' Platform: </span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">(),</span> <span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">())</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">psutil</span><span class="w"> </span><span class="kn">import</span> <span class="n">virtual_memory</span>
<span class="n">ram</span> <span class="o">=</span> <span class="n">virtual_memory</span><span class="p">()</span><span class="o">.</span><span class="n">total</span><span class="o">/</span><span class="p">(</span><span class="mi">1024</span><span class="o">**</span><span class="mi">3</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">ram</span> <span class="o">=</span> <span class="s1">'unknown'</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' </span><span class="si">%s</span><span class="s1"> GB memory</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">ram</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' </span><span class="si">%s</span><span class="s1"> processors (</span><span class="si">%s</span><span class="s1">)</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">multiprocessing</span><span class="o">.</span><span class="n">cpu_count</span><span class="p">(),</span>
<span class="n">platform</span><span class="o">.</span><span class="n">processor</span><span class="p">())</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' NumPy version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">(</span><span class="s1">'numpy'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' SciPy version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">(</span><span class="s1">'scipy'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' Matplotlib version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">(</span><span class="s1">'matplotlib'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' NetCDF4 version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">(</span><span class="s1">'netCDF4'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' Xarray version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">(</span><span class="s1">'xarray'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' ADIOS (adios_db) version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">(</span><span class="s1">'adios_db'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' Copernicusmarine version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">(</span><span class="s1">'copernicusmarine'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">' Python version </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">sys</span><span class="o">.</span><span class="n">version</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s1">'------------------------------------------------------</span><span class="se">\n</span><span class="s1">'</span>
<span class="k">return</span> <span class="n">s</span></div>
<div class="viewcode-block" id="import_from_ladim">
<a class="viewcode-back" href="../autoapi/opendrift/index.html#opendrift.import_from_ladim">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_from_ladim</span><span class="p">(</span><span class="n">ladimfile</span><span class="p">,</span> <span class="n">romsfile</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Import Ladim output file as OpenDrift simulation obejct"""</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">models.oceandrift</span><span class="w"> </span><span class="kn">import</span> <span class="n">OceanDrift</span>
<span class="n">o</span> <span class="o">=</span> <span class="n">OceanDrift</span><span class="p">()</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">netCDF4</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dataset</span><span class="p">,</span> <span class="n">date2num</span><span class="p">,</span> <span class="n">num2date</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">romsfile</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opendrift.readers</span><span class="w"> </span><span class="kn">import</span> <span class="n">reader_ROMS_native</span>
<span class="n">romsfile</span> <span class="o">=</span> <span class="n">reader_ROMS_native</span><span class="o">.</span><span class="n">Reader</span><span class="p">(</span><span class="n">romsfile</span><span class="p">)</span>
<span class="n">l</span> <span class="o">=</span> <span class="n">Dataset</span><span class="p">(</span><span class="n">ladimfile</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">)</span>
<span class="n">pid</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="s1">'pid'</span><span class="p">][:]</span>
<span class="n">particle_count</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="s1">'particle_count'</span><span class="p">][:]</span>
<span class="n">end_index</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">cumsum</span><span class="p">(</span><span class="n">particle_count</span><span class="p">)</span>
<span class="n">start_index</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">(([</span><span class="mi">0</span><span class="p">],</span> <span class="n">end_index</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="s1">'X'</span><span class="p">][:]</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="s1">'Y'</span><span class="p">][:]</span>
<span class="n">lon</span><span class="p">,</span> <span class="n">lat</span> <span class="o">=</span> <span class="n">romsfile</span><span class="o">.</span><span class="n">xy2lonlat</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
<span class="n">time</span> <span class="o">=</span> <span class="n">num2date</span><span class="p">(</span><span class="n">l</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="s1">'time'</span><span class="p">][:],</span>
<span class="n">l</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="s1">'time'</span><span class="p">]</span><span class="o">.</span><span class="n">units</span><span class="p">)</span>
<span class="n">history_dtype_fields</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">o</span><span class="o">.</span><span class="n">ElementType</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">name</span><span class="p">][</span><span class="s1">'dtype'</span><span class="p">])</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">o</span><span class="o">.</span><span class="n">ElementType</span><span class="o">.</span><span class="n">variables</span><span class="p">]</span>
<span class="c1"># Add environment variables</span>
<span class="n">o</span><span class="o">.</span><span class="n">history_metadata</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">ElementType</span><span class="o">.</span><span class="n">variables</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">history_dtype</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">dtype</span><span class="p">(</span><span class="n">history_dtype_fields</span><span class="p">)</span>
<span class="n">num_timesteps</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">time</span><span class="p">)</span>
<span class="n">num_elements</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">l</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="s1">'particle'</span><span class="p">])</span>
<span class="n">o</span><span class="o">.</span><span class="n">history</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">array</span><span class="p">(</span>
<span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">([</span><span class="n">num_elements</span><span class="p">,</span> <span class="n">num_timesteps</span><span class="p">]),</span>
<span class="n">dtype</span><span class="o">=</span><span class="n">history_dtype</span><span class="p">,</span> <span class="n">mask</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">])</span>
<span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_timesteps</span><span class="p">):</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">start_index</span><span class="p">[</span><span class="n">n</span><span class="p">]</span>
<span class="n">active</span> <span class="o">=</span> <span class="n">pid</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">start</span><span class="o">+</span><span class="n">particle_count</span><span class="p">[</span><span class="n">n</span><span class="p">]]</span>
<span class="n">o</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="s1">'lon'</span><span class="p">][</span><span class="n">active</span><span class="p">,</span> <span class="n">n</span><span class="p">]</span> <span class="o">=</span> \
<span class="n">lon</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">start</span><span class="o">+</span><span class="n">particle_count</span><span class="p">[</span><span class="n">n</span><span class="p">]]</span>
<span class="n">o</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="s1">'lat'</span><span class="p">][</span><span class="n">active</span><span class="p">,</span> <span class="n">n</span><span class="p">]</span> <span class="o">=</span> \
<span class="n">lat</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">start</span><span class="o">+</span><span class="n">particle_count</span><span class="p">[</span><span class="n">n</span><span class="p">]]</span>
<span class="n">o</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="s1">'status'</span><span class="p">][</span><span class="n">active</span><span class="p">,</span> <span class="n">n</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">o</span><span class="o">.</span><span class="n">status_categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'active'</span><span class="p">,</span> <span class="s1">'missing_data'</span><span class="p">]</span>
<span class="n">firstlast</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">notmasked_edges</span><span class="p">(</span><span class="n">o</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="s1">'status'</span><span class="p">],</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="n">index_of_last</span> <span class="o">=</span> <span class="n">firstlast</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span>
<span class="n">o</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="s1">'status'</span><span class="p">][</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">index_of_last</span><span class="p">)),</span>
<span class="n">index_of_last</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">var</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'lon'</span><span class="p">,</span> <span class="s1">'lat'</span><span class="p">,</span> <span class="s1">'status'</span><span class="p">]:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="n">var</span><span class="p">]</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="n">var</span><span class="p">][</span>
<span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">index_of_last</span><span class="p">)),</span> <span class="n">index_of_last</span><span class="p">]</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s1">'ID'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_elements</span><span class="p">)</span>
<span class="n">o</span><span class="o">.</span><span class="n">elements</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">ElementType</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">o</span><span class="o">.</span><span class="n">elements_deactivated</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">ElementType</span><span class="p">()</span>
<span class="n">o</span><span class="o">.</span><span class="n">remove_deactivated_elements</span><span class="p">()</span>
<span class="c1"># Import time steps from metadata</span>
<span class="n">o</span><span class="o">.</span><span class="n">time_step</span> <span class="o">=</span> <span class="n">time</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">time</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">o</span><span class="o">.</span><span class="n">time_step_output</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">time_step</span>
<span class="n">o</span><span class="o">.</span><span class="n">start_time</span> <span class="o">=</span> <span class="n">time</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">o</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="n">time</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">o</span><span class="o">.</span><span class="n">steps_output</span> <span class="o">=</span> <span class="n">num_timesteps</span>
<span class="k">return</span> <span class="n">o</span></div>
</pre></div>
</div>
</div>
<footer>
<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>