pqopen-lib 0.2.0__tar.gz

pqopen_lib-0.2.0/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pqopen_lib-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 DaqOpen
+
+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.

pqopen_lib-0.2.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: pqopen-lib
+Version: 0.2.0
+Summary: A power quality processing library for calculating parameters from waveform data
+Project-URL: Homepage, https://github.com/DaqOpen/pqopen-lib
+Project-URL: Issues, https://github.com/DaqOpen/pqopen-lib/issues
+Author-email: Michael Oberhofer <info@pqopen.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: daqopen-lib
+Requires-Dist: numpy
+Requires-Dist: scipy
+Description-Content-Type: text/markdown
+
+# pqopen-lib
+
+`pqopen-lib` is a Python library designed for advanced power system and power quality analysis. It provides tools for creating and analyzing power systems, detecting events, managing data storage, and more. Built with modularity and flexibility in mind, it supports single-phase to multi-phase systems and complies with IEC standards for power quality analysis.
+
+
+
+## Features
+
+- **Power System Modeling**: Create single-phase or multi-phase power systems with detailed phase configuration.
+- **Power Quality Analysis**: Perform harmonic, fluctuation, and power quality calculations in compliance with standards like IEC 61000-4-7 and IEC 61000-4-30.
+- **Event Detection**: Detect and classify events such as overvoltage, undervoltage, and other anomalies in real-time.
+- **Data Storage and Export**: Manage time-series and aggregated data with support for various storage backends like CSV, and MQTT
+- **Zero-Crossing Detection**: Enable accurate cycle-by-cycle processing for fundamental frequency synchronization.
+- **High Performance**: Efficiently handle high-resolution waveform data and sampling rates.
+
+
+
+## Installation
+
+Ensure you have Python 3.11 or later installed. To install `pqopen-lib` along with its dependencies:
+
+```bash
+pip install pqopen-lib
+```
+
+
+
+## Documentation
+
+Detailed [documentation](https://docs.daqopen.com/reference/pqopen/) is available for each module and function. Key modules include:
+
+- **`powersystem`**: Define and manage power systems and phases.
+- **`powerquality`**: Perform power quality and harmonic analyses.
+- **`eventdetector`**: Detect and analyze power events.
+- **`storagecontroller`**: Manage and export time-series and aggregated data.
+- **`zcd`**: Handle zero-crossing detection for waveform synchronization.
+
+
+
+## Use Cases
+
+- **Education**: Learn to understand how power and power quality analysis works
+- **Power Quality Monitoring**: Ensure compliance with power quality standards.
+- **Industrial Power Systems**: Monitor and analyze complex, multi-phase systems.
+- **Research and Development**: Use as a reference platform for power quality testing
+
+
+
+## Getting Started
+
+Here’s a quick example to get you started:
+
+### Create a Simple Power System
+
+```python
+import numpy as np
+
+from pqopen.powersystem import PowerSystem
+from daqopen.channelbuffer import AcqBuffer
+
+samplerate = 10_000 # Hz
+signal_duration = 1.0 # seconds
+
+voltage_magnitude = 230.0 # Volt
+current_magnitude = 10.0 # Ampere
+
+frequency = 50.0 # Hz
+
+# Create time signal
+t = np.linspace(0,int(signal_duration),int(samplerate*signal_duration),endpoint=False)
+# Create voltage signal
+u = voltage_magnitude*np.sqrt(2)*np.sin(2*np.pi*t*frequency)
+# Create current signal
+i = current_magnitude*np.sqrt(2)*np.sin(2*np.pi*t*frequency)
+
+# Create Channel/Buffer for input waveform
+ch_t = AcqBuffer()
+ch_u = AcqBuffer()
+ch_i = AcqBuffer()
+
+# Create minimal power system
+my_power_system = PowerSystem(zcd_channel=ch_u,
+                              input_samplerate=samplerate)
+
+# Create power phase and append to power system
+my_power_system.add_phase(u_channel=ch_u, i_channel=ch_i)
+
+# Add data to channels (we can apply all data at once because the 
+# buffer is big enough to hold the test dataset)
+ch_t.put_data(t)
+ch_u.put_data(u)
+ch_i.put_data(i)
+
+# Perform calculation
+my_power_system.process()
+
+# View the results
+for ch_name, ch_buffer in my_power_system.output_channels.items():
+    print(f"{ch_name:<14} {ch_buffer.last_sample_value:.2f} {ch_buffer.unit}")
+```
+
+
+
+## Contributing
+
+Contributions are welcome! Please open issues for bugs or feature requests and submit pull requests for improvements.
+
+1. Fork the repository.
+2. Create your feature branch (`git checkout -b feature/my-feature`).
+3. Commit your changes (`git commit -m 'Add my feature'`).
+4. Push to the branch (`git push origin feature/my-feature`).
+5. Open a pull request.
+
+
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+------
+
+For any questions or support, feel free to reach out via the issues page or contact me michael@daqopen.com

pqopen_lib-0.2.0/README.md

@@ -0,0 +1,122 @@
+# pqopen-lib
+
+`pqopen-lib` is a Python library designed for advanced power system and power quality analysis. It provides tools for creating and analyzing power systems, detecting events, managing data storage, and more. Built with modularity and flexibility in mind, it supports single-phase to multi-phase systems and complies with IEC standards for power quality analysis.
+
+
+
+## Features
+
+- **Power System Modeling**: Create single-phase or multi-phase power systems with detailed phase configuration.
+- **Power Quality Analysis**: Perform harmonic, fluctuation, and power quality calculations in compliance with standards like IEC 61000-4-7 and IEC 61000-4-30.
+- **Event Detection**: Detect and classify events such as overvoltage, undervoltage, and other anomalies in real-time.
+- **Data Storage and Export**: Manage time-series and aggregated data with support for various storage backends like CSV, and MQTT
+- **Zero-Crossing Detection**: Enable accurate cycle-by-cycle processing for fundamental frequency synchronization.
+- **High Performance**: Efficiently handle high-resolution waveform data and sampling rates.
+
+
+
+## Installation
+
+Ensure you have Python 3.11 or later installed. To install `pqopen-lib` along with its dependencies:
+
+```bash
+pip install pqopen-lib
+```
+
+
+
+## Documentation
+
+Detailed [documentation](https://docs.daqopen.com/reference/pqopen/) is available for each module and function. Key modules include:
+
+- **`powersystem`**: Define and manage power systems and phases.
+- **`powerquality`**: Perform power quality and harmonic analyses.
+- **`eventdetector`**: Detect and analyze power events.
+- **`storagecontroller`**: Manage and export time-series and aggregated data.
+- **`zcd`**: Handle zero-crossing detection for waveform synchronization.
+
+
+
+## Use Cases
+
+- **Education**: Learn to understand how power and power quality analysis works
+- **Power Quality Monitoring**: Ensure compliance with power quality standards.
+- **Industrial Power Systems**: Monitor and analyze complex, multi-phase systems.
+- **Research and Development**: Use as a reference platform for power quality testing
+
+
+
+## Getting Started
+
+Here’s a quick example to get you started:
+
+### Create a Simple Power System
+
+```python
+import numpy as np
+
+from pqopen.powersystem import PowerSystem
+from daqopen.channelbuffer import AcqBuffer
+
+samplerate = 10_000 # Hz
+signal_duration = 1.0 # seconds
+
+voltage_magnitude = 230.0 # Volt
+current_magnitude = 10.0 # Ampere
+
+frequency = 50.0 # Hz
+
+# Create time signal
+t = np.linspace(0,int(signal_duration),int(samplerate*signal_duration),endpoint=False)
+# Create voltage signal
+u = voltage_magnitude*np.sqrt(2)*np.sin(2*np.pi*t*frequency)
+# Create current signal
+i = current_magnitude*np.sqrt(2)*np.sin(2*np.pi*t*frequency)
+
+# Create Channel/Buffer for input waveform
+ch_t = AcqBuffer()
+ch_u = AcqBuffer()
+ch_i = AcqBuffer()
+
+# Create minimal power system
+my_power_system = PowerSystem(zcd_channel=ch_u,
+                              input_samplerate=samplerate)
+
+# Create power phase and append to power system
+my_power_system.add_phase(u_channel=ch_u, i_channel=ch_i)
+
+# Add data to channels (we can apply all data at once because the 
+# buffer is big enough to hold the test dataset)
+ch_t.put_data(t)
+ch_u.put_data(u)
+ch_i.put_data(i)
+
+# Perform calculation
+my_power_system.process()
+
+# View the results
+for ch_name, ch_buffer in my_power_system.output_channels.items():
+    print(f"{ch_name:<14} {ch_buffer.last_sample_value:.2f} {ch_buffer.unit}")
+```
+
+
+
+## Contributing
+
+Contributions are welcome! Please open issues for bugs or feature requests and submit pull requests for improvements.
+
+1. Fork the repository.
+2. Create your feature branch (`git checkout -b feature/my-feature`).
+3. Commit your changes (`git commit -m 'Add my feature'`).
+4. Push to the branch (`git push origin feature/my-feature`).
+5. Open a pull request.
+
+
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+------
+
+For any questions or support, feel free to reach out via the issues page or contact me michael@daqopen.com

pqopen_lib-0.2.0/pqopen/__init__.py

@@ -0,0 +1,11 @@
+# pqopen/__init__.py
+
+""" Power and power quality processing library
+
+Modules:
+    powersystem: Create single to multi-phase power systems
+    powerquality: Collection of Classes and functions for power quality analysis
+    zcd: Zero cross detector for cycle-by-cycle processing
+    helper: Some helper functions and classes
+
+"""

pqopen_lib-0.2.0/pqopen/eventdetector.py

@@ -0,0 +1,184 @@
+import numpy as np
+from daqopen.channelbuffer import DataChannelBuffer, AcqBuffer
+from persistmq.client import PersistClient
+from pathlib import Path
+from typing import List, Dict
+import logging
+import json
+import uuid
+from dataclasses import dataclass
+
+logger = logging.getLogger(__name__)
+
+@dataclass
+class Event:
+    start_ts: float
+    stop_ts: float
+    start_sidx: int
+    stop_sidx: int
+    extrem_value: float
+    channel: str
+    type: str
+    id: uuid.UUID
+
+
+class EventDetector(object):
+    def __init__(self, limit: float, threshold: float, observed_channel: DataChannelBuffer):
+        self.limit = limit
+        self.threshold = threshold
+        self.observed_channel = observed_channel
+        self.last_channel_data = None
+        self.last_channel_sidx = None
+        self._unfinished_event = {}
+        self._type = ""
+
+    def process(self, start_sidx: int, stop_sidx: int):
+        ...
+
+    def _get_channel_data(self, start_sidx, stop_sidx):
+        data, sidx = self.observed_channel.read_data_by_acq_sidx(start_sidx, stop_sidx)
+        if data.size < 1:
+            return None, None
+        if self.last_channel_data:
+            data = np.r_[self.last_channel_data, data]
+            sidx = np.r_[self.last_channel_sidx, sidx]
+        self.last_channel_data = data[-1]
+        self.last_channel_sidx = sidx[-1]
+        return data, sidx
+
+class EventDetectorLevelLow(EventDetector):
+    def __init__(self, limit: float, threshold: float, observed_channel: DataChannelBuffer):
+        super().__init__(limit, threshold, observed_channel)
+        self._type = "LEVEL_LOW"
+
+    def process(self, start_sidx, stop_sidx):
+        data, sidx = self._get_channel_data(start_sidx, stop_sidx)
+        if data is None:
+            return None
+        limit_cross = np.diff(np.sign(data - self.limit))
+        limit_cross_idx = np.where(limit_cross < 0)[0] + 1 # take next index
+        threshold_cross = np.diff(np.sign(data - self.limit - self.threshold))
+        threshold_cross_idx = np.where(threshold_cross > 0)[0] + 1 # take next index
+        events = []
+        if self._unfinished_event:
+            events.append(self._unfinished_event)
+            limit_cross_idx = np.r_[0, limit_cross_idx]
+        evt_stop_idx = 0
+        for limit_idx in limit_cross_idx:
+            if limit_idx < evt_stop_idx:
+                continue
+            if limit_idx > 0: # Add new event
+                events.append({"start_sidx": int(sidx[limit_idx]), "stop_sidx": None, "extrem_value": np.inf, "id": uuid.uuid4()})
+            evt_stop_thr_idx = np.where(threshold_cross_idx > limit_idx)[0]
+            if evt_stop_thr_idx.size > 0: # complete event
+                logger.debug("Event Completed")
+                evt_stop_idx = threshold_cross_idx[evt_stop_thr_idx[0]]
+                events[-1]["stop_sidx"] = int(sidx[evt_stop_idx])
+                events[-1]["extrem_value"] = min(events[-1]["extrem_value"], data[limit_idx:evt_stop_idx].min())
+            else:
+                events[-1]["extrem_value"] = min(events[-1]["extrem_value"], data[limit_idx:].min())
+                break
+
+        if events and events[-1]["stop_sidx"] is None:
+            self._unfinished_event = events[-1]
+        else:
+            self._unfinished_event = {}
+        
+        return events
+
+class EventDetectorLevelHigh(EventDetector):
+    def __init__(self, limit: float, threshold: float, observed_channel: DataChannelBuffer):
+        super().__init__(limit, threshold, observed_channel)
+        self._type = "LEVEL_HIGH"
+
+    def process(self, start_sidx, stop_sidx):
+        data, sidx = self._get_channel_data(start_sidx, stop_sidx)
+        if data is None:
+            return None
+        limit_cross = np.diff(np.sign(data - self.limit))
+        limit_cross_idx = np.where(limit_cross > 0)[0] + 1 # take next index
+        threshold_cross = np.diff(np.sign(data - self.limit + self.threshold))
+        threshold_cross_idx = np.where(threshold_cross < 0)[0] + 1 # take next index
+        events = []
+        if self._unfinished_event:
+            events.append(self._unfinished_event)
+            limit_cross_idx = np.r_[0, limit_cross_idx]
+        evt_stop_idx = 0
+        for limit_idx in limit_cross_idx:
+            if limit_idx < evt_stop_idx:
+                continue
+            if limit_idx > 0: # Add new event
+                events.append({"start_sidx": int(sidx[limit_idx]), "stop_sidx": None, "extrem_value": -np.inf, "id": uuid.uuid4()})
+            evt_stop_thr_idx = np.where(threshold_cross_idx > limit_idx)[0]
+            if evt_stop_thr_idx.size > 0: # complete event
+                logger.debug("Event Completed")
+                evt_stop_idx = threshold_cross_idx[evt_stop_thr_idx[0]]
+                events[-1]["stop_sidx"] = int(sidx[evt_stop_idx])
+                events[-1]["extrem_value"] = max(events[-1]["extrem_value"], data[limit_idx:evt_stop_idx].max())
+            else:
+                events[-1]["extrem_value"] = max(events[-1]["extrem_value"], data[limit_idx:].max())
+                break
+
+        if events and events[-1]["stop_sidx"] is None:
+            self._unfinished_event = events[-1]
+        else:
+            self._unfinished_event = {}
+        
+        return events
+        
+
+class EventController(object):
+    PROCESSING_DELAY_SECONDS = 0.1
+
+    def __init__(self, time_channel: AcqBuffer, sample_rate: float):
+        self._time_channel = time_channel
+        self._sample_rate = sample_rate
+        self._event_detectors: List[EventDetector] = []
+        self._last_processed_sidx = 0
+        self._unfinished_events: Dict[uuid.UUID: Event] = {}
+    
+    def add_event_detector(self, event_detector: EventDetector):
+        self._event_detectors.append(event_detector)
+
+    def process(self) -> List[Event]:
+        start_acq_sidx = self._last_processed_sidx
+        stop_acq_sidx = self._time_channel.sample_count - int(self.PROCESSING_DELAY_SECONDS*self._sample_rate)
+        start_sidx_ts = int(self._time_channel.read_data_by_index(start_acq_sidx, start_acq_sidx+1)[0])
+        self._last_processed_sidx = stop_acq_sidx
+        if stop_acq_sidx <= 0:
+            return []
+        all_events = []
+        for event_detector in self._event_detectors:
+            events = event_detector.process(start_acq_sidx, stop_acq_sidx)
+            if events:
+                for event in events:
+                    if event["id"] in self._unfinished_events:
+                        start_ts = self._unfinished_events[event["id"]].start_ts
+                    else:
+                        start_ts = self._time_channel.read_data_by_index(event["start_sidx"], event["start_sidx"]+1)[0]/1e6
+                    if event["stop_sidx"]:
+                        stop_ts = self._time_channel.read_data_by_index(event["stop_sidx"], event["stop_sidx"]+1)[0]/1e6
+                        # Delete finished event from map
+                        if event["id"] in self._unfinished_events:
+                            del self._unfinished_events[event["id"]]
+                    else:
+                        stop_ts = None
+                    single_event = Event(start_ts=start_ts,
+                                         stop_ts=stop_ts if stop_ts else None,
+                                         start_sidx=event["start_sidx"],
+                                         stop_sidx=event["stop_sidx"],
+                                         extrem_value=event["extrem_value"],
+                                         channel=event_detector.observed_channel.name,
+                                         type=event_detector._type,
+                                         id=event["id"])
+                    all_events.append(single_event)
+                    # Add unfinished event to map
+                    if single_event.stop_sidx is None:
+                        self._unfinished_events[single_event.id] = single_event
+        return all_events
+
+
+    
+        
+
+

pqopen_lib-0.2.0/pqopen/helper.py

@@ -0,0 +1,19 @@
+from datetime import datetime
+
+def floor_timestamp(timestamp: float | int, interval_seconds: int, ts_resolution: str = "us"):
+    """Floor eines Zeitstempels auf ein gegebenes Intervall."""
+    if ts_resolution == "s":
+        conversion_factor = 1.0
+    elif ts_resolution == "ms":
+        conversion_factor = 1_000.0
+    elif ts_resolution == "us":
+        conversion_factor = 1_000_000.0
+    else:
+        raise NotImplementedError(f"Time interval {ts_resolution} not implemented")
+    if isinstance(timestamp, float):
+        seconds = timestamp / conversion_factor
+        floored_seconds = seconds - (seconds % interval_seconds)
+        return floored_seconds * conversion_factor
+    else:
+        fraction = timestamp % int(conversion_factor*interval_seconds)
+        return timestamp - fraction