From ec5dd467782619da6e67a88a8f7761de760761f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zoufin=C3=A9=20Lauer-Bar=C3=A9?= <82505312+zolabar@users.noreply.github.com> Date: Fri, 2 Feb 2024 17:42:15 +0100 Subject: [PATCH] pip install command --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b9f5e6d..5de2ce7 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7009281.svg)](https://doi.org/10.5281/zenodo.7009281) Jupyter Lab: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/zolabar/trendPy/HEAD) Documentation: [![doc](https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg)](https://zolabar.github.io/trendPy/) WebApps: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/zolabar/trendPy/experimental?urlpath=voila%2Frender%2F/trendpy_webapp.ipynb) (binder) [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://zolabar-trendpy-trendpy2-app-kfqshb.streamlit.app/) +# Usage +```pip install trendpy2``` - - -Use the package **TrendPy** as shown in the ```example.ipynb``` to use +and use it as **TrendPy** as shown in the ```example.ipynb``` and approxmiate your time series with the following trends * linear $f(x)=a\cdot x+b$ * polynomial $f(x)=a_n\cdot x^n+a_{n-1}\cdot x^{n-1}+...+a_0$ @@ -14,11 +14,12 @@ Use the package **TrendPy** as shown in the ```example.ipynb``` to use * trigonometric $f(x)=a\cdot \cos(2\cdot \pi\cdot b\cdot x+c)$ * "free" (for max. three parameters) (e.g.```a*arctan(b*x+c)```, ```a*exp(b*x+c)```, ```a*(x*b)+c```), the intial guess for a, b, c is 1. -regressions in your Python scripts or jupyter notebooks or use the **WebApp** with the correspondig button above. +in your Python scripts or jupyter notebooks and use the best of the numerical and symbolic worlds to make predictions and assess the quality of your fit! + +or use the one of the **WebApps** with the correspondig button above (voila app or streamlit app). For more, have a look at the [**sphinx-documentation**](https://zolabar.github.io/trendPy/)! -The webApp is listed in the [Voila Gallery](https://voila-gallery.org/)!