Skip to content

Commit

Permalink
Merge pull request #36 from NCAR/devel
Browse files Browse the repository at this point in the history
Many bugfixes.  Preparing for release.
  • Loading branch information
Kevin Paul authored Aug 30, 2017
2 parents e0dfe5e + d6c7e22 commit c09f5f5
Show file tree
Hide file tree
Showing 28 changed files with 131 additions and 281 deletions.
21 changes: 1 addition & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,11 @@ dependencies exist as a result of these direct dependencies.

The PyReshaper explicitly depends upon the following Python packages:

- PyNIO (v1.4.1+) or netCDF4-python (v1.2+)
- PyNIO (v1.5+) or netCDF4-python (v1.2+)
- ASAPPyTools (v0.4+)

These packages imply a dependency on the NumPy (v1.4+) and mpi4py (v1.3+)
packages, and the libraries NetCDF and MPI/MPI-2.

Additionally, the entire package is designed to work with Python v2.6 and up
to (but not including) Python v3.0. If using Python version 2.6, you will
need to install the ``ordereddict`` package, too.

The version requirements have not been rigidly tested, so earlier versions
may actually work. No version requirement is made during installation, though,
Expand Down Expand Up @@ -109,21 +105,6 @@ to install. To do this, type (on unix machines)::
This can be handy since the site-packages directory will be common for all
user installs, and therefore only needs to be added to the ``PYTHONPATH`` once.

To install the documentation, you must have Sphinx installed on your system.
Sphinx can be easily installed with pip, via::

$ pip install Sphinx
Once Sphinx is installed, you can build the PyReshaper HTML documentation
with::

$ cd docs
$ make html

The resulting HTML documentation will be placed in the docs/build/html
directory, and the main page can be loaded with any browser pointing to
'docs/build/html/index.html'.


Before Using the PyReshaper Package
-----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: cf6f811fe1dbcf7013ef1bca0aa0c35d
config: ef747d72177d13bdaa19f50fd2da8b28
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/license.doctree
Binary file not shown.
Binary file modified docs/.doctrees/manual.doctree
Binary file not shown.
Binary file modified docs/.doctrees/readme.doctree
Binary file not shown.
37 changes: 2 additions & 35 deletions docs/_sources/manual.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,11 @@ Requirements

The PyReshaper explicitly depends upon the following Python packages:

- PyNIO (v1.4.1+) or netCDF4-python (v1.2+)
- PyNIO (v1.5+) or netCDF4-python (v1.2+)
- ASAPPyTools (v0.4+)

These packages imply a dependency on the NumPy (v1.4+) and mpi4py (v1.3+)
packages, and the libraries NetCDF and MPI/MPI-2.

If using Python version 2.6, you will need to install the ``ordereddict``
package, too.
packages, and the libraries NetCDF and MPI/MPI-2.

No thorough testing has been done to show whether earlier versions of
these dependencies will work with the PyReshaper. The versions listed
Expand Down Expand Up @@ -60,36 +57,6 @@ will install the PyReshaper in the user's private workspace, as defined
by the system on which the user is installing. This is useful if you don't
have permissions to install system-wide software.

Generating the API Documentation
--------------------------------

If you are a developer, you may find the Sphinx API documentation helpful
in understanding the design and functionality of the PyReshaper code. To
generate this documentation, you must have Sphinx available and installed.
If you do, the API documentation can be easily generated with the following
command from the ``docs`` directory.

::

$ make html

The API documentation will be placed in the ``docs/build/html/`` directory.

Generating the User Documentation
---------------------------------

The ``README.rst`` file and this User Manual should be consulted for help
on installing and using the software. Both documents are included with
the source. The ``README.rst`` file is included with the top-level
PyReshaper directory, and the User Manual is contained in the
``docs/source/manual.rst`` file. Both files are reStructuredText formatted
files, meaning they are simple text files that can be read with any text
viewer.

An HTML version of the User Manual will automatically be created by
Sphinx, as described in the previous section. A link will be created
to the manual in the HTML documentation.

Before Using the PyReshaper
---------------------------

Expand Down
6 changes: 3 additions & 3 deletions docs/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>PyReshaper Change Log &mdash; PyReshaper 1.0.3 documentation</title>
<title>PyReshaper Change Log &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="index.html"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="index.html"/>
<link rel="next" title="Product License" href="license.html"/>
<link rel="prev" title="pyreshaper.iobackend module" href="iobackend.html"/>

Expand Down Expand Up @@ -375,7 +375,7 @@ <h2>VERSION 0.9.0<a class="headerlink" href="#version-0-9-0" title="Permalink to
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
6 changes: 3 additions & 3 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Index &mdash; PyReshaper 1.0.3 documentation</title>
<title>Index &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -36,7 +36,7 @@
<link rel="index" title="Index"
href="#"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="index.html"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="index.html"/>


<script src="_static/js/modernizr.min.js"></script>
Expand Down Expand Up @@ -391,7 +391,7 @@ <h2 id="W">W</h2>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Welcome to PyReshaper’s documentation! &mdash; PyReshaper 1.0.3 documentation</title>
<title>Welcome to PyReshaper’s documentation! &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="#"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="#"/>
<link rel="next" title="The PyReshaper" href="readme.html"/>


