created branch concat

rwijtvliet · Feb 13, 2024 · 10d7f55 · 10d7f55
1 parent 2aea7ee
commit 10d7f55
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 4 deletions.
diff --git a/docs/core/pfline.rst b/docs/core/pfline.rst
@@ -269,6 +269,27 @@ Another slicing method is implemented with the ``.slice[]`` property. The improv
    # --- hide: stop ---
 
 
+Concatenation
+=============
+
+Portfolio lines can be concatenated with the ``portfolio.concat()`` function. This only works if the input portfolio lines have contain compatible information (the same frequency, timezone, start-of-day, kind, etc) and, crucially, their indices are gapless and without overlap. To remove any overlap, use the ``.slice[]`` property.
+
+.. exec_code::
+
+   # --- hide: start ---
+   import portfolyo as pf, pandas as pd
+   index = pd.date_range('2024', freq='AS', periods=3)
+   input_df = pd.DataFrame({'w':[200, 220, 300], 'p': [100, 150, 200]}, index)
+   pfl = pf.PfLine(input_df)
+   # --- hide: stop ---
+   # continuation of previous code example
+   index2 = pd.date_range('2025', freq='AS', periods=3)  # 2 years' overlap with pfl
+   pfl2 = pf.PfLine(pd.DataFrame({'w':[22, 30, 40], 'p': [15, 20, 21]}, index))
+   # first two datapoints (until/excl 2026) from pfl, last two datapoints (from/incl 2026) from pfl2 
+   pf.concat([pfl.slice[:'2026'], pfl2.slice['2026':]]) 
+   # --- hide: start ---
+   print(pf.concat([pfl.slice[:'2026'], pfl2.slice['2026':]]))
+   # --- hide: stop ---
 
 Volume-only, price-only or revenue-only
 =======================================

diff --git a/portfolyo/__init__.py b/portfolyo/__init__.py
@@ -1,10 +1,9 @@
 """Package to analyse and manipulate timeseries related to power and gas offtake portfolios."""
 
-
 from . import _version, dev, tools
 from .core import extendpandas  # extend functionalty of pandas
 from .core import suppresswarnings
-from .core.mixins.plot import plot_pfstates
+from .core.shared.plot import plot_pfstates
 from .core.pfline import Kind, PfLine, Structure, create
 from .core.pfstate import PfState
 from .prices.hedge import hedge
@@ -15,6 +14,7 @@
 from .tools.tzone import force_agnostic, force_aware
 from .tools.unit import Q_, ureg, Unit
 from .tools.wavg import general as wavg
+from .core.shared.concat import concat
 
 VOLUME = Kind.VOLUME
 PRICE = Kind.PRICE

diff --git a/portfolyo/core/pfline/classes.py b/portfolyo/core/pfline/classes.py
@@ -8,7 +8,7 @@
 import pandas as pd
 
 from ... import tools
-from ..mixins import ExcelClipboardOutput, PfLinePlot, PfLineText
+from ..shared import ExcelClipboardOutput, PfLinePlot, PfLineText
 from ..ndframelike import NDFrameLike
 from . import (
     create,

diff --git a/portfolyo/core/pfline/concat.py b/portfolyo/core/pfline/concat.py
diff --git a/portfolyo/core/pfstate/pfstate.py b/portfolyo/core/pfstate/pfstate.py
@@ -12,7 +12,7 @@
 import pandas as pd
 
 from ... import tools
-from ..mixins import ExcelClipboardOutput, PfStatePlot, PfStateText
+from ..shared import ExcelClipboardOutput, PfStatePlot, PfStateText
 from ..ndframelike import NDFrameLike
 from ..pfline import PfLine, create
 from . import pfstate_helper

diff --git a/portfolyo/core/mixins/__init__.py → portfolyo/core/shared/__init__.py b/portfolyo/core/mixins/__init__.py → portfolyo/core/shared/__init__.py
diff --git a/portfolyo/core/shared/concat.py b/portfolyo/core/shared/concat.py
diff --git a/portfolyo/core/mixins/excelclipboard.py → portfolyo/core/shared/excelclipboard.py b/portfolyo/core/mixins/excelclipboard.py → portfolyo/core/shared/excelclipboard.py
diff --git a/portfolyo/core/mixins/plot.py → portfolyo/core/shared/plot.py b/portfolyo/core/mixins/plot.py → portfolyo/core/shared/plot.py
diff --git a/portfolyo/core/mixins/text.py → portfolyo/core/shared/text.py b/portfolyo/core/mixins/text.py → portfolyo/core/shared/text.py