Skip to content
Snippets Groups Projects
Commit 6e4f52c2 authored by Niklas Selke's avatar Niklas Selke
Browse files

Updated everything to the v0.5.0 release.

parent 3b9ee13f
Branches
Tags
1 merge request!9Develop
# Changelog
All notable changes to this project will be documented in this file.
## v0.5.0 - 2023-06-06 - moving block bootstrap
### general:
* implemented trend analysis tools after TOAR statistical guidance note
### new features:
* trend analysis tools now use moving block bootstrap
### technical:
* restructured and expanded testing
## v0.4.0 - 2023-02-21 - renaming of metrics
### general:
......
......@@ -139,20 +139,25 @@ import toarstats.trends
The `calculate_trend` interface is defined like this:
```
calculate_trend(method, data, formula="value ~ datetime", quantiles=None):
calculate_trend(method, data, quantiles=None, num_samples=1000)
"""Calculate the trend using the requested method.
This function is the public interface for the ``trends`` subpackage.
It takes all the user inputs and returns the result of the requested
trend analysis.
The calculation follows "Guidance note on best statistical practices
for TOAR analyses" (Chang et al. 2023,
https://arxiv.org/pdf/2304.14236.pdf) Annex E.
:param method: either ``"OLS"`` or ``"quant"``
:param data: data containing a list of date time values and
associated parameter values on which to calculate the
trend
:param formula: the formula specifying the model
:param quantiles: a single quantile or a list of quantiles to
calculate, these must be between 0 and 1; only
needed when ``method="quant"``
:param num_samples: number of sampled trends in moving block
bootstrap
"""
```
File added
......@@ -9,7 +9,7 @@
project = 'toarstats'
copyright = '2021, Forschungszentrum Jülich GmbH'
author = 'Niklas Selke'
release = '0.4.0'
release = '0.5.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
......
numpy==1.24.3
pandas==2.0.1
pandas==2.0.2
scipy==1.10.1
statsmodels==0.14.0
[metadata]
name = toarstats
version = 0.4.0
version = 0.5.0
author = Niklas Selke
author_email = n.selke@fz-juelich.de
description = Collection of statistics for the TOAR community
......@@ -13,7 +13,6 @@ classifiers =
Operating System :: OS Independent
Programming Language :: Python :: 3
Programming Language :: Python :: 3 :: Only
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
......@@ -24,7 +23,7 @@ packages =
toarstats
toarstats/metrics
toarstats/trends
python_requires = >=3.7
python_requires = >=3.8
install_requires =
pandas>=1.0
pandas>=2.0
statsmodels>=0.13
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment