Merge pull request #3 from ThibHlln/release-0.1.0

Release v0.1.0
ThibHlln · Apr 22, 2021 · 09cb01b · 09cb01b
2 parents fc1e8a3 + 06fa909
commit 09cb01b
Show file tree

Hide file tree

Showing 33 changed files with 498 additions and 240 deletions.
diff --git a/README.rst b/README.rst
@@ -1,18 +1,18 @@
 An evaluator for streamflow time series in Python
 -------------------------------------------------
 
+.. image:: https://img.shields.io/pypi/v/hydroeval?color=blue
+   :target: https://pypi.python.org/pypi/hydroeval
+   :alt: PyPI Version
+.. image:: https://zenodo.org/badge/145855846.svg
+   :target: https://zenodo.org/badge/latestdoi/145855846
+   :alt: DOI
 .. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
    :target: https://www.gnu.org/licenses/gpl-3.0
    :alt: License: GPL v3
-.. image:: https://badge.fury.io/py/hydroeval.svg
-   :target: https://pypi.python.org/pypi/hydroeval
-   :alt: PyPI Version
 .. image:: https://img.shields.io/github/workflow/status/ThibHlln/hydroeval/Tests?label=tests
    :target: https://github.com/ThibHlln/hydroeval/actions/workflows/tests.yml
    :alt: GitHub Actions Test Workflow Status
-.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2591217.svg
-   :target: https://doi.org/10.5281/zenodo.2591217
-   :alt: DOI
 
 `hydroeval` is an open-source `evaluator` of goodness of fit between
 simulated and observed streamflow time series in Python. It is licensed

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -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: ffbe15af4a9c0ff5e8902a28bb0bbeeb
+config: 57a0264e7c3e26cad70b1ecad3449c7f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_doc_src/conf.py b/docs/_doc_src/conf.py
@@ -180,14 +180,18 @@
     (tag.name,
      os.sep.join([html_theme_options['canonical_url'],
                   tag.name if tag.name != 'v{}'.format(version) else '']))
-    for tag in repo.tags if tag.name >= 'v0.0.3'
+    for tag in repo.tags if tag.name >= 'v0.1.0'
 ]
 html_context = {
     'current_version': version,
     'versions': versions,
     'show_versions': True if versions else False,
     'links': [
-        ('<span class="fa fa-github"> GitHub Repository', remote_url)
+        ('<span class="fa fa-code"> Source Code', remote_url),
+        ('<span class="fa fa-bug"> Issue Tracker',
+         os.sep.join([remote_url.replace('.git', ''), 'issues'])),
+        ('<span class="fa fa-users"> User Support',
+         os.sep.join([remote_url.replace('.git', ''), 'discussions']))
     ]
 }
 

diff --git a/docs/_doc_src/index.rst b/docs/_doc_src/index.rst
@@ -12,5 +12,6 @@
    installation
    api_reference
    tutorial
+   support
    genindex
    licence
diff --git a/docs/_doc_src/support.rst b/docs/_doc_src/support.rst
@@ -0,0 +1,12 @@
+.. currentmodule:: hydroeval
+.. default-role:: obj
+
+Support
+=======
+
+Support for users is available through `GitHub Discussions
+<https://github.com/ThibHlln/hydroeval/discussions>`_. Use this support
+page to find answers to previously asked questions, to ask questions
+of your own, and to suggest ideas to improve `hydroeval`.
+
+To report bugs, please use `GitHub Issues <https://github.com/ThibHlln/hydroeval/issues>`_.
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -12,5 +12,6 @@
    installation
    api_reference
    tutorial
+   support
    genindex
    licence
