Merge branch 'develop'

socib · Apr 15, 2014 · a8f1bd7 · a8f1bd7
2 parents 059ca75 + 6bed179
commit a8f1bd7
Show file tree

Hide file tree

Showing 41 changed files with 4,107 additions and 67 deletions.
diff --git a/README.rst b/README.rst
@@ -1,5 +1,5 @@
-NetCDF extended utils
-=====================
+NetCDF extended utils documentation
+===================================
 
 Description
 -----------
@@ -23,6 +23,10 @@ Install the requeriments::
   
 **Note**: Install numpy first because of the `issue #4116 <https://github.com/numpy/numpy/issues/4116/>`_.
 
+Download the NetCDF extended utils source code through the git repository:
+
+	`Git repository <https://github.com/socib/netcdf_extended_utils>`_.
+
 Install the NetCDF extended utils::
   
   python setup.py install

diff --git a/docs/README.rst b/docs/README.rst
@@ -0,0 +1 @@
+../README.rst
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -0,0 +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: 630246f6aa94fd8a41f4ece078bce23d
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/README.html b/docs/html/README.html
@@ -0,0 +1,164 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title>NetCDF extended utils documentation &mdash; NetCDF Extended Utils v0.1.0 documentation</title>
+
+    <link rel="stylesheet" href="_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     'v0.1.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="top" title="NetCDF Extended Utils v0.1.0 documentation" href="index.html" />
+    <link rel="next" title="netcdf_extended_utils package" href="netcdf_extended_utils.html" />
+    <link rel="prev" title="Welcome to Netcdf Extended Utils’s documentation!" href="index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="netcdf_extended_utils.html" title="netcdf_extended_utils package"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="index.html" title="Welcome to Netcdf Extended Utils’s documentation!"
+             accesskey="P">previous</a> |</li>
+        <li><a href="index.html">NetCDF Extended Utils v0.1.0 documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+
+  <div class="section" id="netcdf-extended-utils-documentation">
+<h1>NetCDF extended utils documentation<a class="headerlink" href="#netcdf-extended-utils-documentation" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<dl class="docutils">
+<dt>Extended netcdf utils to modify NetCDF files. Features:</dt>
+<dd><ul class="first last simple">
+<li>Modify and add new variable values</li>
+<li>Modify and add new global attributes</li>
+<li>Modify and add new variable attributes</li>
+<li>Delete global attributes, variables and dimensions</li>
+</ul>
+</dd>
+<dt>Limitations:</dt>
+<dd><ul class="first last simple">
+<li>Only tested with NetCDF3 classic format</li>
+<li>No support for groups.</li>
+</ul>
+</dd>
+</dl>
+</div>
+<div class="section" id="installation">
+<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
+<p>Install the requeriments:</p>
+<div class="highlight-python"><div class="highlight"><pre>pip install numpy&gt;=1.8.1 &amp;&amp; pip install -r requirements.txt
+</pre></div>
+</div>
+<p><strong>Note</strong>: Install numpy first because of the <a class="reference external" href="https://github.com/numpy/numpy/issues/4116/">issue #4116</a>.</p>
+<p>Download the NetCDF extended utils source code through the git repository:</p>
+<blockquote>
+<div><a class="reference external" href="https://github.com/socib/netcdf_extended_utils">Git repository</a>.</div></blockquote>
+<p>Install the NetCDF extended utils:</p>
+<div class="highlight-python"><div class="highlight"><pre>python setup.py install
+</pre></div>
+</div>
+</div>
+<div class="section" id="how-to">
+<h2>How to<a class="headerlink" href="#how-to" title="Permalink to this headline">¶</a></h2>
+<p>The <a class="reference external" href="https://github.com/socib/netcdf_extended_utils/tree/master/tests">tests</a> folder has some examples to test some features.</p>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">NetCDF extended utils documentation</a><ul>
+<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#installation">Installation</a></li>
+<li><a class="reference internal" href="#how-to">How to</a></li>
+</ul>
+</li>
+</ul>
+
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="index.html"
+                        title="previous chapter">Welcome to Netcdf Extended Utils&#8217;s documentation!</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="netcdf_extended_utils.html"
+                        title="next chapter">netcdf_extended_utils package</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="_sources/README.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="netcdf_extended_utils.html" title="netcdf_extended_utils package"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="index.html" title="Welcome to Netcdf Extended Utils’s documentation!"
+             >previous</a> |</li>
+        <li><a href="index.html">NetCDF Extended Utils v0.1.0 documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2014, Kristian Sebastian.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
+    </div>
+  </body>
+</html>
diff --git a/docs/html/_sources/README.txt b/docs/html/_sources/README.txt
@@ -0,0 +1,40 @@
+NetCDF extended utils documentation
+===================================
+
+Description
+-----------
+
+Extended netcdf utils to modify NetCDF files. Features:
+  - Modify and add new variable values
+  - Modify and add new global attributes
+  - Modify and add new variable attributes
+  - Delete global attributes, variables and dimensions
+
+Limitations:
+  - Only tested with NetCDF3 classic format
+  - No support for groups.
+
+Installation
+------------
+
+Install the requeriments::
+
+  pip install numpy>=1.8.1 && pip install -r requirements.txt
+
+**Note**: Install numpy first because of the `issue #4116 <https://github.com/numpy/numpy/issues/4116/>`_.
+
+Download the NetCDF extended utils source code through the git repository:
+
+	`Git repository <https://github.com/socib/netcdf_extended_utils>`_.
+
+Install the NetCDF extended utils::
+
+  python setup.py install
+
+How to
+------
+
+The `tests <https://github.com/socib/netcdf_extended_utils/tree/master/tests>`_ folder has some examples to test some features.
+
+
+
diff --git a/docs/html/_sources/index.txt b/docs/html/_sources/index.txt
@@ -0,0 +1,26 @@
+.. NetCDF Extended Utils documentation master file, created by
+   sphinx-quickstart on Mon Apr 14 10:26:02 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Netcdf Extended Utils's documentation!
+=================================================
+
+Contents:
+
+.. toctree::
+	:maxdepth: 2
+
+	README
+
+	netcdf_extended_utils
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
diff --git a/docs/html/_sources/netcdf_extended_utils.txt b/docs/html/_sources/netcdf_extended_utils.txt
@@ -0,0 +1,29 @@
+netcdf_extended_utils package
+=============================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    netcdf_extended_utils.utils
+
+Submodules
+----------
+
+netcdf_extended_utils.modification_tools module
+-----------------------------------------------
+
+.. automodule:: netcdf_extended_utils.modification_tools
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: netcdf_extended_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/html/_sources/netcdf_extended_utils.utils.txt b/docs/html/_sources/netcdf_extended_utils.utils.txt
@@ -0,0 +1,22 @@
+netcdf_extended_utils.utils package
+===================================
+
+Submodules
+----------
+
+netcdf_extended_utils.utils.d_type module
+-----------------------------------------
+
+.. automodule:: netcdf_extended_utils.utils.d_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: netcdf_extended_utils.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/html/_static/ajax-loader.gif b/docs/html/_static/ajax-loader.gif