-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathfunction.html
More file actions
534 lines (496 loc) · 50.3 KB
/
function.html
File metadata and controls
534 lines (496 loc) · 50.3 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
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>cf functions — Documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
<script src="_static/documentation_options.js?v=b14d8abf"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=b578dfe4"></script>
<script src="_static/toggleprompt.js?v=1b41717f"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<link rel="icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cf.read" href="function/cf.read.html" />
<link rel="prev" title="API reference" href="api_reference.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.svg" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="index.html">cf 3.19.0</a></h1>
<p class="blurb">A CF-compliant earth science data analysis library</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=NCAS-CMS&repo=cf-python&type=star&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html"><strong>Introduction</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html"><strong>Installation</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="cheat_sheet.html"><strong>Cheat Sheet</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes/index.html"><strong>Recipes using cf</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html"><strong>Tutorial</strong></a></li>
<li class="toctree-l1 current"><a class="reference internal" href="api_reference.html"><strong>API reference</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="aggregation_rules.html"><strong>Aggregation rules</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="performance.html"><strong>Performance</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html"><strong>Releases</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="Changelog.html"><strong>Change log</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html"><strong>Contributing</strong></a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="api_reference.html"><strong>API reference</strong></a><ul>
<li>Previous: <a href="api_reference.html" title="previous chapter"><strong>API reference</strong></a></li>
<li>Next: <a href="function/cf.read.html" title="next chapter">cf.read</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<br>
cf development has been supported by
the <a href="https://erc.europa.eu/">ERC</a>
through <a href="https://cordis.europa.eu/project/id/247220">Seachange</a>
and
<a href="https://cordis.europa.eu/project/id/786427">Couplet</a>; by
the <a href="https://ec.europa.eu/programmes/horizon2020/">EC Horizon
2020 programme</a> through
<a href="https://cordis.europa.eu/project/id/824084">IS-ENES3</a>;
by <a href="https://nerc.ukri.org/">NERC</a> through
<a href="https://gtr.ukri.org/project/0D95A6DB-0B95-48F7-8A8B-7B9A47DEA117">UKFAFMIP</a>;
and by <a href="https://ncas.ac.uk/">NCAS</a>.
<br>
<br>
<img src="_static/logo_EC.png" height="40">
<img src="_static/logo_ERC.png" height="40">
<img src="_static/logo_NERC.png" height="40">
<br>
<img src="_static/logo_NCAS.png" height="40">
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="cf-functions">
<span id="function"></span><h1><strong>cf functions</strong><a class="headerlink" href="#cf-functions" title="Link to this heading">¶</a></h1>
<hr class="docutils" />
<p>Version 3.19.0 for version 1.13 of the CF conventions.</p>
<section id="reading-and-writing">
<h2>Reading and writing<a class="headerlink" href="#reading-and-writing" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.read.html#cf.read" title="cf.read"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.read</span></code></a></p></td>
<td><p>Read field or domain constructs from files.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.write.html#cf.write" title="cf.write"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.write</span></code></a></p></td>
<td><p>Write field and domain constructs to a dataset.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="aggregation">
<h2>Aggregation<a class="headerlink" href="#aggregation" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.aggregate.html#cf.aggregate" title="cf.aggregate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.aggregate</span></code></a></p></td>
<td><p>Aggregate field constructs into as few field constructs as possible.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.climatology_cells.html#cf.climatology_cells" title="cf.climatology_cells"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.climatology_cells</span></code></a></p></td>
<td><p>Return a climatological cells dictionary for <a class="reference internal" href="function/cf.aggregate.html#cf.aggregate" title="cf.aggregate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.aggregate</span></code></a>.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="mathematical-operations">
<span id="functions-mathematical-operations"></span><h2>Mathematical operations<a class="headerlink" href="#mathematical-operations" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.atol.html#cf.atol" title="cf.atol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.atol</span></code></a></p></td>
<td><p>The numerical equality tolerance on absolute differences.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.rtol.html#cf.rtol" title="cf.rtol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.rtol</span></code></a></p></td>
<td><p>The numerical equality tolerance on relative differences.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.bounds_combination_mode.html#cf.bounds_combination_mode" title="cf.bounds_combination_mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.bounds_combination_mode</span></code></a></p></td>
<td><p>Determine how to deal with cell bounds in binary operations.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.default_netCDF_fillvals.html#cf.default_netCDF_fillvals" title="cf.default_netCDF_fillvals"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.default_netCDF_fillvals</span></code></a></p></td>
<td><p>Default data array fill values for each data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.curl_xy.html#cf.curl_xy" title="cf.curl_xy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.curl_xy</span></code></a></p></td>
<td><p>Calculate the horizontal curl of an (X, Y) vector.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.div_xy.html#cf.div_xy" title="cf.div_xy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.div_xy</span></code></a></p></td>
<td><p>Calculate the horizontal divergence of an (X, Y) vector.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.histogram.html#cf.histogram" title="cf.histogram"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.histogram</span></code></a></p></td>
<td><p>Return the distribution of a set of variables in the form of an N-dimensional histogram.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.ATOL.html#cf.ATOL" title="cf.ATOL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.ATOL</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.atol.html#cf.atol" title="cf.atol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.atol</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.RTOL.html#cf.RTOL" title="cf.RTOL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.RTOL</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.rtol.html#cf.rtol" title="cf.rtol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.rtol</span></code></a>.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="condition-constructors">
<h2>Condition constructors<a class="headerlink" href="#condition-constructors" title="Link to this heading">¶</a></h2>
<p class="rubric">General conditions</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.eq.html#cf.eq" title="cf.eq"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.eq</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for an "equal" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.ge.html#cf.ge" title="cf.ge"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.ge</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "greater than or equal" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.gt.html#cf.gt" title="cf.gt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.gt</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "strictly greater than" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.le.html#cf.le" title="cf.le"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.le</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "less than or equal" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.lt.html#cf.lt" title="cf.lt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.lt</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "strictly less than" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.ne.html#cf.ne" title="cf.ne"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.ne</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "not equal" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.wi.html#cf.wi" title="cf.wi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.wi</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "within a range" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.wo.html#cf.wo" title="cf.wo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.wo</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "without a range" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.set.html#cf.set" title="cf.set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.set</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "member of set" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.isclose.html#cf.isclose" title="cf.isclose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.isclose</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for an "is close" condition.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Date-time conditions</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.year.html#cf.year" title="cf.year"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.year</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "year" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.month.html#cf.month" title="cf.month"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.month</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "month of the year" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.day.html#cf.day" title="cf.day"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.day</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "day of the month" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.hour.html#cf.hour" title="cf.hour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.hour</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "hour of the day" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.minute.html#cf.minute" title="cf.minute"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.minute</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "minute of the hour" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.second.html#cf.second" title="cf.second"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.second</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "second of the minute" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.jja.html#cf.jja" title="cf.jja"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.jja</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "month of year in June, July or August" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.son.html#cf.son" title="cf.son"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.son</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "month of year in September, October, November" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.djf.html#cf.djf" title="cf.djf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.djf</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "month of year in December, January, February" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.mam.html#cf.mam" title="cf.mam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.mam</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "month of year in March, April, May" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.seasons.html#cf.seasons" title="cf.seasons"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.seasons</span></code></a></p></td>
<td><p>A customisable list of <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> objects for "seasons in a year" conditions.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Coordinate cell conditions</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.contains.html#cf.contains" title="cf.contains"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.contains</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "cell contains" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.cellsize.html#cf.cellsize" title="cf.cellsize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.cellsize</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "cell size" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.cellgt.html#cf.cellgt" title="cf.cellgt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.cellgt</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "cell bounds strictly greater than" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.cellge.html#cf.cellge" title="cf.cellge"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.cellge</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "cell bounds greater than or equal" condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.cellle.html#cf.cellle" title="cf.cellle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.cellle</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "cell bounds less than or equal" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.celllt.html#cf.celllt" title="cf.celllt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.celllt</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a “cell bounds strictly less than” condition.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.cellwi.html#cf.cellwi" title="cf.cellwi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.cellwi</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "cell bounds lie within range" condition.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.cellwo.html#cf.cellwo" title="cf.cellwo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.cellwo</span></code></a></p></td>
<td><p>A <a class="reference internal" href="class/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Query</span></code></a> object for a "cell bounds lie without range" condition.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="date-time-and-time-duration">
<h2>Date-time and time duration<a class="headerlink" href="#date-time-and-time-duration" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.dt.html#cf.dt" title="cf.dt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.dt</span></code></a></p></td>
<td><p>Return a date-time object for a date and time according to a calendar.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.dt_vector.html#cf.dt_vector" title="cf.dt_vector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.dt_vector</span></code></a></p></td>
<td><p>Return a 1-d array of date-time objects.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.Y.html#cf.Y" title="cf.Y"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.Y</span></code></a></p></td>
<td><p>Return a time duration of calendar years in a <a class="reference internal" href="class/cf.TimeDuration.html#cf.TimeDuration" title="cf.TimeDuration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TimeDuration</span></code></a> object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.M.html#cf.M" title="cf.M"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.M</span></code></a></p></td>
<td><p>Return a time duration of calendar months in a <a class="reference internal" href="class/cf.TimeDuration.html#cf.TimeDuration" title="cf.TimeDuration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TimeDuration</span></code></a> object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.D.html#cf.D" title="cf.D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.D</span></code></a></p></td>
<td><p>Return a time duration of days in a <a class="reference internal" href="class/cf.TimeDuration.html#cf.TimeDuration" title="cf.TimeDuration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TimeDuration</span></code></a> object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.h.html#cf.h" title="cf.h"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.h</span></code></a></p></td>
<td><p>Return a time duration of hours in a <a class="reference internal" href="class/cf.TimeDuration.html#cf.TimeDuration" title="cf.TimeDuration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TimeDuration</span></code></a> object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.m.html#cf.m" title="cf.m"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.m</span></code></a></p></td>
<td><p>Return a time duration of minutes in a <a class="reference internal" href="class/cf.TimeDuration.html#cf.TimeDuration" title="cf.TimeDuration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TimeDuration</span></code></a> object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.s.html#cf.s" title="cf.s"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.s</span></code></a></p></td>
<td><p>Return a time duration of seconds in a <a class="reference internal" href="class/cf.TimeDuration.html#cf.TimeDuration" title="cf.TimeDuration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TimeDuration</span></code></a> object.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="resource-management">
<h2>Resource management<a class="headerlink" href="#resource-management" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.configuration.html#cf.configuration" title="cf.configuration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.configuration</span></code></a></p></td>
<td><p>View or set any number of constants in the project-wide configuration.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.chunksize.html#cf.chunksize" title="cf.chunksize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.chunksize</span></code></a></p></td>
<td><p>Return a <a class="reference internal" href="class/cf.Constant.html#cf.Constant" title="cf.Constant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Constant</span></code></a> instance during class creation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.free_memory.html#cf.free_memory" title="cf.free_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.free_memory</span></code></a></p></td>
<td><p>The available physical memory.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.regrid_logging.html#cf.regrid_logging" title="cf.regrid_logging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.regrid_logging</span></code></a></p></td>
<td><p>Whether or not to enable <code class="xref py py-obj docutils literal notranslate"><span class="pre">esmpy</span></code> regridding logging.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.tempdir.html#cf.tempdir" title="cf.tempdir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.tempdir</span></code></a></p></td>
<td><p>The directory for internally generated temporary files.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.total_memory.html#cf.total_memory" title="cf.total_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.total_memory</span></code></a></p></td>
<td><p>The total amount of physical memory (in bytes).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.CHUNKSIZE.html#cf.CHUNKSIZE" title="cf.CHUNKSIZE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.CHUNKSIZE</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.chunksize.html#cf.chunksize" title="cf.chunksize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.chunksize</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.FREE_MEMORY.html#cf.FREE_MEMORY" title="cf.FREE_MEMORY"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.FREE_MEMORY</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.free_memory.html#cf.free_memory" title="cf.free_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.free_memory</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.REGRID_LOGGING.html#cf.REGRID_LOGGING" title="cf.REGRID_LOGGING"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.REGRID_LOGGING</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.regrid_logging.html#cf.regrid_logging" title="cf.regrid_logging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.regrid_logging</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.TEMPDIR.html#cf.TEMPDIR" title="cf.TEMPDIR"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TEMPDIR</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.tempdir.html#cf.tempdir" title="cf.tempdir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.tempdir</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.TOTAL_MEMORY.html#cf.TOTAL_MEMORY" title="cf.TOTAL_MEMORY"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.TOTAL_MEMORY</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.total_memory.html#cf.total_memory" title="cf.total_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.total_memory</span></code></a>.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="active-storage-reductions">
<h2>Active storage reductions<a class="headerlink" href="#active-storage-reductions" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.active_storage.html#cf.active_storage" title="cf.active_storage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.active_storage</span></code></a></p></td>
<td><p>Whether or not to attempt active storage reductions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.active_storage_url.html#cf.active_storage_url" title="cf.active_storage_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.active_storage_url</span></code></a></p></td>
<td><p>The URL location of the active storage reducer.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.active_storage_max_requests.html#cf.active_storage_max_requests" title="cf.active_storage_max_requests"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.active_storage_max_requests</span></code></a></p></td>
<td><p>Concurrent active storage server requests per <code class="xref py py-obj docutils literal notranslate"><span class="pre">dask</span></code> chunk.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="miscellaneous">
<h2>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.CF.html#cf.CF" title="cf.CF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.CF</span></code></a></p></td>
<td><p>The version of the CF conventions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.abspath.html#cf.abspath" title="cf.abspath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.abspath</span></code></a></p></td>
<td><p>Return a normalised absolute version of a path.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.dirname.html#cf.dirname" title="cf.dirname"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.dirname</span></code></a></p></td>
<td><p>Return the directory of a path.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.dump.html#cf.dump" title="cf.dump"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.dump</span></code></a></p></td>
<td><p>Print a description of an object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.environment.html#cf.environment" title="cf.environment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.environment</span></code></a></p></td>
<td><p>Return the names and versions of the cf package and its dependencies.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.example_field.html#cf.example_field" title="cf.example_field"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.example_field</span></code></a></p></td>
<td><p>Return an example field construct.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.example_fields.html#cf.example_fields" title="cf.example_fields"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.example_fields</span></code></a></p></td>
<td><p>Return example field constructs.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.example_domain.html#cf.example_domain" title="cf.example_domain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.example_domain</span></code></a></p></td>
<td><p>Return an example domain construct.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.flat.html#cf.flat" title="cf.flat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.flat</span></code></a></p></td>
<td><p>Return an iterator over an arbitrarily nested sequence.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.implementation.html#cf.implementation" title="cf.implementation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.implementation</span></code></a></p></td>
<td><p>Return a container for the CF data model implementation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.indices_shape.html#cf.indices_shape" title="cf.indices_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.indices_shape</span></code></a></p></td>
<td><p>Return the shape of the array subspace implied by indices.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.inspect.html#cf.inspect" title="cf.inspect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.inspect</span></code></a></p></td>
<td><p>Inspect the attributes of an object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.log_level.html#cf.log_level" title="cf.log_level"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.log_level</span></code></a></p></td>
<td><p>The minimal level of seriousness of log messages which are shown.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.pathjoin.html#cf.pathjoin" title="cf.pathjoin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.pathjoin</span></code></a></p></td>
<td><p>Join two file path components intelligently.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.relaxed_identities.html#cf.relaxed_identities" title="cf.relaxed_identities"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.relaxed_identities</span></code></a></p></td>
<td><p>Use 'relaxed' mode when getting a construct identity.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.relpath.html#cf.relpath" title="cf.relpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.relpath</span></code></a></p></td>
<td><p>Return a relative filepath to a file.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.load_stash2standard_name.html#cf.load_stash2standard_name" title="cf.load_stash2standard_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.load_stash2standard_name</span></code></a></p></td>
<td><p>Load a STASH to standard name conversion table from a file.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.stash2standard_name.html#cf.stash2standard_name" title="cf.stash2standard_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.stash2standard_name</span></code></a></p></td>
<td><p>Return a copy of the loaded STASH to standard name conversion table.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.unique_constructs.html#cf.unique_constructs" title="cf.unique_constructs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.unique_constructs</span></code></a></p></td>
<td><p>Return the unique constructs from a sequence.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.LOG_LEVEL.html#cf.LOG_LEVEL" title="cf.LOG_LEVEL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.LOG_LEVEL</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.log_level.html#cf.log_level" title="cf.log_level"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.log_level</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.RELAXED_IDENTITIES.html#cf.RELAXED_IDENTITIES" title="cf.RELAXED_IDENTITIES"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.RELAXED_IDENTITIES</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.relaxed_identities.html#cf.relaxed_identities" title="cf.relaxed_identities"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.relaxed_identities</span></code></a>.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="deprecated">
<h2>Deprecated<a class="headerlink" href="#deprecated" title="Link to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.close_files.html#cf.close_files" title="cf.close_files"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.close_files</span></code></a></p></td>
<td><p>Close open files containing sub-arrays of data arrays.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.close_one_file.html#cf.close_one_file" title="cf.close_one_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.close_one_file</span></code></a></p></td>
<td><p>Close an arbitrary open file containing a sub-array of a data array.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.collapse_parallel_mode.html#cf.collapse_parallel_mode" title="cf.collapse_parallel_mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.collapse_parallel_mode</span></code></a></p></td>
<td><p>Which mode to use when collapse is run in parallel.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.fm_threshold.html#cf.fm_threshold" title="cf.fm_threshold"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.fm_threshold</span></code></a></p></td>
<td><p>The amount of memory which is kept free as a temporary work space.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.free_memory_factor.html#cf.free_memory_factor" title="cf.free_memory_factor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.free_memory_factor</span></code></a></p></td>
<td><p>Set the fraction of memory kept free as a temporary workspace.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.hash_array.html#cf.hash_array" title="cf.hash_array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.hash_array</span></code></a></p></td>
<td><p>Return a hash value of a numpy array.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.min_total_memory.html#cf.min_total_memory" title="cf.min_total_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.min_total_memory</span></code></a></p></td>
<td><p>The minimum total memory across nodes.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.of_fraction.html#cf.of_fraction" title="cf.of_fraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.of_fraction</span></code></a></p></td>
<td><p>The amount of concurrently open files above which files containing data arrays may be automatically closed.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.open_files.html#cf.open_files" title="cf.open_files"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.open_files</span></code></a></p></td>
<td><p>Return the open files containing sub-arrays of master data arrays.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.open_files_threshold_exceeded.html#cf.open_files_threshold_exceeded" title="cf.open_files_threshold_exceeded"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.open_files_threshold_exceeded</span></code></a></p></td>
<td><p>Return True if the total number of open files is greater than the current threshold.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.relative_vorticity.html#cf.relative_vorticity" title="cf.relative_vorticity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.relative_vorticity</span></code></a></p></td>
<td><p>Calculate the relative vorticity using centred finite differences.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.set_performance.html#cf.set_performance" title="cf.set_performance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.set_performance</span></code></a></p></td>
<td><p>Tune performance of parallelisation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.COLLAPSE_PARALLEL_MODE.html#cf.COLLAPSE_PARALLEL_MODE" title="cf.COLLAPSE_PARALLEL_MODE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.COLLAPSE_PARALLEL_MODE</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.collapse_parallel_mode.html#cf.collapse_parallel_mode" title="cf.collapse_parallel_mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.collapse_parallel_mode</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.FM_THRESHOLD.html#cf.FM_THRESHOLD" title="cf.FM_THRESHOLD"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.FM_THRESHOLD</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.fm_threshold.html#cf.fm_threshold" title="cf.fm_threshold"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.fm_threshold</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.FREE_MEMORY_FACTOR.html#cf.FREE_MEMORY_FACTOR" title="cf.FREE_MEMORY_FACTOR"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.FREE_MEMORY_FACTOR</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.free_memory_factor.html#cf.free_memory_factor" title="cf.free_memory_factor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.free_memory_factor</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.MIN_TOTAL_MEMORY.html#cf.MIN_TOTAL_MEMORY" title="cf.MIN_TOTAL_MEMORY"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.MIN_TOTAL_MEMORY</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.min_total_memory.html#cf.min_total_memory" title="cf.min_total_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.min_total_memory</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="function/cf.OF_FRACTION.html#cf.OF_FRACTION" title="cf.OF_FRACTION"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.OF_FRACTION</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.of_fraction.html#cf.of_fraction" title="cf.of_fraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.of_fraction</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="function/cf.SET_PERFORMANCE.html#cf.SET_PERFORMANCE" title="cf.SET_PERFORMANCE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.SET_PERFORMANCE</span></code></a></p></td>
<td><p>Alias for <a class="reference internal" href="function/cf.set_performance.html#cf.set_performance" title="cf.set_performance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.set_performance</span></code></a>.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2026, NCAS | Page built on 2026-01-19.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
& <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
</div>
</body>
</html>