HydPy 6.2.dev1__cp313-cp313-win_amd64.whl

hydpy/conf/HydPyConfigBase.xsdt

@@ -0,0 +1,358 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schema targetNamespace="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigBase.xsd"
+        xmlns="http://www.w3.org/2001/XMLSchema"
+        xmlns:hpcb="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigBase.xsd"
+        elementFormDefault="qualified">
+
+    <simpleType name="listOfStrings">
+      <list itemType="string"/>
+    </simpleType>
+
+    <simpleType name="nonEmptyListOfStrings">
+      <restriction base="string">
+          <minLength value="1"/>
+      </restriction>
+    </simpleType>
+
+    <simpleType name="listOfDoubles">
+      <list itemType="double"/>
+    </simpleType>
+
+    <element name="options">
+        <complexType>
+            <choice maxOccurs="unbounded">
+                <element name="checkprojectstructure"
+                         type="boolean"
+                         minOccurs="0"/>
+                <element name="checkseries"
+                         type="boolean"
+                         minOccurs="0"/>
+                <element name="parameterstep"
+                         minOccurs="0">
+                    <simpleType>
+                        <restriction base="string">
+                            <pattern value="[0-9]+[smhd]"/>
+                        </restriction>
+                    </simpleType>
+                </element>
+                <element name="reprdigits"
+                         minOccurs="0">
+                    <simpleType>
+                        <restriction base="integer">
+                            <minInclusive value="-1"/>
+                            <maxInclusive value="12"/>
+                        </restriction>
+                    </simpleType>
+                </element>
+                <element name="usecython"
+                         type="boolean"
+                         minOccurs="0"/>
+                <element name="usedefaultvalues"
+                         type="boolean"
+                         minOccurs="0"/>
+                <element name="utcoffset"
+                         type="integer"
+                         minOccurs="0"/>
+                <element name="timestampleft"
+                         type="boolean"
+                         minOccurs="0"/>
+                <element name="warnmissingobsfile"
+                         type="boolean"
+                         minOccurs="0"/>
+                <element name="warnmissingsimfile"
+                         type="boolean"
+                         minOccurs="0"/>
+                <element name="warntrim"
+                         type="boolean"
+                         minOccurs="0"/>
+            </choice>
+        </complexType>
+    </element>
+
+    <element name="timegrid">
+        <complexType>
+            <sequence>
+                <element name="firstdate" type="dateTime"/>
+                <element name="lastdate" type="dateTime"/>
+                <element name="stepsize">
+                    <simpleType>
+                        <restriction base="string">
+                            <pattern value="[0-9]+[smhd]"/>
+                        </restriction>
+                    </simpleType>
+                </element>
+            </sequence>
+        </complexType>
+    </element>
+
+    <element name="add_selections">
+        <complexType>
+            <sequence>
+                <element ref="hpcb:add_selection" maxOccurs="unbounded"/>
+            </sequence>
+        </complexType>
+    </element>
+
+    <element name="add_selection">
+        <complexType>
+            <sequence>
+                <element name="name"
+                     type="string"/>
+                <element ref="hpcb:devices"
+                         minOccurs="0"/>
+                <element ref="hpcb:keywords"
+                         minOccurs="0"/>
+                <element ref="hpcb:selections"
+                         minOccurs="0"/>
+            </sequence>
+        </complexType>
+    </element>
+
+    <element name="selections"
+             type="hpcb:nonEmptyListOfStrings"/>
+
+    <element name="devices"
+             type="hpcb:nonEmptyListOfStrings"/>
+
+    <element name="keywords"
+             type="hpcb:nonEmptyListOfStrings"/>
+
+    <element name="network_io"
+             type="hpcb:nonEmptyListOfStrings"/>
+
+    <element name="control_io"
+             type="hpcb:nonEmptyListOfStrings"/>
+
+    <element name="conditions_io">
+        <complexType>
+            <sequence>
+                <element name="prefix"
+                         type="string"
+                         minOccurs="0"/>
+                <element name="inputdir"
+                         type="anyURI"
+                         minOccurs="0"/>
+                <element name="outputdir"
+                         type="anyURI"
+                         minOccurs="0"/>
+                <element name="zip"
+                         type="boolean"
+                         minOccurs="0"/>
+            </sequence>
+        </complexType>
+    </element>
+
+    <simpleType name="mode">
+        <restriction base="string">
+            <enumeration value="ram"/>
+            <enumeration value="jit"/>
+        </restriction>
+    </simpleType>
+
+
+    <element name="series_io">
+        <complexType>
+            <sequence>
+                <element name="directory"
+                         type="string"
+                         minOccurs="0"/>
+                <element name="filetype"
+                         minOccurs="0"
+                         type="hpcb:filetype"/>
+                <element name="overwrite"
+                         minOccurs="0"
+                         type="boolean"/>
+                <element name="aggregation"
+                         minOccurs="0"
+                         type="hpcb:aggregation"/>
+                <element name="convention"
+                         minOccurs="0"
+                         type="hpcb:convention"/>
+                <element name="mode"
+                         minOccurs="0"
+                         type="hpcb:mode"/>
+                <element name="readers">
+                    <complexType>
+                        <sequence>
+                            <element ref="hpcb:reader"
+                                     maxOccurs="unbounded"/>
+                        </sequence>
+                    </complexType>
+                </element>
+                <element name="writers">
+                    <complexType>
+                        <sequence>
+                            <element ref="hpcb:writer"
+                                     minOccurs="0"
+                                     maxOccurs="unbounded" />
+                        </sequence>
+                    </complexType>
+                </element>
+            </sequence>
+        </complexType>
+    </element>
+
+    <element name="reader">
+        <complexType>
+            <sequence>
+                <element name="directory"
+                         type="string"
+                         minOccurs="0"/>
+                <element ref="hpcb:selections"
+                         minOccurs="0"/>
+                <element name="sequences"
+                         type="hpcb:readerType"/>
+                <element name="filetype"
+                         minOccurs="0"
+                         type="hpcb:filetype"/>
+                <element name="convention"
+                         minOccurs="0"
+                         type="hpcb:convention"/>
+                <element name="mode"
+                         minOccurs="0"
+                         type="hpcb:mode"/>
+            </sequence>
+            <attribute name="info" type="string"/>
+        </complexType>
+    </element>
+
+    <element name="writer">
+        <complexType>
+            <sequence>
+                <element name="directory"
+                         type="string"
+                         minOccurs="0"/>
+                <element ref="hpcb:selections"
+                         minOccurs="0"/>
+                <element name="sequences"
+                         type="hpcb:writerType"/>
+                <element name="filetype"
+                         minOccurs="0"
+                         type="hpcb:filetype"/>
+                <element name="overwrite"
+                         minOccurs="0"
+                         type="boolean"/>
+                <element name="aggregation"
+                         minOccurs="0"
+                         type="hpcb:aggregation"/>
+                <element name="convention"
+                         minOccurs="0"
+                         type="hpcb:convention"/>
+                <element name="mode"
+                         minOccurs="0"
+                         type="hpcb:mode"/>
+            </sequence>
+            <attribute name="info" type="string"/>
+        </complexType>
+    </element>
+
+    <simpleType name="filetype">
+        <restriction base="string">
+            <enumeration value="asc"/>
+            <enumeration value="npy"/>
+            <enumeration value="nc"/>
+        </restriction>
+    </simpleType>
+
+    <simpleType name="aggregation">
+        <restriction base="string">
+            <enumeration value="none"/>
+            <enumeration value="mean"/>
+        </restriction>
+    </simpleType>
+
+    <simpleType name="convention">
+        <restriction base="string">
+            <enumeration value="model-specific"/>
+            <enumeration value="HydPy"/>
+        </restriction>
+    </simpleType>
+
+    <complexType name="node_readerType">
+        <sequence>
+            <element name="sim"
+                     minOccurs="0"/>
+            <element name="obs"
+                     minOccurs="0"/>
+        </sequence>
+    </complexType>
+
+    <complexType name="node_writerType">
+        <sequence>
+            <element name="sim"
+                     minOccurs="0"/>
+            <element name="obs"
+                     minOccurs="0"/>
+        </sequence>
+    </complexType>
+
+<!--include model sequence groups-->
+
+    <element name="exchange">
+        <complexType>
+            <sequence>
+                <element ref="hpcb:setitems"
+                         minOccurs="0"
+                         maxOccurs="unbounded"/>
+                <element ref="hpcb:additems"
+                         minOccurs="0"
+                         maxOccurs="unbounded"/>
+                <element ref="hpcb:multiplyitems"
+                         minOccurs="0"
+                         maxOccurs="unbounded"/>
+                <element ref="hpcb:getitems"
+                         minOccurs="0"
+                         maxOccurs="unbounded"/>
+            </sequence>
+        </complexType>
+    </element>
+
+    <simpleType name="_levelType">
+        <restriction base="string">
+            <enumeration value="global"/>
+            <enumeration value="selection"/>
+            <enumeration value="device"/>
+            <enumeration value="subunit"/>
+        </restriction>
+    </simpleType>
+
+    <complexType name="setitemType">
+        <sequence>
+            <element ref="hpcb:selections"
+                     minOccurs="0"/>
+            <element name="name"
+                     type="string"/>
+            <element name="level"
+                     type="hpcb:_levelType"/>
+            <element name="init"
+                     type="hpcb:listOfDoubles"
+                     minOccurs="0"/>
+        </sequence>
+    </complexType>
+
+    <complexType name="mathitemType">
+        <sequence>
+            <element ref="hpcb:selections"
+                     minOccurs="0"/>
+            <element name="name"
+                     type="string"/>
+            <element name="level"
+                     type="hpcb:_levelType"/>
+            <element name="init"
+                     type="hpcb:listOfDoubles"/>
+        </sequence>
+    </complexType>
+
+    <complexType name="getitemType">
+        <sequence>
+            <element name="name"
+                     type="string"
+                     minOccurs="0"/>
+            <element ref="hpcb:selections"
+                     minOccurs="0"/>
+        </sequence>
+    </complexType>
+
+<!--include exchange items-->
+
+</schema>

