HydPy 6.2.dev1__cp313-cp313-win_amd64.whl

hydpy/docs/rst/version_control.rst

@@ -0,0 +1,116 @@
+.. _Git: https://git-scm.com/
+.. _hydpy repository: https://github.com/hydpy-dev/hydpy
+.. _GitHub: https://github.com
+.. _GitHub account: https://github.com/signup/free
+.. _Sourcetree: https://www.sourcetreeapp.com/
+.. _Pro Git: https://progit2.s3.amazonaws.com/en/2016-03-22-f3531/progit-en.1084.pdf
+.. _How to Rebase a Pull Request: https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request
+.. _gitignore: https://github.com/hydpy-dev/hydpy/blob/master/.gitignore
+
+.. _version_control:
+
+Version control
+_______________
+
+To work collaboratively on the same software code requires version control.
+It must be clear who is working on which part of the code, when (and why)
+someone conducted code changes, and which code sections of one developer
+are compatible with code sections of another developer (or not).  Also,
+one might need to fall back on an older code version when some current
+changes turned out to be a dead end.
+
+For *HydPy*, we choose `Git`_ for these tasks.  `Git`_ is a distributed
+version control software, allowing for handling multiple repositories
+of the same project at different places by different people. Each
+repository contains all projects files including their change histories.
+We host the main `hydpy repository`_ on `GitHub`_.  So you first should
+sing up for a free `GitHub account`_.  After that, you can contribute to
+*HydPy* online without installing any software or downloading the repository.
+If you are only aiming to improve the documentation, this could be
+reasonable.  However, for more substantial contributions you need to
+handle a separate *HydPy* repository on your local computer with a local
+installation of `Git`_. `Git`_ itself works via command lines, but in
+the majority of cases using graphical user interface as `Sourcetree`_
+is much more comfortable.
+
+Contributing to *HydPy* essentially requires three or four steps, no matter
+if working on `GitHub`_ directly or with your local `Git`_ software. For
+simplicity and generality, we explain these steps using the example of a
+single file change via `GitHub`_:
+
+  * Go to the main `hydpy repository`_ and click on "Fork", creating a
+    new *HydPy* repository under your own `GitHub`_ account, allowing to
+    add, change, or delete any files without intervening in the
+    development the original `hydpy repository`_.
+  * Click on "Branch: master", type a name reflecting your goal (e.g.
+    "improve_gitignore" and click on "Create branch: improve_gitignore
+    from `master`".  Now that you have created a new branch, you can
+    experiment without affecting the master branch of your forked
+    repository. (This step is not required, but creating branches for
+    different tasks helps to structure your work, to cooperate with others,
+    and to keep the "official" history free from unsuccessful experiments.)
+  * Change the content of a file.  For example:
+      * Click on `gitignore`_.
+      * Click on the pen symbol ("Edit this file").
+      * change the order of two lines (e.g. "*c." and "*.h")
+      * Write something under "Commit changes" to explain your purpose
+        (e.g. "change the order of two lines in `.gitignore` to practise it").
+      * Click on the green "Commit changes" button.
+
+    Now you have changed the `gitignore`_ file of your specialised branch.
+    Typically, you would commit multiple small changes to one branch.
+    Keeping the single commits small allows for inspecting and reversing
+    different changes.
+  * At last, you can suggest incorporating your changes in the original
+    `hydpy repository`_.  Click on "Compare & pull request" to visualise
+    the relevant differences and add some explanations.  Click on
+    "Create pull request" to ask others to discuss your changes and to
+    ask the maintainer of the original `hydpy repository`_  to pull and
+    merge them into the main development line.
+
+You are responsible for your forked repository only and do not have to
+be afraid to break the original `hydpy repository`_ accidentally.
+However, you should give your best to focus your pull requests on single
+issues and explain them clearly.  Otherwise, the package maintainer
+might refuse your contributions in the sake of safeguarding *HydPy's*
+code integrity.
+
+Of course, things are not always as easy as in the example above.  Not only
+your code changes, but the main line of development evolves as well.
+Then you first have to merge the latest changes of the master branch of the
+original `hydpy repository`_ into your current working branch, to resolve
+some conflicts if necessary, and to "rebase" everything to provide a granular
+and understandable pull request.  See the much more thorough explanations
+`How to Rebase a Pull Request`_ and `Pro Git`_ to improve your `Git`_ skills.
+
+Besides working in separate forks, it is a standard `Git`_ approach to
+structure code development in multiple branches.  For *HydPy*, we decided
+on the following branching model.
+
+First and most importantly, there is the "master" branch, tracking the
+"stable" changes of the code base, serving as the foundation of collaborative
+development.  Second, there are the "feature" and "fix" branches related to
+specific issues.  Third, there are the "release" branches, one for each
+official *HydPy* release.
+
+The master branch is never removed or rebased.  Hence, its commits cannot
+be changed or undone (except by later commits, of course). To avoid
+confusion and a messy commit historiy, do not commit to the master branch
+directly.  Instead, create new "feature" or "fix" branches based on the
+head of the master branch and develop the new feature or fix the addressed
+problem within this branch. Afterwards, you might need to merge recent
+changes of the master branch into your branch or to clean up your commit
+history through rebasing.  Finally, when everything seems right, your
+branch can be merged into the master branch with little risk to break
+something or affect the work of others.
+
+Feature and fix branches should contain both the affected subpackage and
+module name, as well as a short description of the topic.  If reasonable,
+follow the following pattern: "fix/core/hydpytools/typos".
+
+We use the tag name patterns "v4.0.0" and "v4.0a0" for stable and
+preliminary releases, respectively.  For stable releases, we tag
+commits to the master branch, only.  We create a separate branch for
+each minor version number (e.g. release/v4.0 and release/v4.1) to be able
+to apply fixes later.  Fixes are indicated by tags only, increasing
+the bugfix number (e.g. from v4.0.0 to v4.0.1).

hydpy/docs/rst/zbibliography.rst

@@ -0,0 +1,8 @@
+
+.. _bibliography:
+
+Bibliography
+============
+
+.. bibliography:: refs.bib
+    :keyprefix: ref-

hydpy/docs/sphinx/_themes/basic_hydpy/changes/frameset.html

@@ -0,0 +1,11 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
+  "http://www.w3.org/TR/html4/frameset.dtd">
+<html{% if language is not none %} lang="{{ language }}"{% endif %}>
+  <head>
+    <title>{% trans version=version|e, docstitle=docstitle|e %}Changes in Version {{ version }} &#8212; {{ docstitle }}{% endtrans %}</title>
+  </head>
+  <frameset cols="45%,*">
+    <frame name="main" src="changes.html">
+    <frame name="src" src="about:blank">
+  </frameset>
+</html>

hydpy/docs/sphinx/_themes/basic_hydpy/changes/rstsource.html

@@ -0,0 +1,15 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+  "http://www.w3.org/TR/html4/loose.dtd">
+<html{% if language is not none %} lang="{{ language }}"{% endif %}>
+  <head>
+    <title>{% trans filename=filename, docstitle=docstitle|e %}{{ filename }} &#8212; {{ docstitle }}{% endtrans %}</title>
+    <style type="text/css">
+      .hl { background-color: yellow }
+    </style>
+  </head>
+  <body style="font-size: 90%">
+    <pre>
+      {{ text }}
+    </pre>
+  </body>
+</html>

hydpy/docs/sphinx/_themes/basic_hydpy/changes/versionchanges.html

@@ -0,0 +1,33 @@
+{% macro entries(changes) %}
+<ul>{% for entry, docname, lineno in changes %}
+<li><a href="rst/{{ docname }}.html#L{{ lineno-10 }}" target="src">{{ entry }}</a></li>
+{% endfor %}</ul>
+{% endmacro -%}
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+  "http://www.w3.org/TR/html4/loose.dtd">
+<html{% if language is not none %} lang="{{ language }}"{% endif %}>
+  <head>
+    <link rel="stylesheet" href="default.css">
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>{% trans version=version|e, docstitle=docstitle|e %}Changes in Version {{ version }} &#8212; {{ docstitle }}{% endtrans %}</title>
+  </head>
+  <body>
+    <div class="document">
+      <div class="body">
+    <h1>{% trans version=version|e %}Automatically generated list of changes in version {{ version }}{% endtrans %}</h1>
+    <h2>{{ _('Library changes') }}</h2>
+    {% for modname, changes in libchanges %}
+    <h4>{{ modname }}</h4>
+    {{ entries(changes) }}
+    {% endfor %}
+    <h2>{{ _('C API changes') }}</h2>
+    {{ entries(apichanges) }}
+    <h2>{{ _('Other changes') }}</h2>
+    {% for (fn, title), changes in otherchanges %}
+    <h4>{{ title }} <span style="font-size: 50%">({{ fn }})</span></h4>
+    {{ entries(changes) }}
+    {% endfor %}
+      </div>
+    </div>
+  </body>
+</html>

hydpy/docs/sphinx/_themes/basic_hydpy/defindex.html

@@ -0,0 +1,35 @@
+{#
+    basic/defindex.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Default template for the "index" page.
+
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}{{ warn('Now base template defindex.html is deprecated.') }}
+{%- extends "layout.html" %}
+{% set title = _('Overview') %}
+{% block body %}
+  <h1>{{ docstitle|e }}</h1>
+  <p>
+    {{ _('Welcome! This is') }}
+    {% block description %}{{ _('the documentation for') }} {{ project|e }}
+    {{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}{% endblock %}.
+  </p>
+  {% block tables %}
+  <p><strong>{{ _('Indices and tables:') }}</strong></p>
+  <table class="contentstable"><tr>
+    <td style="width: 50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">{{ _('Complete Table of Contents') }}</a><br>
+         <span class="linkdescr">{{ _('lists all sections and subsections') }}</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">{{ _('Search Page') }}</a><br>
+         <span class="linkdescr">{{ _('search this documentation') }}</span></p>
+    </td><td style="width: 50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">{{ _('Global Module Index') }}</a><br>
+         <span class="linkdescr">{{ _('quick access to all modules') }}</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">{{ _('General Index') }}</a><br>
+         <span class="linkdescr">{{ _('all functions, classes, terms') }}</span></p>
+    </td></tr>
+  </table>
+  {% endblock %}
+{% endblock %}

hydpy/docs/sphinx/_themes/basic_hydpy/domainindex.html

@@ -0,0 +1,56 @@
+{#
+    basic/domainindex.html
+    ~~~~~~~~~~~~~~~~~~~~~~
+
+    Template for domain indices (module index, ...).
+
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- extends "layout.html" %}
+{% set title = indextitle %}
+{% block extrahead %}
+{{ super() }}
+{% if not embedded and collapse_index %}
+    <script>
+      DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
+    </script>
+{% endif %}
+{% endblock %}
+{% block body %}
+
+   {%- set groupid = idgen() %}
+
+   <h1>{{ indextitle }}</h1>
+
+   <div class="modindex-jumpbox">
+   {%- for (letter, entries) in content %}
+   <a href="#cap-{{ letter }}"><strong>{{ letter }}</strong></a>
+     {%- if not loop.last %} | {% endif %}
+   {%- endfor %}
+   </div>
+
+   <table class="indextable modindextable">
+   {%- for letter, entries in content %}
+     <tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
+     <tr class="cap" id="cap-{{ letter }}"><td></td><td>
+       <strong>{{ letter }}</strong></td><td></td></tr>
+     {%- for (name, grouptype, page, anchor, extra, qualifier, description)
+             in entries %}
+     <tr{% if grouptype == 2 %} class="cg-{{ groupid.current() }}"{% endif %}>
+       <td>{% if grouptype == 1 -%}
+         <img src="{{ pathto('_static/minus.png', 1) }}" class="toggler"
+              id="toggle-{{ groupid.next() }}" style="display: none" alt="-" />
+           {%- endif %}</td>
+       <td>{% if grouptype == 2 %}&#160;&#160;&#160;{% endif %}
+       {% if page %}<a href="{{ pathto(page)|e }}#{{ anchor }}">{% endif -%}
+       <code class="xref">{{ name|e }}</code>
+       {%- if page %}</a>{% endif %}
+     {%- if extra %} <em>({{ extra|e }})</em>{% endif -%}
+     </td><td>{% if qualifier %}<strong>{{ qualifier|e }}:</strong>{% endif %}
+       <em>{{ description|e }}</em></td></tr>
+     {%- endfor %}
+   {%- endfor %}
+   </table>
+
+{% endblock %}

hydpy/docs/sphinx/_themes/basic_hydpy/genindex-single.html

@@ -0,0 +1,63 @@
+{#
+    basic/genindex-single.html
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Template for a "single" page of a split index.
+
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% macro indexentries(firstname, links) %}
+  {%- if links -%}
+    <a href="{{ links[0][1] }}">
+    {%- if links[0][0] %}<strong>{% endif -%}
+    {{ firstname|e }}
+    {%- if links[0][0] %}</strong>{% endif -%}
+    </a>
+
+    {%- for ismain, link in links[1:] -%}
+      , <a href="{{ link }}">{% if ismain %}<strong>{% endif -%}
+      [{{ loop.index }}]
+      {%- if ismain %}</strong>{% endif -%}
+      </a>
+    {%- endfor %}
+  {%- else %}
+    {{ firstname|e }}
+  {%- endif %}
+{% endmacro %}
+
+{%- extends "layout.html" %}
+{% set title = _('Index') %}
+{% block body %}
+
+<h1 id="index">{% trans key=key %}Index &ndash; {{ key }}{% endtrans %}</h1>
+
+<table style="width: 100%" class="indextable"><tr>
+  {%- for column in entries|slice(2) if column %}
+  <td style="width: 33%; vertical-align: top;"><ul>
+    {%- for entryname, (links, subitems, _) in column %}
+      <li>{{ indexentries(entryname, links) }}
+      {%- if subitems %}
+      <ul>
+      {%- for subentryname, subentrylinks in subitems %}
+        <li>{{ indexentries(subentryname, subentrylinks) }}</li>
+      {%- endfor %}
+      </ul>
+      {%- endif -%}</li>
+    {%- endfor %}
+  </ul></td>
+  {%- endfor %}
+</tr></table>
+
+{% endblock %}
+
+{% block sidebarrel %}
+   <h4>{{ _('Index') }}</h4>
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on one page') }}</strong></a></p>
+   {{ super() }}
+{% endblock %}

hydpy/docs/sphinx/_themes/basic_hydpy/genindex-split.html

@@ -0,0 +1,41 @@
+{#
+    basic/genindex-split.html
+    ~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Template for a "split" index overview page.
+
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- extends "layout.html" %}
+{% set title = _('Index') %}
+{% block body %}
+
+   <h1 id="index">{{ _('Index') }}</h1>
+
+   <p>{{ _('Index pages by letter') }}:</p>
+
+   <div class="genindex-jumpbox">
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on one page') }}</strong>
+                                               ({{ _('can be huge') }})</a></p>
+   </div>
+
+{% endblock %}
+
+{% block sidebarrel %}
+{% if split_index %}
+   <h4>Index</h4>
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on one page') }}</strong></a></p>
+{% endif %}
+   {{ super() }}
+{% endblock %}

hydpy/docs/sphinx/_themes/basic_hydpy/genindex.html

@@ -0,0 +1,76 @@
+{#
+    basic/genindex.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Template for an "all-in-one" index.
+
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- extends "layout.html" %}
+{% set title = _('Index') %}
+
+{% macro indexentries(firstname, links) %}
+  {%- if links -%}
+    <a href="{{ links[0][1] }}">
+    {%- if links[0][0] %}<strong>{% endif -%}
+    {{ firstname|e }}
+    {%- if links[0][0] %}</strong>{% endif -%}
+    </a>
+
+    {%- for ismain, link in links[1:] -%}
+      , <a href="{{ link }}">{% if ismain %}<strong>{% endif -%}
+      [{{ loop.index }}]
+      {%- if ismain %}</strong>{% endif -%}
+      </a>
+    {%- endfor %}
+  {%- else %}
+    {{ firstname|e }}
+  {%- endif %}
+{% endmacro %}
+
+{% block body %}
+
+<h1 id="index">{{ _('Index') }}</h1>
+
+<div class="genindex-jumpbox">
+ {% for key, dummy in genindexentries -%}
+ <a href="#{{ key }}"><strong>{{ key }}</strong></a>
+ {% if not loop.last %}| {% endif %}
+ {%- endfor %}
+</div>
+
+{%- for key, entries in genindexentries %}
+<h2 id="{{ key }}">{{ key }}</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  {%- for column in entries|slice_index(2) if column %}
+  <td style="width: 33%; vertical-align: top;"><ul>
+    {%- for entryname, (links, subitems, _) in column %}
+      <li>{{ indexentries(entryname, links) }}
+      {%- if subitems %}
+      <ul>
+      {%- for subentryname, subentrylinks in subitems %}
+        <li>{{ indexentries(subentryname, subentrylinks) }}</li>
+      {%- endfor %}
+      </ul>
+      {%- endif -%}</li>
+    {%- endfor %}
+  </ul></td>
+  {%- endfor %}
+</tr></table>
+{% endfor %}
+
+{% endblock %}
+
+{% block sidebarrel %}
+{% if split_index %}
+   <h4>{{ _('Index') }}</h4>
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on one page') }}</strong></a></p>
+{% endif %}
+   {{ super() }}
+{% endblock %}

hydpy/docs/sphinx/_themes/basic_hydpy/globaltoc.html

@@ -0,0 +1,11 @@
+{#
+    basic/globaltoc.html
+    ~~~~~~~~~~~~~~~~~~~~
+
+    Sphinx sidebar template: global table of contents.
+
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+<h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3>
+{{ toctree(includehidden=theme_globaltoc_includehidden, collapse=theme_globaltoc_collapse, maxdepth=theme_globaltoc_maxdepth) }}