diff --git a/docs/_sources/support.rst.txt b/docs/_sources/support.rst.txt
@@ -0,0 +1,12 @@
+.. currentmodule:: hydroeval
+.. default-role:: obj
+
+Support
+=======
+
+Support for users is available through `GitHub Discussions
+<https://github.com/ThibHlln/hydroeval/discussions>`_. Use this support
+page to find answers to previously asked questions, to ask questions
+of your own, and to suggest ideas to improve `hydroeval`.
+
+To report bugs, please use `GitHub Issues <https://github.com/ThibHlln/hydroeval/issues>`_.
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.0.3',
+    VERSION: '0.1.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_static/theme_overrides.css b/docs/_static/theme_overrides.css
@@ -69,7 +69,6 @@
    white-space:nowrap
 }
 
-
 /* override style class and attributes */
 html.writer-html4 .rst-content dl:not(.docutils)>dt,
 html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt {
@@ -91,9 +90,6 @@ html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(
 
 html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,
 html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt {
-	/* background: #FAF0E6; */
-	/* color: #ab7842; */
-	/* border-left: 3px solid #DEA66A; */
     padding-left: 6px;
 	font-weight:400
 }
diff --git a/docs/api_reference.html b/docs/api_reference.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>API Reference &mdash; hydroeval 0.0.3 documentation</title>
+  <title>API Reference &mdash; hydroeval 0.1.0 documentation</title>
 
 
 
@@ -67,7 +67,7 @@
 
 
               <div class="version">
-                0.0.3
+                0.1.0
               </div>
 
 
@@ -100,6 +100,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
 <li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
 </ul>
@@ -236,7 +237,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 
         &copy; Copyright 2021, Thibault Hallouin.
       <span class="lastupdated">
-        Last updated on Mar 28, 2021.
+        Last updated on Apr 22, 2021.
       </span>
 
     </p>
@@ -265,23 +266,20 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
     <span class="fa fa-archive"> hydroeval</span>
   </div>
   <div style="float:right;">
-    v: 0.0.3
+    v: 0.1.0
     <span class="fa fa-caret-down"></span>
   </div>
 </span>
 <div class="rst-other-versions">
 
   <dl>
-    <dt>Versions</dt>
+    <dt>External Links</dt>
 
-      <dd><a href="https://thibhlln.github.io/hydroeval/">v0.0.3</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-code"> Source Code</a></dd>
 
-  </dl>
-
-  <dl>
-    <dt>External Links</dt>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/issues"><span class="fa fa-bug"> Issue Tracker</a></dd>
 
-      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-github"> GitHub Repository</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/discussions"><span class="fa fa-users"> User Support</a></dd>
 
   </dl>
 

diff --git a/docs/functions/hydroeval.evaluator.html b/docs/functions/hydroeval.evaluator.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Evaluator &mdash; hydroeval 0.0.3 documentation</title>
+  <title>Evaluator &mdash; hydroeval 0.1.0 documentation</title>
 
 
 
@@ -67,7 +67,7 @@
 
 
               <div class="version">
-                0.0.3
+                0.1.0
               </div>
 
 
@@ -100,6 +100,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../licence.html">Licence</a></li>
 </ul>
@@ -352,7 +353,7 @@ <h1>Evaluator<a class="headerlink" href="#evaluator" title="Permalink to this he
 
         &copy; Copyright 2021, Thibault Hallouin.
       <span class="lastupdated">
-        Last updated on Mar 28, 2021.
+        Last updated on Apr 22, 2021.
       </span>
 
     </p>
@@ -381,23 +382,20 @@ <h1>Evaluator<a class="headerlink" href="#evaluator" title="Permalink to this he
     <span class="fa fa-archive"> hydroeval</span>
   </div>
   <div style="float:right;">
-    v: 0.0.3
+    v: 0.1.0
     <span class="fa fa-caret-down"></span>
   </div>
 </span>
 <div class="rst-other-versions">
 
   <dl>
-    <dt>Versions</dt>
+    <dt>External Links</dt>
 
-      <dd><a href="https://thibhlln.github.io/hydroeval/">v0.0.3</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-code"> Source Code</a></dd>
 
-  </dl>
-
-  <dl>
-    <dt>External Links</dt>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/issues"><span class="fa fa-bug"> Issue Tracker</a></dd>
 
-      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-github"> GitHub Repository</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/discussions"><span class="fa fa-users"> User Support</a></dd>
 
   </dl>
 

diff --git a/docs/functions/hydroeval.kge.html b/docs/functions/hydroeval.kge.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>hydroeval.kge &mdash; hydroeval 0.0.3 documentation</title>
+  <title>hydroeval.kge &mdash; hydroeval 0.1.0 documentation</title>
 
 
 
@@ -67,7 +67,7 @@
 
 
               <div class="version">
-                0.0.3
+                0.1.0
               </div>
 
 
@@ -113,6 +113,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../licence.html">Licence</a></li>
 </ul>
@@ -248,7 +249,7 @@ <h1>hydroeval.kge<a class="headerlink" href="#hydroeval-kge" title="Permalink to
 
         &copy; Copyright 2021, Thibault Hallouin.
       <span class="lastupdated">
-        Last updated on Mar 28, 2021.
+        Last updated on Apr 22, 2021.
       </span>
 
     </p>
@@ -277,23 +278,20 @@ <h1>hydroeval.kge<a class="headerlink" href="#hydroeval-kge" title="Permalink to
     <span class="fa fa-archive"> hydroeval</span>
   </div>
   <div style="float:right;">
-    v: 0.0.3
+    v: 0.1.0
     <span class="fa fa-caret-down"></span>
   </div>
 </span>
 <div class="rst-other-versions">
 
   <dl>
-    <dt>Versions</dt>
+    <dt>External Links</dt>
 
-      <dd><a href="https://thibhlln.github.io/hydroeval/">v0.0.3</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-code"> Source Code</a></dd>
 
-  </dl>
-
-  <dl>
-    <dt>External Links</dt>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/issues"><span class="fa fa-bug"> Issue Tracker</a></dd>
 
-      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-github"> GitHub Repository</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/discussions"><span class="fa fa-users"> User Support</a></dd>
 
   </dl>
 

diff --git a/docs/functions/hydroeval.kge_c2m.html b/docs/functions/hydroeval.kge_c2m.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>hydroeval.kge_c2m &mdash; hydroeval 0.0.3 documentation</title>
+  <title>hydroeval.kge_c2m &mdash; hydroeval 0.1.0 documentation</title>
 
 
 
@@ -67,7 +67,7 @@
 
 
               <div class="version">
-                0.0.3
+                0.1.0
               </div>
 
 
@@ -113,6 +113,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../licence.html">Licence</a></li>
 </ul>
@@ -241,7 +242,7 @@ <h1>hydroeval.kge_c2m<a class="headerlink" href="#hydroeval-kge-c2m" title="Perm
 
         &copy; Copyright 2021, Thibault Hallouin.
       <span class="lastupdated">
-        Last updated on Mar 28, 2021.
+        Last updated on Apr 22, 2021.
       </span>
 
     </p>
@@ -270,23 +271,20 @@ <h1>hydroeval.kge_c2m<a class="headerlink" href="#hydroeval-kge-c2m" title="Perm
     <span class="fa fa-archive"> hydroeval</span>
   </div>
   <div style="float:right;">
-    v: 0.0.3
+    v: 0.1.0
     <span class="fa fa-caret-down"></span>
   </div>
 </span>
 <div class="rst-other-versions">
 
   <dl>
-    <dt>Versions</dt>
+    <dt>External Links</dt>
 
-      <dd><a href="https://thibhlln.github.io/hydroeval/">v0.0.3</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-code"> Source Code</a></dd>
 
-  </dl>
-
-  <dl>
-    <dt>External Links</dt>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/issues"><span class="fa fa-bug"> Issue Tracker</a></dd>
 
-      <dd><a href="https://github.com/ThibHlln/hydroeval.git"><span class="fa fa-github"> GitHub Repository</a></dd>
+      <dd><a href="https://github.com/ThibHlln/hydroeval/discussions"><span class="fa fa-users"> User Support</a></dd>
 
   </dl>