Metadata-Version: 2.1
Name: zynamon
Version: 0.0.3
Summary: Generalized & powerful time-series class and related functions
Author-email: "Dr. Marcus Zeller" <dsp4444@gmail.com>
License: 
        This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation (GPL v3, or any later version).
        
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
        GNU General Public License for more details.
        
        You should have received a copy of the GNU General Public License
        along with this program. If not, see <http://www.gnu.org/licenses/>.
        
Project-URL: Homepage, https://github.com/zynt3c/zynamon
Project-URL: Package, https://pypi.org/project/zynamon/
Keywords: time-series,monitoring,analysis,prediction
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h5py
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: plotly
Requires-Dist: scipy

# zynamon

## Synopsis

Generalized & powerful time-series class and related functions.

## Contents

This library defines a powerful time-series representation based on the well-known ```pandas``` DataFrames. However, it adds meta-data as well as conveniently built-in filtering & alignment routines for both value and time dimension. Moreover, the central time-series objects can be constructed from *nearly any 1D data* such that handling of various sources in a standardised way is made possible (e.g. regularly-sampled sensor data, event logs as well as audio streams).

As of now, this package is structured into the following modules:

**tscore**: main file, defining classes ```TimeSeries``` and special ```TimeSpec``` as well as some helpers

**tsutils**: routines for the automatic import of time-series data from CSV files and operators on two objects (involving a routine to make the objects "coherent" in time)

**tsvis**: classes related to a well-defined "mass visualisation" of TimeSeries objects in automated scripts

**batchimport**: helpers for the mass import, conversion & aggregation of data from (many!) CSV-files (e.g. proper extraction of all individual time-series hidden in event logs)

**xutils**: special conversion utilities for CSV-files containing DFT spectra as generated by the software "CMS X-Tools" (Siemens AG).

*Note: Structuring & naming above will be s.t. refactoring and thus change in future versions. That is, backward compatibility IS LIKELY to break soon!*

[ Dr. Marcus Zeller | dsp4444@gmail.com | Erlangen, Germany | 2022-2024 ]
