From 9e050c1454887869448ba6a1a2eb50f00c7d32df Mon Sep 17 00:00:00 2001
From: Niklas Selke <n.selke@fz-juelich.de>
Date: Thu, 13 Jul 2023 09:32:14 +0200
Subject: [PATCH] Added a short description of the 'custom' sampling.
---
README.md | 6 ++++--
toarstats/metrics/interface.py | 4 +++-
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 77991cf..815fd74 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,7 @@ calculate_statistics(
:param sampling: temporal aggregation, one of ``daily``,
``monthly``, ``seasonal``, ``vegseason``,
- ``summer``, ``xsummer``, or ``annual``;
+ ``summer``, ``xsummer``, ``annual``, or ``custom``;
``summer`` will pick the 6-months summer season in
the hemisphere where the station is located;
``xsummer`` does the same for a 7-months summer
@@ -57,7 +57,9 @@ calculate_statistics(
``vegseason`` requires also the ``crops`` argument
and will then determine the appropriate growing
seasons based on the ``climatic_zone`` metadata and
- crop type
+ crop type;
+ ``custom`` will create one aggregate value over the
+ entire time series
:param statistics: a single statistic or metric or a list of
statistics and metrics to call, these must be
defined in ``stats.py`` or ``ozone_metrics.py``
diff --git a/toarstats/metrics/interface.py b/toarstats/metrics/interface.py
index 28c88ae..8bbccf6 100644
--- a/toarstats/metrics/interface.py
+++ b/toarstats/metrics/interface.py
@@ -34,7 +34,9 @@ def calculate_statistics(
``vegseason`` requires also the ``crops`` argument
and will then determine the appropriate growing
seasons based on the ``climatic_zone`` metadata and
- crop type
+ crop type;
+ ``custom`` will create one aggregate value over the
+ entire time series
:param statistics: a single statistic or metric or a list of
statistics and metrics to call, these must be
defined in ``stats.py`` or ``ozone_metrics.py``
--
GitLab