-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathapi_reference.html
More file actions
198 lines (160 loc) · 10.3 KB
/
api_reference.html
File metadata and controls
198 lines (160 loc) · 10.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
<!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>API reference — 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 functions" href="function.html" />
<link rel="prev" title="Tutorial" href="tutorial.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="current reference internal" href="#"><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>Previous: <a href="tutorial.html" title="previous chapter"><strong>Tutorial</strong></a></li>
<li>Next: <a href="function.html" title="next chapter"><strong>cf functions</strong></a></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="api-reference">
<h1><strong>API reference</strong><a class="headerlink" href="#api-reference" title="Link to this heading">¶</a></h1>
<hr class="docutils" />
<p>Version 3.19.0 for version 1.13 of the CF conventions.</p>
<ul class="simple">
<li><p><strong>Construct classes</strong></p>
<ul>
<li><p><a class="reference internal" href="class/cf.Field.html#cf-field"><span class="std std-ref">cf.Field</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.Domain.html#cf-domain"><span class="std std-ref">cf.Domain</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.AuxiliaryCoordinate.html#cf-auxiliarycoordinate"><span class="std std-ref">cf.AuxiliaryCoordinate</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.CellMeasure.html#cf-cellmeasure"><span class="std std-ref">cf.CellMeasure</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.CellMethod.html#cf-cellmethod"><span class="std std-ref">cf.CellMethod</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.CoordinateReference.html#cf-coordinatereference"><span class="std std-ref">cf.CoordinateReference</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.DimensionCoordinate.html#cf-dimensioncoordinate"><span class="std std-ref">cf.DimensionCoordinate</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.DomainAncillary.html#cf-domainancillary"><span class="std std-ref">cf.DomainAncillary</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.DomainAxis.html#cf-domainaxis"><span class="std std-ref">cf.DomainAxis</span></a></p></li>
<li><p><a class="reference internal" href="class/cf.FieldAncillary.html#cf-fieldancillary"><span class="std std-ref">cf.FieldAncillary</span></a></p></li>
</ul>
</li>
</ul>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="function.html"><strong>cf functions</strong></a><ul>
<li class="toctree-l2"><a class="reference internal" href="function.html#reading-and-writing">Reading and writing</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#aggregation">Aggregation</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#mathematical-operations">Mathematical operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#condition-constructors">Condition constructors</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#date-time-and-time-duration">Date-time and time duration</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#resource-management">Resource management</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#active-storage-reductions">Active storage reductions</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#miscellaneous">Miscellaneous</a></li>
<li class="toctree-l2"><a class="reference internal" href="function.html#deprecated">Deprecated</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="class.html"><strong>cf classes</strong></a><ul>
<li class="toctree-l2"><a class="reference internal" href="class.html#field-construct-class">Field construct class</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#field-list-class">Field list class</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#domain-class">Domain class</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#metadata-component-classes">Metadata component classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#constructs-class">Constructs class</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#coordinate-component-classes">Coordinate component classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#data-classes">Data classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#data-compression-classes">Data compression classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#data-ugrid-classes">Data UGRID classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="class.html#miscellaneous-classes">Miscellaneous classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="constant.html"><strong>cf constants</strong></a><ul>
<li class="toctree-l2"><a class="reference internal" href="constant.html#cf.cf.masked"><code class="docutils literal notranslate"><span class="pre">cf.masked</span></code></a></li>
</ul>
</li>
</ul>
</div>
</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>