Skip to content
Snippets Groups Projects
Commit 6e391c14 authored by Martin Lange's avatar Martin Lange
Browse files

add section on caveats, minor doc fixes

parent 07bc7618
No related branches found
No related tags found
1 merge request!199Blog post for new time adapters
Pipeline #131091 passed with stages
in 4 minutes and 24 seconds
......@@ -73,3 +73,15 @@ FINAM provides these time integration adapters:
.. note::
The :class:`SumOverTime <.adapters.SumOverTime>` adapter may change units, depending on the setup.
This also allows to transform rates into amounts, like *mm/d* to total *mm*.
Caveats
^^^^^^^
During the initial pull in :doc:`/finam-book/development/connect_phase`, time integration adapters cannot provide sensible output.
This is because there is only a single data entry available, and the time span of the previous step is not defined.
* For :class:`.adapters.AvgOverTime`, the available data entry is simply returned and interpreted as the average.
* For :class:`.adapters.SumOverTime`, treatment depends on whether the incoming data is on a per-time basis.
See the API docs for details.
Ideally, components don't rely on the initial data if it is foreseeable to be aggregated by a time integration adapter.
......@@ -46,7 +46,7 @@ Data
After metadata was exchanged along a link in both directions, data can be passed.
Components must provide initial data for all outputs.
Further, components can pull data from inputs during The Connect Phase &trade;.
Further, components can pull data from inputs during The Connect Phase.
Iterative connect
-----------------
......@@ -60,7 +60,7 @@ Components indicate their connect progress via their :attr:`status <.Component.s
* :attr:`.ComponentStatus.CONNECTING_IDLE` if nothing was exchanged that was not already in a previous call
The status is managed internally by the component's :meth:`.Component.try_connect` method.
It can, however, be used to check in :meth:`.Component._connect` if The Connect Phase &trade; was completed.
It can, however, be used to check in :meth:`.Component._connect` if The Connect Phase was completed.
Circular dependencies
---------------------
......
......@@ -206,7 +206,7 @@ class SumOverTime(TimeIntegrationAdapter):
* ``per_time=False``, value=1mm, step=2x5d --> 2mm
initial_interval: :class:`datetime <datetime.datetime>`, optional
Time scaling duration for the initial data. Defaults to 0 days.
Time scaling duration for the initial data, if ``per_time=True``. Defaults to 0 days.
See also
--------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment