SignalForge 0.0.2__tar.gz

signalforge-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 GiulioCurti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

signalforge-0.0.2/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

signalforge-0.0.2/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: SignalForge
+Version: 0.0.2
+Summary: Tools for analyzing and generating non-Gaussian, non-stationary signals in engineering applications.
+Home-page: https://github.com/GiulioCurti/SignalForge
+Author: Giulio Curti
+Author-email: giulio.curti@dottorandi.unipg.it
+License: MIT license
+License-File: LICENSE
+Requires-Dist: numpy>=2.0
+Requires-Dist: scipy
+Requires-Dist: matplotlib>=3.10
+Requires-Dist: tqdm
+Requires-Dist: PyWavelets
+Requires-Dist: pyNNST
+Requires-Dist: statsmodels
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary

signalforge-0.0.2/README.md

@@ -0,0 +1,118 @@
+[![SignalForge Testing](https://github.com/GiulioCurti/SignalForge/actions/workflows/python-app.yml/badge.svg)](https://github.com/GiulioCurti/SignalForge/actions/workflows/python-app.yml)
+[![Documentation Status](https://app.readthedocs.org/projects/signalforge/badge/?version=latest)](https://signalforge.readthedocs.io/en/latest/)
+
+SignalForge
+-----------
+
+SignalForge is an open-source Python package that provides a comprehensive set of tools for analyzing and generating non-Gaussian, non-stationary signals in engineering applications. While traditional signal processing methods often rely on assumptions of Gaussianity and stationarity, real-world signals—especially those found in mechanical systems—frequently deviate from these idealized models. SignalForge bridges this gap by offering advanced, yet user-friendly tools to simulate, inspect, and manipulate signals with complex statistical properties. Whether you're designing loads for testing, exploring time-varying behavior, or developing new algorithms, SignalForge enables you to work with signals that better reflect real operating conditions. Built with extensibility and clarity in mind, the package is suitable for researchers, practitioners, and students working across mechanical engineering, signal processing, and beyond.
+
+See the [documentation](<https://signalforge.readthedocs.io/en/latest/>) for a complete overview of the implemented methods for analisys and signal generation.
+
+Installing SignalForge
+------------------------------------------------------------
+The package is published in PiPy. To install it:
+```bash
+pip install signalforge
+```
+
+Example code on how to generate a Stationary Gaussian Signal
+------------------------------------------------------------
+
+Stationary Gaussian signals can be easily generated via the specific class StationaryGaussian. Its usage is briefly shown in the following example code:
+
+```python
+from SignalForge import StationaryGaussian
+
+fpsd = [10,20]  # Frequency vector [Hz]
+psd = [1,1]     # Power density vecrtor [(m/s^2)^2/Hz]
+fs = 200        # Sampling frequency [Hz]
+T = 200         # Time duration [s]
+gauss_signal = StationaryGaussian(
+    fpsd=fpsd, 
+    psd=psd, 
+    fs=fs, 
+    T = T, 
+    name = 'Stationary Gaussian', 
+    unit='$m/s^2$'
+    ) # StationaryGaussian class initialization
+print(gauss_signal)
+gauss_signal.plot()           # Plotting Timehistory
+gauss_signal.plot_psd()       # Plotting Power spectral density 
+```
+Implemented non-linear transformartion methods to add non-gaussianity are the following:
+
+-	Hermite-Winterstein ('winter')
+-	Cubic polynomial ('cubic')
+-	Hyperbolic transform – Zheng (‘zheng’)
+-	Sarkani ('sarkani') 
+-	Improved nonlinear transform ('zmnl')
+-	Steinwolf ('steinwolf')
+-	Smallwoood Poisson shots ('smallwood')
+-	Van Baren ('vanbaren')  
+
+Example code on how to generate a Stationary Non Gaussian Signal
+------------------------------------------------------------
+
+Stationary non Gaussian signals can be easily generated via the specific class StationaryNonGaussian. Its usage is briefly shown in the following example code:
+
+```python
+from SignalForge import StationaryNonGaussian
+
+fpsd = [10,20]  # Frequency vector [Hz]
+psd = [1,1]     # Power density vecrtor [(m/s^2)^2/Hz]
+fs = 200        # Sampling frequency [Hz]
+T = 200         # Time duration [s]
+input_kurtosis = 6
+nongauss_signal = StationaryNonGaussian(
+    fpsd = fpsd, 
+    psd = psd,
+    T = T, 
+    kurtosis=input_kurtosis,
+    fs = fs, 
+    method='zmnl', 
+    name = 'Stationary NonGaussian', 
+    unit='$m/s^2$'
+    ) # StationaryNonGaussian class initalization
+print(nongauss_signal)
+nongauss_signal.plot()      # Plotting Timehistory
+nongauss_signal.plot_psd()  # Plotting Power spectral density 
+nongauss_signal.plot_fft()  # Plotting Fourier Transform
+```
+
+Example code on how to generate a Non Stationary Non Gaussian Signal
+------------------------------------------------------------
+
+Non stationary non Gaussian signals can be easily generated via the specific class NonStationaryGaussian. Its usage is briefly shown in the following example code:
+
+```python
+from SignalForge import NonStationaryNonGaussian
+
+fpsd = [10,20]  # Frequency vector [Hz]
+psd = [1,1]     # Power density vecrtor [(m/s^2)^2/Hz]
+fs = 200        # Sampling frequency [Hz]
+T = 200         # Time duration [s]
+params = {'input_kurtosis': 10}
+nonstat_signal = NonStationaryNonGaussian(
+    fpsd = fpsd, 
+    psd = psd, 
+    T = T,
+    params = params,
+    fs = fs, 
+    method='trapp_am', 
+    name = 'NonStationary NonGaussian', 
+    unit='$m/s^2$'
+    ) # NonStationaryNonGaussian class initalization
+print(nonstat_signal)
+nonstat_signal.plot()      # Plotting Timehistory
+nonstat_signal.plot_psd()  # Plotting Timehistory
+nonstat_signal.plot_sftf()  # Plotting Short Time Fourier Transform
+```
+Implemented transformartion methods to build non-gaussianity signals are the following:
+
+-	Beta amplitude modulation ('beta_am')
+-	Gaussian amplitude modulation ('trapp_am')
+-	Rayleigh amplitude modulation ('ray_am') 
+-	Frequency modulation via STFT ('fm')
+
+
+

signalforge-0.0.2/SignalForge/__init__.py

@@ -0,0 +1,6 @@
+__version__ = '0.0.2'
+from .single_chan_signal import *
+from .stationary_gaussian import *
+from .stationary_nongaussian import *
+from .nonstationary_nongaussian import *
+from .utils import *