Expand Down Expand Up @@ -256,7 +256,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
6 changes: 3 additions & 3 deletions docs/iobackend.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>pyreshaper.iobackend module &mdash; PyReshaper 1.0.3 documentation</title>
<title>pyreshaper.iobackend module &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="index.html"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="index.html"/>
<link rel="up" title="The PyReshaper Package" href="pyreshaper.html"/>
<link rel="next" title="PyReshaper Change Log" href="changelog.html"/>
<link rel="prev" title="pyreshaper.reshaper module" href="reshaper.html"/>
Expand Down Expand Up @@ -365,7 +365,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
6 changes: 3 additions & 3 deletions docs/license.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Product License &mdash; PyReshaper 1.0.3 documentation</title>
<title>Product License &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="index.html"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="index.html"/>
<link rel="prev" title="PyReshaper Change Log" href="changelog.html"/>


Expand Down Expand Up @@ -261,7 +261,7 @@ <h3>Contributor License Agreement<a class="headerlink" href="#contributor-licens
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
39 changes: 5 additions & 34 deletions docs/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>The PyReshaper User’s Manual &mdash; PyReshaper 1.0.3 documentation</title>
<title>The PyReshaper User’s Manual &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="index.html"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="index.html"/>
<link rel="next" title="The PyReshaper Package" href="pyreshaper.html"/>
<link rel="prev" title="The PyReshaper" href="readme.html"/>

Expand Down Expand Up @@ -98,8 +98,6 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-install-it">How can I install it?</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#generating-the-api-documentation">Generating the API Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#generating-the-user-documentation">Generating the User Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#before-using-the-pyreshaper">Before Using the PyReshaper</a></li>
</ul>
</li>
Expand Down Expand Up @@ -204,13 +202,11 @@ <h2>What is it?<a class="headerlink" href="#what-is-it" title="Permalink to this
<h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h3>
<p>The PyReshaper explicitly depends upon the following Python packages:</p>
<ul class="simple">
<li>PyNIO (v1.4.1+) or netCDF4-python (v1.2+)</li>
<li>PyNIO (v1.5+) or netCDF4-python (v1.2+)</li>
<li>ASAPPyTools (v0.4+)</li>
</ul>
<p>These packages imply a dependency on the NumPy (v1.4+) and mpi4py (v1.3+)
packages, and the libraries NetCDF and MPI/MPI-2.</p>
<p>If using Python version 2.6, you will need to install the <code class="docutils literal"><span class="pre">ordereddict</span></code>
package, too.</p>
packages, and the libraries NetCDF and MPI/MPI-2.</p>
<p>No thorough testing has been done to show whether earlier versions of
these dependencies will work with the PyReshaper. The versions listed
have been shown to work, and it is assumed that later versions will
Expand Down Expand Up @@ -241,31 +237,6 @@ <h2>How can I install it?<a class="headerlink" href="#how-can-i-install-it" titl
will install the PyReshaper in the user’s private workspace, as defined
by the system on which the user is installing. This is useful if you don’t
have permissions to install system-wide software.</p>
<div class="section" id="generating-the-api-documentation">
<h3>Generating the API Documentation<a class="headerlink" href="#generating-the-api-documentation" title="Permalink to this headline"></a></h3>
<p>If you are a developer, you may find the Sphinx API documentation helpful
in understanding the design and functionality of the PyReshaper code. To
generate this documentation, you must have Sphinx available and installed.
If you do, the API documentation can be easily generated with the following
command from the <code class="docutils literal"><span class="pre">docs</span></code> directory.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ make html
</pre></div>
</div>
<p>The API documentation will be placed in the <code class="docutils literal"><span class="pre">docs/build/html/</span></code> directory.</p>
</div>
<div class="section" id="generating-the-user-documentation">
<h3>Generating the User Documentation<a class="headerlink" href="#generating-the-user-documentation" title="Permalink to this headline"></a></h3>
<p>The <code class="docutils literal"><span class="pre">README.rst</span></code> file and this User Manual should be consulted for help
on installing and using the software. Both documents are included with
the source. The <code class="docutils literal"><span class="pre">README.rst</span></code> file is included with the top-level
PyReshaper directory, and the User Manual is contained in the
<code class="docutils literal"><span class="pre">docs/source/manual.rst</span></code> file. Both files are reStructuredText formatted
files, meaning they are simple text files that can be read with any text
viewer.</p>
<p>An HTML version of the User Manual will automatically be created by
Sphinx, as described in the previous section. A link will be created
to the manual in the HTML documentation.</p>
</div>
<div class="section" id="before-using-the-pyreshaper">
<h3>Before Using the PyReshaper<a class="headerlink" href="#before-using-the-pyreshaper" title="Permalink to this headline"></a></h3>
<p>If you installed the PyReshaper using <code class="docutils literal"><span class="pre">pip</span></code>, then you should be ready to
Expand Down Expand Up @@ -854,7 +825,7 @@ <h4>I/O Nodes<a class="headerlink" href="#i-o-nodes" title="Permalink to this he
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
6 changes: 3 additions & 3 deletions docs/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Python Module Index &mdash; PyReshaper 1.0.3 documentation</title>
<title>Python Module Index &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="index.html"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="index.html"/>



Expand Down Expand Up @@ -227,7 +227,7 @@ <h1>Python Module Index</h1>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
6 changes: 3 additions & 3 deletions docs/pyreshaper.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>The PyReshaper Package &mdash; PyReshaper 1.0.3 documentation</title>
<title>The PyReshaper Package &mdash; PyReshaper 1.0.4 documentation</title>



Expand All @@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="PyReshaper 1.0.3 documentation" href="index.html"/>
<link rel="top" title="PyReshaper 1.0.4 documentation" href="index.html"/>
<link rel="next" title="pyreshaper.specification module" href="specification.html"/>
<link rel="prev" title="The PyReshaper User’s Manual" href="manual.html"/>

Expand Down Expand Up @@ -240,7 +240,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
Loading

0 comments on commit c09f5f5

Please sign in to comment.