Metadata-Version: 2.1
Name: virtual-anomaly
Version: 0.1.2
Summary: A python package for making virtual anomalies in one dimensional data.
License: MIT
Author: Yacine Bel-Hadj
Author-email: yacine.bel-hadj@vub.be
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: torch (>=2.0.0,<3.0.0)
Description-Content-Type: text/markdown

# Virtual Anomaly Simulation 

## Overview

**Virtual Anomaly Simulation** is a Python package designed with torch to facilitate the testing of anomaly detection algorithms. Primarily focused on altering the spectral content of signals, this package can also be applied to any 1D data. It provides tools to modify and manipulate data, allowing you to simulate various anomalies and shifts, which are critical for robust algorithm testing.

## Features

- **DelayPart**: A module that shifts a windowed portion of a signal. It is particularly useful for testing the detection of delays or shifts in spectral content.
  
- **AddSpike**: A module that adds or alters harmonics within a PSD/ FFT, making it easier to test the ability of algorithms to detect changes in frequency components.

## Installation

You can install the package via pip:

```bash
pip install virual-anomaly
```

