Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)

documentation/Sphinx/build/html/_sources/user_guide/control_templates.rst.txt

+CONTROL-file templates
+======================
+
+   UNDER CONSTRUCTION
\ No newline at end of file

documentation/Sphinx/build/html/_sources/user_guide/how_to.rst.txt

+How to use flex_extract
+=======================
+
+   UNDER CONSTRUCTION
\ No newline at end of file

documentation/Sphinx/build/html/downloads.html

@@ -28,8 +28,8 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Installation" href="installation.html" />
-    <link rel="prev" title="Welcome to flex_extract’s documentation!" href="index.html" /> 
+    <link rel="next" title="Download tar-balls" href="downloads/tar_balls.html" />
+    <link rel="prev" title="Welcome to flex_extract’s user documentation!" href="index.html" /> 
 
   
   <script src="_static/js/modernizr.min.js"></script>
@@ -84,7 +84,12 @@
             
               <p class="caption"><span class="caption-text">Table of Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Downloads</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Downloads</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="downloads/tar_balls.html">Download tar-balls</a></li>
+<li class="toctree-l2"><a class="reference internal" href="downloads/git_repo.html">Git Repository</a></li>
+<li class="toctree-l2"><a class="reference internal" href="downloads/history_changes.html">History of Changes</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
@@ -159,6 +164,8 @@
 <p>Describe download options of flex_extract ….</p>
 <blockquote>
 <div>UNDER CONSTRUCTION</div></blockquote>
+<div class="toctree-wrapper compound">
+</div>
 </div>
 
 
@@ -169,10 +176,10 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="downloads/tar_balls.html" class="btn btn-neutral float-right" title="Download tar-balls" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="index.html" class="btn btn-neutral" title="Welcome to flex_extract’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="index.html" class="btn btn-neutral" title="Welcome to flex_extract’s user documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

documentation/Sphinx/build/html/index.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Welcome to flex_extract’s documentation! &mdash; flex_extract 7.1 alpha documentation</title>
+  <title>Welcome to flex_extract’s user documentation! &mdash; flex_extract 7.1 alpha documentation</title>
   
 
   
@@ -134,7 +134,7 @@
     
       <li><a href="#">Docs</a> &raquo;</li>
         
-      <li>Welcome to flex_extract’s documentation!</li>
+      <li>Welcome to flex_extract’s user documentation!</li>
     
     
       <li class="wy-breadcrumbs-aside">
@@ -153,8 +153,10 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
             
-  <div class="section" id="welcome-to-flex-extract-s-documentation">
-<h1>Welcome to flex_extract’s documentation!<a class="headerlink" href="#welcome-to-flex-extract-s-documentation" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="welcome-to-flex-extract-s-user-documentation">
+<h1>Welcome to flex_extract’s user documentation!<a class="headerlink" href="#welcome-to-flex-extract-s-user-documentation" title="Permalink to this headline">¶</a></h1>
+<p>flex_extract is a software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to server as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system.</p>
+<p>All required second party software and libraries used within flex_extract is open source and free of charge.</p>
 <table style="width:100%;">
   <tr>
     <td style="width:200px;height:150px;">
@@ -238,7 +240,29 @@
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api.html#porgrams">Porgrams</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-install">install</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-submit">submit</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="api.html#classes">Classes</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-ControlFile">ControlFile</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-EcFlexpart">EcFlexpart</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-GribTools">GribTools</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-MarsRetrieval">MarsRetrieval</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-UioFiles">UioFiles</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="api.html#modules">Modules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-get_mars_data">get_mars_data</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-prepare_flexpart">prepare_flexpart</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-tools">tools</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-disaggregation">disaggregation</a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
 </ul>
 </div>

documentation/Sphinx/build/html/installation.html

@@ -28,8 +28,8 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Usage" href="usage.html" />
-    <link rel="prev" title="Requirements" href="requirements.html" /> 
+    <link rel="next" title="Requirements" href="installation/requirements.html" />
+    <link rel="prev" title="Downloads" href="downloads.html" /> 
 
   
   <script src="_static/js/modernizr.min.js"></script>
@@ -82,12 +82,19 @@
               
             
             
-              <p class="caption"><span class="caption-text">Contents:</span></p>
+              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="requirements.html">Requirements</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="API.html">Auto Generated Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation/requirements.html">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/oper_modes.html">Operating modes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/test_install.html">Installation test</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
 </ul>
 
             
@@ -154,9 +161,10 @@
             
   <div class="section" id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
-<p>Describe installation process flex_extract ….</p>
 <blockquote>
 <div>UNDER CONSTRUCTION</div></blockquote>
+<div class="toctree-wrapper compound">
+</div>
 </div>
 
 
@@ -167,10 +175,10 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="usage.html" class="btn btn-neutral float-right" title="Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="installation/requirements.html" class="btn btn-neutral float-right" title="Requirements" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="requirements.html" class="btn btn-neutral" title="Requirements" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="downloads.html" class="btn btn-neutral" title="Downloads" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

documentation/Sphinx/build/html/program_structure.html

@@ -28,8 +28,8 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="User Guide" href="user_guide.html" />
-    <link rel="prev" title="Installation" href="installation.html" /> 
+    <link rel="next" title="Program Overview" href="program_structure/prog_overview.html" />
+    <link rel="prev" title="Installation test" href="installation/test_install.html" /> 
 
   
   <script src="_static/js/modernizr.min.js"></script>
@@ -86,7 +86,12 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Program Structure</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Program Structure</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="program_structure/prog_overview.html">Program Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="program_structure/prog_components.html">Program Components</a></li>
+<li class="toctree-l2"><a class="reference internal" href="program_structure/prog_flow.html">Program Flow</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
@@ -159,6 +164,8 @@
 <p>Describe structure of flex_extract ….</p>
 <blockquote>
 <div>UNDER CONSTRUCTION</div></blockquote>
+<div class="toctree-wrapper compound">
+</div>
 </div>
 
 
@@ -169,10 +176,10 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="user_guide.html" class="btn btn-neutral float-right" title="User Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="program_structure/prog_overview.html" class="btn btn-neutral float-right" title="Program Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="installation.html" class="btn btn-neutral" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="installation/test_install.html" class="btn btn-neutral" title="Installation test" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>