Structure

README.rst

@@ -1,3 +1,4 @@
+=========
 portfolyo
 =========
 
@@ -28,6 +29,8 @@ portfolyo
 Portfolyo is a Python package to analyse and manipulate timeseries related to power 
 and gas offtake portfolios.
 
+
+------------
 Installation
 ------------
 
@@ -45,13 +48,16 @@ NB: this package is under active development and the API will change without pri
    portfolyo = "x.y.z"
 
 
+-------------
 Documentation
 -------------
 
 Documentation is hosted on readthedocs:
 
 https://portfolyo.readthedocs.io/
 
+
+----------
 Repository
 ----------
 
@@ -60,6 +66,7 @@ The git repository is hosted on github:
 http://www.github.com/rwijtvliet/portfolyo
 
 
+----------
 Developing
 ----------
 
@@ -74,6 +81,16 @@ the commit hooks.
 
 Feature branches are merged into the ``develop`` branch via pull request.
 
+
+Internal dependencies
+---------------------
+
+Inside the package, modules depend on each other in the following chain. A module may depend on another module if it is further to the left:
+
+tools >> pfline >> pfstate >> tools2
+
+
+----------
 Publishing
 ----------
 

portfolyo/__init__.py

@@ -1,28 +1,27 @@
 """Package to analyse and manipulate timeseries related to power and gas offtake portfolios."""
 
-from . import _version, dev, testing, tools
+from . import _version, dev, tools
 from .core import extendpandas  # extend functionalty of pandas
 from .core import suppresswarnings
-from .tools2.plot import plot_pfstates
 from .core.pfline import Kind, PfLine, Structure, create
 from .core.pfstate import PfState
+from .tools import testing
+from .tools2.changeyear import map_to_year
 from .tools2.concat import general as concat
+from .tools2.intersect import indexable as intersection
 from .tools2.plot import plot_pfstates
-from .prices.hedge import hedge
-from .prices.utils import is_peak_hour
 from .tools.changefreq import averagable as asfreq_avg
 from .tools.changefreq import summable as asfreq_sum
 from .tools.changeyear import characterize_index, map_frame_to_year
 from .tools.freq import FREQUENCIES
+from .tools.hedge import hedge
+from .tools.peakfn import PeakFunction
+from .tools.peakfn import factory as create_peakfn
+from .tools.product import germanpower_peakfn, is_peak_hour
 from .tools.standardize import frame as standardize
 from .tools.tzone import force_agnostic, force_aware
 from .tools.unit import Q_, Unit, ureg
 from .tools.wavg import general as wavg
-from .tools2.concat import general as concat
-from .tools2.intersect import indexable as intersection
-
-# from .core.shared.concat import general as concat
-
 
 VOLUME = Kind.VOLUME
 PRICE = Kind.PRICE
@@ -33,4 +32,4 @@
 suppresswarnings.apply()
 
 __version__ = _version.get_versions()["version"]
-__all__ = ["tools", "dev", "testing", "PfLine", "PfState"]
+__all__ = ["tools", "dev", "PfLine", "PfState"]

portfolyo/core/pfline/arithmatic.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Union
+from typing import TYPE_CHECKING, Any
 
 import numpy as np
 import pandas as pd
 
-from ... import testing, tools
+from ... import tools
 from . import classes, create, interop
 from .enums import Kind, Structure
 
@@ -23,7 +23,7 @@ def assert_objects_indexcompatibility(fn):
 
         def wrapper(o1, o2, *args, **kwargs):
             try:
-                testing.assert_indices_compatible(o1.index, o2.index)
+                tools.testing.assert_indices_compatible(o1.index, o2.index)
             except AssertionError as e:
                 raise NotImplementedError from e
             return fn(o1, o2, *args, **kwargs)
@@ -185,7 +185,7 @@ def __rmul__(self: PfLine, other: Any) -> PfLine:
     @Prep.standardize_other  # other converted to None, a PfLine, or dimless Series
     @Prep.raiseerror_if_otherNone  # other is now a PfLine or dimless Series...
     @Prep.assert_objects_indexcompatibility  # ... with a compatible index
-    def __truediv__(self: PfLine, other: Any) -> Union[PfLine, pd.Series]:
+    def __truediv__(self: PfLine, other: Any) -> PfLine | pd.Series:
         if isinstance(other, pd.Series):
             return Multiply.pfline_and_series(self, 1 / other)
         else:
@@ -195,7 +195,7 @@ def __truediv__(self: PfLine, other: Any) -> Union[PfLine, pd.Series]:
     @Prep.raiseerror_if_otherNone  # other is now a PfLine or dimless Series
     @Prep.raiseerror_if_otherdimlessseries  # other is now a PfLine...
     @Prep.assert_objects_indexcompatibility  # ... with a compatible index
-    def __rtruediv__(self: PfLine, other: Any) -> Union[PfLine, pd.Series]:
+    def __rtruediv__(self: PfLine, other: Any) -> PfLine | pd.Series:
         return Divide.two_pflines(other, self)  # NB order!
 
     @Prep.standardize_other  # other converted to None, a PfLine, or dimless Series
@@ -285,12 +285,10 @@ def nestedpfline_and_series(pfl: NestedPfLine, s: pd.Series) -> NestedPfLine:
 
 class Divide:
     @Prep.ensure_pflines_flat  # pfl1 and pfl2 are now both flat
-    def two_pflines(pfl1: PfLine, pfl2: PfLine) -> Union[pd.Series, PfLine]:
+    def two_pflines(pfl1: PfLine, pfl2: PfLine) -> pd.Series | PfLine:
         return Divide.two_flatpflines(pfl1, pfl2)
 
-    def two_flatpflines(
-        pfl1: FlatPfLine, pfl2: FlatPfLine
-    ) -> Union[pd.Series, FlatPfLine]:
+    def two_flatpflines(pfl1: FlatPfLine, pfl2: FlatPfLine) -> pd.Series | FlatPfLine:
         if pfl1.kind is pfl2.kind:
             if pfl1.kind is Kind.COMPLETE:
                 raise NotImplementedError(

portfolyo/core/pfline/children.py

@@ -1,19 +1,17 @@
 from __future__ import annotations
 
 import warnings
-from typing import TYPE_CHECKING, Any, Mapping, Union
+from typing import TYPE_CHECKING, Any, Mapping
 
-from ... import testing, tools
+from ... import tools
 from . import create
 
 if TYPE_CHECKING:
     from .classes import NestedPfLine, PfLine
 
 
 class ChildFunctionality(Mapping):
-    def set_child(
-        self: NestedPfLine, name: str, child: Union[PfLine, Any]
-    ) -> NestedPfLine:
+    def set_child(self: NestedPfLine, name: str, child: PfLine | Any) -> NestedPfLine:
         """Set/add/update child; returns new pfline instance without changing current instance."""
         if name in ["w", "q", "p", "r"]:
             raise ValueError("Name cannot be one of 'w', 'q', 'p', 'r'.")
@@ -28,7 +26,7 @@ def set_child(
                 f"Incompatible kinds; the portfolio line has {self.kind} but the child has {child.kind}."
             )
         try:
-            testing.assert_indices_compatible(self.index, child.index)
+            tools.testing.assert_indices_compatible(self.index, child.index)
         except AssertionError as e:
             raise ValueError(
                 "Index of new child is not compatible with the existing data."