-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
20d1fff
commit 82a1a2d
Showing
26 changed files
with
275 additions
and
17 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| ================ | ||
| Functions | ||
| ================ | ||
|
|
||
| .. autofunction:: pncpy::strerror | ||
| .. autofunction:: pncpy::strerrno | ||
| .. autofunction:: pncpy::chartostring | ||
| .. autofunction:: pncpy::stringtochar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" > | ||
| <head> | ||
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Functions — PnetCDF Python 0.0.1 documentation</title> | ||
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | ||
| <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> | ||
| <!--[if lt IE 9]> | ||
| <script src="../_static/js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
| <script src="../_static/jquery.js"></script> | ||
| <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> | ||
| <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> | ||
| <script src="../_static/doctools.js"></script> | ||
| <script src="../_static/sphinx_highlight.js"></script> | ||
| <script src="../_static/js/theme.js"></script> | ||
| <link rel="index" title="Index" href="../genindex.html" /> | ||
| <link rel="search" title="Search" href="../search.html" /> | ||
| <link rel="prev" title="Variable" href="variable_api.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"> | ||
| PnetCDF Python | ||
| </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"> | ||
| <p class="caption" role="heading"><span class="caption-text">Introduction</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Overview</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Installation</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../installation/install.html">Install from Source</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Tutorial</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../tutorial/basic.html">Basics</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../tutorial/datatypes.html">Datatype</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../tutorial/read_write.html">Parallel Read and Write</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../tutorial/non_blocking.html">Non-blocking Reads and Writes</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p> | ||
| <ul class="current"> | ||
| <li class="toctree-l1"><a class="reference internal" href="file_api.html">File</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="dimension_api.html">Dimension</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="variable_api.html">Variable</a></li> | ||
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Functions</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="#pncpy.strerror"><code class="docutils literal notranslate"><span class="pre">strerror()</span></code></a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#pncpy.strerrno"><code class="docutils literal notranslate"><span class="pre">strerrno()</span></code></a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#pncpy.chartostring"><code class="docutils literal notranslate"><span class="pre">chartostring()</span></code></a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#pncpy.stringtochar"><code class="docutils literal notranslate"><span class="pre">stringtochar()</span></code></a></li> | ||
| </ul> | ||
| </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">PnetCDF Python</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 active">Functions</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="../_sources/api/function_api.rst.txt" rel="nofollow"> View page source</a> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <section id="functions"> | ||
| <h1>Functions<a class="headerlink" href="#functions" title="Permalink to this heading"></a></h1> | ||
| <dl class="py function"> | ||
| <dt class="sig sig-object py" id="pncpy.strerror"> | ||
| <span class="sig-prename descclassname"><span class="pre">pncpy.</span></span><span class="sig-name descname"><span class="pre">strerror</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pncpy.strerror" title="Permalink to this definition"></a></dt> | ||
| <dd></dd></dl> | ||
|
|
||
| <dl class="py function"> | ||
| <dt class="sig sig-object py" id="pncpy.strerrno"> | ||
| <span class="sig-prename descclassname"><span class="pre">pncpy.</span></span><span class="sig-name descname"><span class="pre">strerrno</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pncpy.strerrno" title="Permalink to this definition"></a></dt> | ||
| <dd></dd></dl> | ||
|
|
||
| <dl class="py function"> | ||
| <dt class="sig sig-object py" id="pncpy.chartostring"> | ||
| <span class="sig-prename descclassname"><span class="pre">pncpy.</span></span><span class="sig-name descname"><span class="pre">chartostring</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pncpy.chartostring" title="Permalink to this definition"></a></dt> | ||
| <dd><p><strong>`chartostring(b,encoding=’utf-8’)`</strong></p> | ||
| <p>convert a character array to a string array with one less dimension.</p> | ||
| <p><strong>`b`</strong>: Input character array (numpy datatype <cite>‘S1’</cite> or <cite>‘U1’</cite>). | ||
| Will be converted to a array of strings, where each string has a fixed | ||
| length of <cite>b.shape[-1]</cite> characters.</p> | ||
| <p>optional kwarg <cite>encoding</cite> can be used to specify character encoding (default | ||
| <cite>utf-8</cite>). If <cite>encoding</cite> is ‘none’ or ‘bytes’, a <cite>np.string_</cite> btye array is | ||
| returned.</p> | ||
| <p>returns a numpy string array with datatype <cite>‘UN’</cite> (or <cite>‘SN’</cite>) and shape | ||
| <cite>b.shape[:-1]</cite> where where <cite>N=b.shape[-1]</cite>.</p> | ||
| </dd></dl> | ||
|
|
||
| <dl class="py function"> | ||
| <dt class="sig sig-object py" id="pncpy.stringtochar"> | ||
| <span class="sig-prename descclassname"><span class="pre">pncpy.</span></span><span class="sig-name descname"><span class="pre">stringtochar</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pncpy.stringtochar" title="Permalink to this definition"></a></dt> | ||
| <dd><p><strong>`stringtochar(a,encoding=’utf-8’)`</strong></p> | ||
| <p>convert a string array to a character array with one extra dimension</p> | ||
| <p><strong>`a`</strong>: Input numpy string array with numpy datatype <cite>‘SN’</cite> or <cite>‘UN’</cite>, where N | ||
| is the number of characters in each string. Will be converted to | ||
| an array of characters (datatype <cite>‘S1’</cite> or <cite>‘U1’</cite>) of shape <cite>a.shape + (N,)</cite>.</p> | ||
| <p>optional kwarg <cite>encoding</cite> can be used to specify character encoding (default | ||
| <cite>utf-8</cite>). If <cite>encoding</cite> is ‘none’ or ‘bytes’, a <cite>numpy.string_</cite> the input array | ||
| is treated a raw byte strings (<cite>numpy.string_</cite>).</p> | ||
| <p>returns a numpy character array with datatype <cite>‘S1’</cite> or <cite>‘U1’</cite> | ||
| and shape <cite>a.shape + (N,)</cite>, where N is the length of each string in a.</p> | ||
| </dd></dl> | ||
|
|
||
| </section> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | ||
| <a href="variable_api.html" class="btn btn-neutral float-left" title="Variable" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright 2023, CUCIS.</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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.