hydpy/conf/HydPyConfigMultipleRuns.xsd

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schema targetNamespace="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigMultipleRuns.xsd"
+        xmlns="http://www.w3.org/2001/XMLSchema"
+        xmlns:hpcb="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigBase.xsd"
+        elementFormDefault="qualified">
+    <import namespace="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigBase.xsd"
+            schemaLocation="HydPyConfigBase.xsd"/>
+
+    <element name="config">
+        <complexType>
+            <sequence>
+                <element ref="hpcb:options"/>
+                <element ref="hpcb:timegrid"/>
+                <element ref="hpcb:add_selections" minOccurs="0"/>
+                <element ref="hpcb:selections"/>
+                <element ref="hpcb:network_io" minOccurs="0"/>
+                <element ref="hpcb:control_io" minOccurs="0"/>
+                <element ref="hpcb:conditions_io"/>
+                <element ref="hpcb:series_io"/>
+                <element ref="hpcb:exchange"/>
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>

hydpy/conf/HydPyConfigSingleRun.xsd

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schema targetNamespace="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigSingleRun.xsd"
+        xmlns="http://www.w3.org/2001/XMLSchema"
+        xmlns:hpcb="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigBase.xsd"
+        elementFormDefault="qualified">
+    <import namespace="https://github.com/hydpy-dev/hydpy/releases/download/your-hydpy-version/HydPyConfigBase.xsd"
+            schemaLocation="HydPyConfigBase.xsd"/>
+
+    <element name="config">
+        <complexType>
+            <sequence>
+                <element ref="hpcb:options"/>
+                <element ref="hpcb:timegrid"/>
+                <element ref="hpcb:add_selections" minOccurs="0"/>
+                <element ref="hpcb:selections"/>
+                <element ref="hpcb:network_io" minOccurs="0"/>
+                <element ref="hpcb:control_io" minOccurs="0"/>
+                <element ref="hpcb:conditions_io"/>
+                <element ref="hpcb:series_io"/>
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>

