Skip to content

xtreamsrl/pytsviz

Repository files navigation

pytsviz

GitHub GitHub issues Open In Colab Downloads Documentation Status GitHub Workflow Status

pytsviz is a suite of tools to quickly analyze and visualize time series data. It is partially based on the tsviz R package.

The utils module contains a set of useful utilities, not strictly related to visualization, we often use (e.g. harmonics computation).

The viz module contains functions for plotting univariate time series, as well as performing quick qualitative analyses such as decompositions, correlations and so on.

Some visualizations mimic the R packages ggplot2 and forecast, as presented in the textbook Forecasting: principles and practice by Rob J. Hyndman and George Athanasopoulos. The online version of the text can be found here.

Install

The preferred way to install the package is using pip, but you can also download the code and install from source

To install the package using pip:

pip install pytsviz

Develop

After cloning, you need to install and setup Poetry. See instructions.

Then, inside the project directory, run:

poetry install
pre-commit install

Then, you're good to go.

You're free to submit your pull requests. Just make sure they follow conventional commit rules. This can be enforced by the commitizen tool, which is also included among the package dependencies.

Please also make sure that function documentation is consistent. We are currently using Sphinx docstrings.

Who we are

A proudly 🇮🇹 software development and data science startup.
We consider ourselves a family of talented and passionate people building their own products and powerful solutions for our clients. Get to know us more on xtreamers.io or follow us on LinkedIn.