Toplevelfunctions

.gitignore

@@ -49,6 +49,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+test-output.xml
 cover/
 
 # Translations
@@ -160,3 +161,4 @@ cython_debug/
 .issues/
 .DS_Store
 test.xlsx
+

docs/core/toplevel.rst

@@ -0,0 +1,30 @@
+.. |_| unicode:: 0xA0 
+   :trim:
+
+===============
+Top-level tools
+===============
+
+Some tools for working with ``pandas.Series``, ``pandas.DataFrame``, ``portfolyo.PfLine`` and ``portfolyo.PfState`` objects are available at the root of the package. They are concisely listed below.
+
+----------------------
+Work on pandas objects 
+----------------------
+
+* ``portfolyo.asfreq_avg()`` Changes the frequency of a Series or DataFrame with "averagable" data. See :doc:`this page<../specialized_topics/resampling>` for more information.
+
+* ``portfolyo.asfreq_sum()`` Changes the frequency of a Series or DataFrame with "summable" data. See :doc:`this page<../specialized_topics/resampling>` for more information. 
+
+* ``portfolyo.wavg()`` Calculates weighted average of a Series or DataFrame.
+
+* ``portfolyo.standardize()`` Ensures/asserts a Series or DataFrame follows necessary rules to initialize PfLine with.
+
+-------------------------
+Work on portfolyo objects
+-------------------------
+
+* ``portfolyo.concat()`` Concatenates PfLines into one PfLine.
+
+* ``portfolyo.plot_pfstates()`` Plots several PfStates in one figure.
+
+

docs/index.rst

@@ -68,6 +68,7 @@ Contents
    core/pfline
    core/pfstate
    core/interoperability
+   core/toplevel
 
 .. toctree::
    :maxdepth: 1
@@ -94,4 +95,4 @@ Contents
    :maxdepth: 2
    :caption: Full reference
 
-   full_reference
+   full_reference

docs/specialized_topics/resampling.rst

@@ -137,4 +137,4 @@ The reason for the higher price in the previous example, is that, there, the pri
 Resampling with ``portfolyo``
 -----------------------------
 
-When changing the frequency of a ``PfLine`` or ``PfState`` object, the considerations above are automatically taken into account. If you are in the situation of having to change the frequency of a ``pandas.Series`` or ``DataFrame`` with a ``DatetimeIndex``, however, the relevant functions are also available at the ``portfolyo.tools.changefreq`` module.
+When changing the frequency of a ``PfLine`` or ``PfState`` object, the considerations above are automatically taken into account when using the ``.asfreq()`` method. If you are in the situation of having to change the frequency of a ``pandas.Series`` or ``DataFrame`` with a ``DatetimeIndex``, however, the relevant functions are also available at the package root, as the ``portfolyo.asfreq_avg()`` and ``portfolyo.asfreq_sum()`` functions.

portfolyo/__init__.py

@@ -1,20 +1,22 @@
 """Package to analyse and manipulate timeseries related to power and gas offtake portfolios."""
 
-from . import _version, dev, tools
+from . import _version, dev, testing, tools
 from .core import extendpandas  # extend functionalty of pandas
 from .core import suppresswarnings
-from .core.shared.plot import plot_pfstates
 from .core.pfline import Kind, PfLine, Structure, create
 from .core.pfstate import PfState
+from .core.shared.concat import general as concat
+from .core.shared.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.standardize import frame as standardize
 from .tools.tzone import force_agnostic, force_aware
-from .tools.unit import Q_, ureg, Unit
+from .tools.unit import Q_, Unit, ureg
 from .tools.wavg import general as wavg
-from .core.shared.concat import general as concat
 
 # from .core.shared.concat import general as concat
 
@@ -27,4 +29,4 @@
 suppresswarnings.apply()
 
 __version__ = _version.get_versions()["version"]
-__all__ = ["tools", "dev", "PfLine", "PfState"]
+__all__ = ["tools", "dev", "testing", "PfLine", "PfState"]

pyproject.toml

@@ -11,7 +11,7 @@ license = "BSD-3"
 readme = "README.rst"
 
 [tool.poetry.dependencies]
-python = ">=3.10"
+python = "^3.10"
 pandas = "~2.0"       # pandas 2.1.0 doesn't play nice with pint-pandas. Update when new pint-pandas version is released (>0.5) 
 matplotlib = "^3.7.2"
 pint = "0.19.2"
@@ -41,10 +41,10 @@ sphinx-rtd-theme = "^1.3.0"
 insegel = "^1.3.1"
 nbsphinx = "^0.9.3"
 pandoc = "^2.3"
+pip-tools = "^7.4.1"
 IPython = "^8.23.0"
 
 
-
 [tool.poetry.group.dev.dependencies]
 flake8 = "^6.1.0"
 black = "^23.7.0"