hydpy/config.py

@@ -0,0 +1,42 @@
+"""Module |config| allows the user to configure `HydPy`.
+
+The available options should not be changed during runtime.
+"""
+
+from typing import Final
+
+import numpy
+
+
+USEAUTODOC = False
+"""A flag that indicates whether *HydPy's* automatic documentation manipulation 
+features should be applied or not.  It is imperative to set it to `True` before one 
+uses `Sphinx` to generate the online documentation.  However, one can set it to `False` 
+for regular applications, which reduces *HydPy's* initialisation time."""
+
+FASTCYTHON = True
+"""A flag that indicates whether cythonizing should result in faster but more fragile 
+models or slower but more robust models.  Setting this flag to False can be helpful 
+when the implementation of new models or other Cython-related features introduces 
+errors that do not result in informative error messages."""
+
+PROFILECYTHON = False
+"""A flag that indicates whether cythonized models should be fully accessible during 
+profiling.  Setting this flag to True decreases performance and should be done by model 
+or framework developers only."""
+
+ENCODING = "utf-8"
+"""Default encoding for all usages of |open|.  If you prefer to use your (different) 
+locale encoding, define it explicitly or assign "locale"""
+
+NP_FLOAT: Final = numpy.float64
+"""Type of floating point values in NumPy arrays."""
+
+NP_INT: Final = numpy.int64
+"""Type of integer values in NumPy arrays."""
+
+NP_BOOL: Final = numpy.bool_
+"""Type of boolean values in NumPy arrays."""
+
+TYPES_PY2NP: Final = {float: NP_FLOAT, int: NP_INT, bool: NP_BOOL}
+"""Mapping from the required Python number types to the required NumPy number types."""

