|
6 | 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
7 | 7 |
|
8 | 8 | <title>cf.read — Documentation</title> |
9 | | - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=61cd365c" /> |
| 9 | + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" /> |
10 | 10 | <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=a5d0ad34" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" /> |
12 | 12 | <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" /> |
|
15 | 15 | <script src="../_static/doctools.js?v=9a2dae69"></script> |
16 | 16 | <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> |
17 | 17 | <script src="../_static/clipboard.min.js?v=a7894cd8"></script> |
18 | | - <script src="../_static/copybutton.js?v=b578dfe4"></script> |
| 18 | + <script src="../_static/copybutton.js?v=a56c686a"></script> |
19 | 19 | <script src="../_static/toggleprompt.js?v=1b41717f"></script> |
20 | 20 | <link rel="icon" href="../_static/favicon.ico"/> |
21 | 21 | <link rel="index" title="Index" href="../genindex.html" /> |
@@ -952,14 +952,72 @@ <h1>cf.read<a class="headerlink" href="#cf-read" title="Link to this heading">¶ |
952 | 952 | <p><span class="versionmodified added">Added in version 3.15.0.</span></p> |
953 | 953 | </div> |
954 | 954 | </dd> |
| 955 | +<dt>cfa_write: (sequence of) <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional</dt><dd><p>Register the intention for named construct types to be |
| 956 | +subsequently written as CF-netCDF aggregation variables.</p> |
| 957 | +<p>This makes no difference to the logical content of any |
| 958 | +construct, but ensures that the data of each of specified |
| 959 | +construct types will have only one Dask chunk, regardless |
| 960 | +of the setting of <em>dask_chunks</em>, which is a requirement |
| 961 | +for the creation CF-netCDF aggregation variables.</p> |
| 962 | +<p>The <em>cfa_write</em> parameter may be one, or a sequence, of:</p> |
| 963 | +<table class="docutils align-default"> |
| 964 | +<thead> |
| 965 | +<tr class="row-odd"><th class="head"><p><em>cfa_write</em></p></th> |
| 966 | +<th class="head"><p>Construct types</p></th> |
| 967 | +</tr> |
| 968 | +</thead> |
| 969 | +<tbody> |
| 970 | +<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">'field'</span></code></p></td> |
| 971 | +<td><p>Field constructs</p></td> |
| 972 | +</tr> |
| 973 | +<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">'field_ancillary'</span></code></p></td> |
| 974 | +<td><p>Field ancillary constructs</p></td> |
| 975 | +</tr> |
| 976 | +<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">'domain_ancillary'</span></code></p></td> |
| 977 | +<td><p>Domain ancillary constructs</p></td> |
| 978 | +</tr> |
| 979 | +<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">'dimension_coordinate'</span></code></p></td> |
| 980 | +<td><p>Dimension coordinate constructs</p></td> |
| 981 | +</tr> |
| 982 | +<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">'auxiliary_coordinate'</span></code></p></td> |
| 983 | +<td><p>Auxiliary coordinate constructs</p></td> |
| 984 | +</tr> |
| 985 | +<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">'cell_measure'</span></code></p></td> |
| 986 | +<td><p>Cell measure constructs</p></td> |
| 987 | +</tr> |
| 988 | +<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">'domain_topology'</span></code></p></td> |
| 989 | +<td><p>Domain topology constructs</p></td> |
| 990 | +</tr> |
| 991 | +<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">'cell_connectivity'</span></code></p></td> |
| 992 | +<td><p>Cell connectivity constructs</p></td> |
| 993 | +</tr> |
| 994 | +<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">'all'</span></code></p></td> |
| 995 | +<td><p>All constructs</p></td> |
| 996 | +</tr> |
| 997 | +</tbody> |
| 998 | +</table> |
| 999 | +<div class="admonition note"> |
| 1000 | +<p class="admonition-title">Note</p> |
| 1001 | +<p>If the <em>dask_chunks</em> parameter is set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> |
| 1002 | +or <code class="docutils literal notranslate"><span class="pre">-1</span></code> then the data of all constructs will |
| 1003 | +already have only one Dask chunk, so in this |
| 1004 | +case setting <em>cfa_write</em> will have no further |
| 1005 | +effect.</p> |
| 1006 | +</div> |
| 1007 | +<dl class="simple"> |
| 1008 | +<dt><em>Example:</em></dt><dd><p>To register field constructs to be written as CF-netCDF |
| 1009 | +aggregation variables: <code class="docutils literal notranslate"><span class="pre">cfa_write='field'</span></code> or |
| 1010 | +<code class="docutils literal notranslate"><span class="pre">cfa_write=['field']</span></code>.</p> |
| 1011 | +</dd> |
| 1012 | +<dt><em>Example:</em></dt><dd><p>To register field and auxiliary coordinate constructs to |
| 1013 | +be written as CF-netCDF aggregation variables: |
| 1014 | +<code class="docutils literal notranslate"><span class="pre">cfa_write=['field',</span> <span class="pre">'auxiliary_coordinate']</span></code>.</p> |
| 1015 | +</dd> |
955 | 1016 | </dl> |
956 | | -<p>{{read cfa_write: sequence of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional}}</p> |
957 | | -<blockquote> |
958 | | -<div><div class="versionadded"> |
| 1017 | +<div class="versionadded"> |
959 | 1018 | <p><span class="versionmodified added">Added in version 3.17.0.</span></p> |
960 | 1019 | </div> |
961 | | -</div></blockquote> |
962 | | -<dl> |
| 1020 | +</dd> |
963 | 1021 | <dt>to_memory: (sequence of) <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional</dt><dd><p>Read all data arrays of the named construct types into |
964 | 1022 | memory. By default, lazy loading is employed for all data |
965 | 1023 | arrays.</p> |
@@ -1181,7 +1239,7 @@ <h1>cf.read<a class="headerlink" href="#cf-read" title="Link to this heading">¶ |
1181 | 1239 | <div class="clearer"></div> |
1182 | 1240 | </div> |
1183 | 1241 | <div class="footer"> |
1184 | | - ©2026, NCAS | Page built on 2026-07-07. |
| 1242 | + ©2026, NCAS | Page built on 2026-07-14. |
1185 | 1243 |
|
1186 | 1244 | | |
1187 | 1245 | Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a> |
|
0 commit comments