PageRenderTime 27ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/0.9.2/build/write.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 220 lines | 211 code | 9 blank | 0 comment | 0 complexity | 351452f8d78b693e5f77c5e7211fb48a MD5 | raw file
    

  1. 

  2. 

  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    4. 

  4.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    5. 

  5. 

  6. <html xmlns="http://www.w3.org/1999/xhtml">
    7. 

  7.   <head>
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9. 

  9.     
    10. 

  10.     <title>cf.write &mdash; Python cf module v0.9.2 documentation</title>
    11. 

  11.     <link rel="stylesheet" href="_static/default.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    13. 

  13.     <script type="text/javascript">
    14. 

  14.       var DOCUMENTATION_OPTIONS = {
    15. 

  15.         URL_ROOT:    '',
    16. 

  16.         VERSION:     '0.9.2',
    17. 

  17.         COLLAPSE_INDEX: false,
    18. 

  18.         FILE_SUFFIX: '.html',
    19. 

  19.         HAS_SOURCE:  true
    20. 

  20.       };
    21. 

  21.     </script>
    22. 

  22.     <script type="text/javascript" src="_static/jquery.js"></script>
    23. 

  23.     <script type="text/javascript" src="_static/underscore.js"></script>
    24. 

  24.     <script type="text/javascript" src="_static/doctools.js"></script>
    25. 

  25.     <link rel="top" title="Python cf module v0.9.2 documentation" href="index.html" />
    26. 

  26.     <link rel="up" title="cf functions" href="function.html" />
    27. 

  27.     <link rel="next" title="cf classes" href="class.html" />
    28. 

  28.     <link rel="prev" title="cf.read1" href="read1.html" /> 
    29. 

  29.   </head>
    30. 

  30.   <body>
    31. 

  31.     <div class="related">
    32. 

  32.       <h3>Navigation</h3>
    33. 

  33.       <ul>
    34. 

  34.         <li class="right" style="margin-right: 10px">
    35. 

  35.           <a href="genindex.html" title="General Index"
    36. 

  36.              accesskey="I">index</a></li>
    37. 

  37.         <li class="right" >
    38. 

  38.           <a href="py-modindex.html" title="Python Module Index"
    39. 

  39.              >modules</a> |</li>
    40. 

  40.         <li class="right" >
    41. 

  41.           <a href="class.html" title="cf classes"
    42. 

  42.              accesskey="N">next</a> |</li>
    43. 

  43.         <li class="right" >
    44. 

  44.           <a href="read1.html" title="cf.read1"
    45. 

  45.              accesskey="P">previous</a> |</li>
    46. 

  46.         <li><a href="index.html">Python cf module v0.9.2 documentation</a> &raquo;</li>
    47. 

  47.           <li><a href="function.html" accesskey="U">cf functions</a> &raquo;</li> 
    48. 

  48.       </ul>
    49. 

  49.     </div>  
    50. 

  50. 

  51.     <div class="document">
    52. 

  52.       <div class="documentwrapper">
    53. 

  53.         <div class="bodywrapper">
    54. 

  54.           <div class="body">
    55. 

  55.             
    56. 

  56.   <div class="toctree-wrapper compound">
    57. 

  57. <ul class="simple">
    58. 

  58. </ul>
    59. 

  59. </div>
    60. 

  60. <div class="section" id="cf-write">
    61. 

  61. <span id="write"></span><h1>cf.write<a class="headerlink" href="#cf-write" title="Permalink to this headline"></a></h1>
    62. 

  62. <dl class="function">
    63. 

  63. <dt id="cf.write">
    64. 

  64. <tt class="descclassname">cf.</tt><tt class="descname">write</tt><big>(</big><em>spaces</em>, <em>file</em>, <em>format='NETCDF3_CLASSIC'</em>, <em>data=False</em>, <em>verbose=False</em>, <em>exact=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#cf.write" title="Permalink to this definition"></a></dt>
    65. 

  65. <dd><p>Write a space, or sequence of spaces, to a CF compliant netCDF
    66. 

  66. file.</p>
    67. 

  67. <p>NetCDF dimension and variable names will be taken from the
    68. 

  68. attributes <tt class="xref py py-attr docutils literal"><span class="pre">ncvar</span></tt> and <tt class="xref py py-attr docutils literal"><span class="pre">nc_dimensions</span></tt> if present,
    69. 

  69. otherwise they are inferred from standard_name attributes or set
    70. 

  70. to defaults. NetCDF names may be automatically given a numerical
    71. 

  71. suffix to avoid duplication.</p>
    72. 

  72. <p>Output netCDF file global attributes are those which occur in the
    73. 

  73. set of CF global attributes and non-standard data variable
    74. 

  74. attributes and which have equal values across all input spaces.</p>
    75. 

  75. <p>It is possible to write only a subset of the input spaces by
    76. 

  76. providing phenomena conditions with <tt class="xref py py-obj docutils literal"><span class="pre">**kwargs</span></tt> parameters.</p>
    77. 

  77. <p>It does not matter if an input space&#8217;s data has not yet been read
    78. 

  78. into memory. The write operation will automatically read the data
    79. 

  79. array from disk if required, but the default is for it not to be
    80. 

  80. saved in the input space if it had to be read during the write
    81. 

  81. operation. However, if the <tt class="xref py py-obj docutils literal"><span class="pre">data</span></tt> argument equals True then any
    82. 

  82. input spaces which didn&#8217;t contain their full data arrays in memory
    83. 

  83. will be changed in place so that they do. For example, for a
    84. 

  84. space, s:</p>
    85. 

  85. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">type</span>
    86. 

  86. <span class="go">    &lt;type &#39;netCDF4.Variable&#39;&gt;</span>
    87. 

  87. <span class="gp">&gt;&gt;&gt; </span><span class="n">write</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="s">&#39;filename&#39;</span><span class="p">)</span>
    88. 

  88. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">type</span>
    89. 

  89. <span class="go">    &lt;type &#39;netCDF4.Variable&#39;&gt;</span>
    90. 

  90. <span class="gp">&gt;&gt;&gt; </span><span class="n">write</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="s">&#39;filename&#39;</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    91. 

  91. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">type</span>
    92. 

  92. <span class="go">    &lt;type &#39;numpy.ndarray&#39;&gt;</span>
    93. 

  93. </pre></div>
    94. 

  94. </div>
    95. 

  95. <p>Identical grid components (as determined by their numerically
    96. 

  96. tolerant <tt class="xref py py-meth docutils literal"><span class="pre">equals()</span></tt> methods) are only written to the file
    97. 

  97. once, apart from when they need to fulfil both dimension
    98. 

  98. coordinate and auxiliary coordinate roles for different data
    99. 

  99. variables.</p>
    100. 

  100. <p>If a coordinate with a <tt class="xref py py-attr docutils literal"><span class="pre">transform</span></tt> attribute is fully specified by
    101. 

  101. another coordinate&#8217;s transformation then it will be not written to
    102. 

  102. the file.</p>
    103. 

  103. <table class="docutils field-list" frame="void" rules="none">
    104. 

  104. <col class="field-name" />
    105. 

  105. <col class="field-body" />
    106. 

  106. <tbody valign="top">
    107. 

  107. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    108. 

  108. <li><strong>spaces</strong> (<em>Space or sequence of spaces</em>) &#8211; The space or spaces to write to the file. If
    109. 

  109. <tt class="xref py py-obj docutils literal"><span class="pre">**kwargs</span></tt> are set for selection by
    110. 

  110. phenomena then some spaces may not be written.</li>
    111. 

  111. <li><strong>file</strong> (<em>str</em>) &#8211; The netCDF file to write spaces to.</li>
    112. 

  112. <li><strong>data</strong> (<em>bool</em>) &#8211; <em>Optional</em>. If True then ensure that spaces which
    113. 

  113. have been written to disk retain their data
    114. 

  114. in-place as numpy arrays.</li>
    115. 

  115. <li><strong>exact</strong> (<em>bool</em>) &#8211; <em>Optional</em>. If True then interpret the keywords
    116. 

  116. from <tt class="xref py py-obj docutils literal"><span class="pre">**kwargs</span></tt> as exact phenomenon
    117. 

  117. names. Refer to <a class="reference internal" href="Space.html#cf.Space.extract" title="cf.Space.extract"><tt class="xref py py-meth docutils literal"><span class="pre">cf.Space.extract()</span></tt></a> for
    118. 

  118. details.</li>
    119. 

  119. <li><strong>format</strong> (<em>str</em>) &#8211; <em>Optional</em>. The format of the output netCDF
    120. 

  120. file. Valid formats are those supported by the
    121. 

  121. netCDF4 module: &#8220;NETCDF3_CLASSIC&#8221;,
    122. 

  122. &#8220;NETCDF3_64BIT&#8221;, &#8220;NETCDF4_CLASSIC&#8221; and
    123. 

  123. &#8220;NETCDF4&#8221;. The default is
    124. 

  124. &#8220;NETCDF3_CLASSIC&#8221;. Certain write operations may
    125. 

  125. be considerably faster using &#8220;NETCDF4_CLASSIC&#8221;.</li>
    126. 

  126. <li><strong>verbose</strong> (<em>bool</em>) &#8211; <em>Optional</em>. If True then print information to
    127. 

  127. stdout.</li>
    128. 

  128. <li><strong>**kwargs</strong> &#8211; <p><em>Optional</em>. Other keyword arguments defining
    129. 

  129. space selection based on phenomena
    130. 

  130. criteria. Only selected spaces will be
    131. 

  131. written to disk. If none are set then all
    132. 

  132. spaces are selected. Keywords and their
    133. 

  133. arguments are set as for
    134. 

  134. <a class="reference internal" href="Space.html#cf.Space.extract" title="cf.Space.extract"><tt class="xref py py-meth docutils literal"><span class="pre">cf.Space.extract()</span></tt></a>. This behaviour is
    135. 

  135. modified by the <tt class="xref py py-obj docutils literal"><span class="pre">exact</span></tt> keyword.</p>
    136. 

  136. </li>
    137. 

  137. </ul>
    138. 

  138. </td>
    139. 

  139. </tr>
    140. 

  140. </tbody>
    141. 

  141. </table>
    142. 

  142. <p><strong>Examples</strong></p>
    143. 

  143. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span>
    144. 

  144. <span class="go">[&lt;CF Space: air_pressure(30, 24)&gt;,</span>
    145. 

  145. <span class="go"> &lt;CF Space: u_compnt_of_wind(19, 29, 24)&gt;,</span>
    146. 

  146. <span class="go"> &lt;CF Space: v_compnt_of_wind(19, 29, 24)&gt;,</span>
    147. 

  147. <span class="go"> &lt;CF Space: potential_temperature(19, 30, 24)&gt;]</span>
    148. 

  148. <span class="gp">&gt;&gt;&gt; </span><span class="n">write</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="s">&#39;file&#39;</span><span class="p">)</span>
    149. 

  149. <span class="gp">&gt;&gt;&gt; </span><span class="n">write</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="s">&#39;file&#39;</span><span class="p">,</span> <span class="n">standard_name</span> <span class="o">=</span> <span class="s">&#39;air_pressure&#39;</span><span class="p">)</span>
    150. 

  150. </pre></div>
    151. 

  151. </div>
    152. 

  152. <div class="admonition-see-also admonition seealso">
    153. 

  153. <p class="first admonition-title">See also</p>
    154. 

  154. <p class="last"><a class="reference internal" href="Space.html#cf.Space.extract" title="cf.Space.extract"><tt class="xref py py-meth docutils literal"><span class="pre">cf.Space.extract()</span></tt></a> for more examples of space
    155. 

  155. selection by phenomena criteria.</p>
    156. 

  156. </div>
    157. 

  157. </dd></dl>
    158. 

  158. 

  159. </div>
    160. 

  160. 

  161. 

  162.           </div>
    163. 

  163.         </div>
    164. 

  164.       </div>
    165. 

  165.       <div class="sphinxsidebar">
    166. 

  166.         <div class="sphinxsidebarwrapper">
    167. 

  167.   <h4>Previous topic</h4>
    168. 

  168.   <p class="topless"><a href="read1.html"
    169. 

  169.                         title="previous chapter">cf.read1</a></p>
    170. 

  170.   <h4>Next topic</h4>
    171. 

  171.   <p class="topless"><a href="class.html"
    172. 

  172.                         title="next chapter">cf classes</a></p>
    173. 

  173.   <h3>This Page</h3>
    174. 

  174.   <ul class="this-page-menu">
    175. 

  175.     <li><a href="_sources/write.txt"
    176. 

  176.            rel="nofollow">Show Source</a></li>
    177. 

  177.   </ul>
    178. 

  178. <div id="searchbox" style="display: none">
    179. 

  179.   <h3>Quick search</h3>
    180. 

  180.     <form class="search" action="search.html" method="get">
    181. 

  181.       <input type="text" name="q" size="18" />
    182. 

  182.       <input type="submit" value="Go" />
    183. 

  183.       <input type="hidden" name="check_keywords" value="yes" />
    184. 

  184.       <input type="hidden" name="area" value="default" />
    185. 

  185.     </form>
    186. 

  186.     <p class="searchtip" style="font-size: 90%">
    187. 

  187.     Enter search terms or a module, class or function name.
    188. 

  188.     </p>
    189. 

  189. </div>
    190. 

  190. <script type="text/javascript">$('#searchbox').show(0);</script>
    191. 

  191.         </div>
    192. 

  192.       </div>
    193. 

  193.       <div class="clearer"></div>
    194. 

  194.     </div>
    195. 

  195.     <div class="related">
    196. 

  196.       <h3>Navigation</h3>
    197. 

  197.       <ul>
    198. 

  198.         <li class="right" style="margin-right: 10px">
    199. 

  199.           <a href="genindex.html" title="General Index"
    200. 

  200.              >index</a></li>
    201. 

  201.         <li class="right" >
    202. 

  202.           <a href="py-modindex.html" title="Python Module Index"
    203. 

  203.              >modules</a> |</li>
    204. 

  204.         <li class="right" >
    205. 

  205.           <a href="class.html" title="cf classes"
    206. 

  206.              >next</a> |</li>
    207. 

  207.         <li class="right" >
    208. 

  208.           <a href="read1.html" title="cf.read1"
    209. 

  209.              >previous</a> |</li>
    210. 

  210.         <li><a href="index.html">Python cf module v0.9.2 documentation</a> &raquo;</li>
    211. 

  211.           <li><a href="function.html" >cf functions</a> &raquo;</li> 
    212. 

  212.       </ul>
    213. 

  213.     </div>
    214. 

  214.     <div class="footer">
    215. 

  215.         &copy; Copyright 2011, David Hassell.
    216. 

  216.       Last updated on Aug 26, 2011.
    217. 

  217.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    218. 

  218.     </div>
    219. 

  219.   </body>
    220. 

  220. </html>
    221.