hydpy/core/aliastools.py

@@ -0,0 +1,214 @@
+"""This module provides tools for the efficient handling of input and output
+sequence aliases."""
+
+# import...
+# ...from standard library
+import importlib
+import inspect
+import os
+import pkgutil
+import types
+
+# ...from site-packages
+import black
+
+# ...from HydPy
+import hydpy
+from hydpy import config
+from hydpy import models
+from hydpy.core import sequencetools
+from hydpy.core.typingtools import *
+
+
+class LazyInOutSequenceImport:
+    """Import the input or output sequence the alias is referring to only when required.
+
+    .. _`special method lookup`: https://docs.python.org/reference/datamodel.html#special-lookup  # pylint: disable=line-too-long
+
+    Importing all input and output sequences costs a significant amount of
+    initialisation time, and one typically uses at most a few of them within a
+    specific project.  Hence, we implemented class |LazyInOutSequenceImport| for
+    postponing the imports of the sequences available by modules `inputs` and
+    `outputs`.  We hope we could catch all exceptional cases so that a user will
+    never realise to work with a |LazyInOutSequenceImport| object instead with an
+    input or output class object (except when directly asking for it with function
+    |type|).
+
+    Directly after importing, the alias is of type |LazyInOutSequenceImport|:
+
+    >>> from hydpy.core.aliastools import LazyInOutSequenceImport
+    >>> def get_example_alias():
+    ...     return LazyInOutSequenceImport(
+    ...         modulename="hydpy.models.hland.hland_inputs",
+    ...         classname="T",
+    ...         alias="hland_inputs_T",
+    ...         namespace=locals(),
+    ...     )
+    >>> hland_inputs_T = get_example_alias()
+    >>> type(hland_inputs_T)
+    <class 'hydpy.core.aliastools.LazyInOutSequenceImport'>
+
+    After accessing an attribute, its type changed to |abc.ABCMeta|, which is the
+    meta-class of all input and output sequences:
+
+    >>> hland_inputs_T.__name__
+    'T'
+    >>> type(hland_inputs_T)
+    <class 'type'>
+
+    Due to Python's `special method lookup`_, we must explicitly define the relevant
+    ones.  The following examples list all considered methods:
+
+    >>> hland_inputs_T = get_example_alias()
+    >>> from hydpy.models.hland.hland_inputs import T, P
+    >>> hash(hland_inputs_T) == hash(T)
+    True
+
+    >>> hland_inputs_T = get_example_alias()
+    >>> hland_inputs_T == T
+    True
+    >>> hland_inputs_T = get_example_alias()
+    >>> T == hland_inputs_T
+    True
+
+    >>> hland_inputs_T = get_example_alias()
+    >>> hland_inputs_T != P
+    True
+    >>> hland_inputs_T = get_example_alias()
+    >>> P != hland_inputs_T
+    True
+
+    >>> hland_inputs_T = get_example_alias()
+    >>> str(hland_inputs_T)
+    "<class 'hydpy.models.hland.hland_inputs.T'>"
+
+    >>> hland_inputs_T = get_example_alias()
+    >>> repr(hland_inputs_T)
+    "<class 'hydpy.models.hland.hland_inputs.T'>"
+
+    >>> hland_inputs_T = get_example_alias()
+    >>> dir(hland_inputs_T)   # doctest: +ELLIPSIS
+    ['INIT', 'NDIM', ...]
+    """
+
+    def __init__(
+        self, modulename: str, classname: str, alias: str, namespace: dict[str, Any]
+    ) -> None:
+        self._modulename = modulename
+        self._classname = classname
+        self._alias = alias
+        self._namespace = namespace
+
+    def _get_sequencetype(self) -> sequencetools.InOutSequenceTypes:
+        dict_ = object.__getattribute__(self, "__dict__")
+        module = importlib.import_module(dict_["_modulename"])
+        return getattr(module, dict_["_classname"])
+
+    def __getattribute__(self, name: str) -> Any:
+        class_ = LazyInOutSequenceImport._get_sequencetype(self)
+        dict_ = object.__getattribute__(self, "__dict__")
+        alias = dict_["_alias"]
+        dict_["_namespace"][alias] = class_
+        hydpy.sequence2alias[class_] = alias
+        frame = inspect.currentframe()
+        while frame is not None:
+            if alias in frame.f_locals:
+                frame.f_locals[alias] = class_
+            frame = frame.f_back
+        if name == "_get_sequencetype":
+            return types.MethodType(LazyInOutSequenceImport._get_sequencetype, self)
+        return getattr(class_, name)
+
+    def __hash__(self) -> int:
+        return hash(self._get_sequencetype())
+
+    def __eq__(self, other: object) -> bool:
+        return self._get_sequencetype() == other
+
+    def __ne__(self, other: object) -> bool:
+        return self._get_sequencetype() != other
+
+    def __str__(self) -> str:
+        return str(self._get_sequencetype())
+
+    def __repr__(self) -> str:
+        return repr(self._get_sequencetype())
+
+    def __dir__(self) -> list[str]:
+        return dir(self._get_sequencetype())
+
+
+def write_sequencealiases() -> None:
+    """Write the sequence alias module `aliases.py`.
+
+    After extending a model or adding a new one, you can update the module by calling
+    |write_sequencealiases|:
+
+    >>> from hydpy.core.aliastools import write_sequencealiases
+    >>> write_sequencealiases()
+    """
+    groupname2sequencetype2ndims = (
+        ("inputs", sequencetools.InputSequence, (0,)),
+        ("inlets", sequencetools.InletSequence, (0, 1)),
+        ("receivers", sequencetools.ReceiverSequence, (0, 1)),
+        ("factors", sequencetools.FactorSequence, (0,)),
+        ("fluxes", sequencetools.FluxSequence, (0,)),
+        ("states", sequencetools.StateSequence, (0,)),
+        ("outlets", sequencetools.OutletSequence, (0, 1)),
+        ("senders", sequencetools.SenderSequence, (0, 1)),
+    )
+    modelpath: str = models.__path__[0]
+    sequence2alias: dict[sequencetools.InOutSequenceTypes, str] = {}
+    for moduleinfo in pkgutil.iter_modules([modelpath]):
+        if not moduleinfo.ispkg:
+            continue
+        for groupname, sequencetype, ndim in groupname2sequencetype2ndims:
+            modelname = moduleinfo.name
+            modulepath = f"hydpy.models.{modelname}.{modelname}_{groupname}"
+            try:
+                module = importlib.import_module(modulepath)
+            except ModuleNotFoundError:
+                continue
+            for member in vars(module).values():
+                if (
+                    (getattr(member, "__module__", None) == modulepath)
+                    and issubclass(member, sequencetype)
+                    and member.NDIM in ndim
+                ):
+                    alias = f"{modelname}_{groupname}_{member.__name__}"
+                    sequence2alias[member] = alias
+
+    lines = [
+        '"""This module provides the aliases of the sequences of all available models '
+        "one might \nwant to connect to node sequences.",
+        "",
+        "This file was automatically created by function |write_sequencealiases|.",
+        '"""',
+        "# import...",
+        "# ...from standard library",
+        "from typing import TYPE_CHECKING",
+        "# ...from HydPy",
+        "from hydpy.core.aliastools import LazyInOutSequenceImport",
+    ]
+    lines.append("if TYPE_CHECKING:")
+    for sequence, alias in sequence2alias.items():
+        lines.append(
+            f"    from {sequence.__module__} " f"import {sequence.__name__} as {alias}"
+        )
+    lines.append("else:")
+    for sequence, alias in sequence2alias.items():
+        lines.append(
+            f"    {alias} = LazyInOutSequenceImport("
+            f'        modulename="{sequence.__module__}",'
+            f'        classname="{sequence.__name__}",'
+            f'        alias="{alias}",'
+            f"        namespace=locals(),"
+            f"    )"
+        )
+    exports = (f'"{alias}"' for alias in sequence2alias.values())
+    lines.append(f'\n__all__ = [{", ".join(exports)}]')
+    text = "\n".join(lines)
+    text = black.format_str(text, mode=black.FileMode())
+    filepath = os.path.join(hydpy.__path__[0], "aliases.py")
+    with open(filepath, "w", encoding=config.ENCODING) as file_:
+        file_.write(text)