OpenIRF 0.1.0__tar.gz

openirf-0.1.0/.gitignore

@@ -0,0 +1,25 @@
+# OS files
+*.DS_Store
+thumbs.db
+
+# Python cache
+**/__pycache__/*
+
+# Matlab files
+*.mat
+
+# Build files
+**/dist/*
+*.egg-info
+
+# Pytest
+*.xml
+
+# Coverage
+.coverage
+
+# Sphinx
+**/_build/*
+**/_static/*
+**/_templates/*
+docs/generated/*

openirf-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,56 @@
+build-job:
+  stage: build
+  image: python:3.14
+  script:
+    # Build Python package
+    - python -m pip install -U build
+    - python -m build
+  artifacts:
+    paths:
+      - "dist/"
+      
+pytest:
+  stage: test
+  image: python:3.14-slim
+  before_script:
+    - pip install .
+  script:
+    - pip install -r requirements_dev.txt
+    - coverage run --source=openirf -m pytest --junitxml=junit.xml
+    - coverage report
+    - coverage xml
+  coverage: '/TOTAL.*\s+(\d+%)$/'
+  artifacts:
+    reports:
+      junit: junit.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+publish-job:
+  stage: deploy
+  image: python:3.14-slim
+  dependencies:
+    - build-job
+    - pytest
+  environment:
+    name: release
+  only:
+    - tags
+  except:
+    - branches
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  script:
+    # Install dependencies
+    - apt update && apt install -y jq curl
+    - python -m pip install -U twine id
+
+    # Retrieve the OIDC token from GitLab CI/CD, and exchange it for a PyPI API token
+    - oidc_token=$(python -m id pypi)
+    - resp=$(curl -X POST https://pypi.org/_/oidc/mint-token -d "{\"token\":\"${oidc_token}\"}")
+    - api_token=$(jq --raw-output '.token' <<< "${resp}")
+
+    # Upload to PyPI authenticating via the newly-minted token
+    - twine upload -u __token__ -p "${api_token}" dist/*

openirf-0.1.0/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.14"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Python requirements
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt

openirf-0.1.0/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "notebook.formatOnSave.enabled": true,
+}

openirf-0.1.0/LICENSE

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 2026 Oliver Maximilian Zobel
+
+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.

openirf-0.1.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: OpenIRF
+Version: 0.1.0
+Summary: An Open-Source Package for Impulse Response Function Estimation
+Author-email: Oliver Maximilian Zobel <oliver.zobel@tum.de>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/openirf/openirf
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Dynamic: license-file
+
+![OpenIRF Logo](https://gitlab.com/openirf/gitlab-profile/-/raw/main/logo_small.png)
+
+# OpenIRF: An Open-Source Package for Impulse Response Function Estimation
+
+![coverage](https://gitlab.com/OliverZobel/openirf/badges/main/coverage.svg)
+[![OpenIRF Build Status](https://app.readthedocs.org/projects/openirf/badge/)](https://openirf.readthedocs.io/)
+
+A collection of tools for the time domain analysis of mechanical systems.
+
+## Installation
+
+To install OpenIRF through pip, use the following command:
+
+`pip install openirf`

openirf-0.1.0/README.md

@@ -0,0 +1,14 @@
+![OpenIRF Logo](https://gitlab.com/openirf/gitlab-profile/-/raw/main/logo_small.png)
+
+# OpenIRF: An Open-Source Package for Impulse Response Function Estimation
+
+![coverage](https://gitlab.com/OliverZobel/openirf/badges/main/coverage.svg)
+[![OpenIRF Build Status](https://app.readthedocs.org/projects/openirf/badge/)](https://openirf.readthedocs.io/)
+
+A collection of tools for the time domain analysis of mechanical systems.
+
+## Installation
+
+To install OpenIRF through pip, use the following command:
+
+`pip install openirf`

openirf-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

openirf-0.1.0/docs/conf.py

@@ -0,0 +1,21 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+project = 'OpenIRF'
+copyright = '2026, Oliver Maximilian Zobel'
+author = 'Oliver Maximilian Zobel'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+extensions = ['sphinx.ext.autodoc','sphinx.ext.autosummary',]
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+autosummary_generate = True
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+html_theme = "sphinx_rtd_theme"

openirf-0.1.0/docs/experimental_irf.rst

@@ -0,0 +1 @@
+ExperimentalIRF Class
   :members:

openirf-0.1.0/docs/index.rst

@@ -0,0 +1,6 @@
+OpenIRF Documentation
+=======================
+
+.. toctree::
+	numerical_irf
+	experimental_irf

openirf-0.1.0/docs/make.bat

@@ -0,0 +1,33 @@
+@ECHO OFF
+
+pushd %~dp0
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

openirf-0.1.0/docs/numerical_irf.rst

@@ -0,0 +1 @@
+NumericalIRF Class
   :members:

openirf-0.1.0/docs/requirements.in

@@ -0,0 +1 @@
+sphinx>=9.0

openirf-0.1.0/docs/requirements.txt

@@ -0,0 +1,61 @@
+#
+# This file is autogenerated by pip-compile with Python 3.14
+# by the following command:
+#
+#    pip-compile docs/requirements.in
+#
+alabaster==1.0.0
+    # via sphinx
+babel==2.18.0
+    # via sphinx
+certifi==2026.2.25
+    # via requests
+charset-normalizer==3.4.6
+    # via requests
+colorama==0.4.6
+    # via sphinx
+docutils==0.22.4
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+idna==3.11
+    # via requests
+imagesize==2.0.0
+    # via sphinx
+jinja2==3.1.6
+    # via sphinx
+markupsafe==3.0.3
+    # via jinja2
+packaging==26.0
+    # via sphinx
+pygments==2.19.2
+    # via sphinx
+requests==2.32.5
+    # via sphinx
+roman-numerals==4.1.0
+    # via sphinx
+snowballstemmer==3.0.1
+    # via sphinx
+sphinx==9.1.0
+    # via
+    #   -r docs/requirements.in
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-jquery
+sphinx-rtd-theme==3.1.0
+    # via -r docs/requirements.in
+sphinxcontrib-applehelp==2.0.0
+    # via sphinx
+sphinxcontrib-devhelp==2.0.0
+    # via sphinx
+sphinxcontrib-htmlhelp==2.1.0
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==2.0.0
+    # via sphinx
+sphinxcontrib-serializinghtml==2.0.0
+    # via sphinx
+urllib3==2.6.3
+    # via requests

openirf-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=61", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "OpenIRF"
+dynamic = ["version"]
+description = "An Open-Source Package for Impulse Response Function Estimation"
+readme = "README.md"
+authors = [
+    {name = "Oliver Maximilian Zobel", email = "oliver.zobel@tum.de"},
+]
+dependencies = [
+    "numpy",
+    "scipy",
+    "matplotlib",
+]
+requires-python = ">=3.11"
+license = "MIT"
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/openirf/openirf"
+
+[tool.setuptools_scm]
+version_scheme = "post-release"
+local_scheme = "node-and-date"
+fallback_version = "0.0.0"

openirf-0.1.0/requirements.txt

@@ -0,0 +1,4 @@
+numpy
+scipy
+matplotlib
+tqdm

openirf-0.1.0/requirements_dev.txt

@@ -0,0 +1,11 @@
+numpy
+scipy
+matplotlib
+tqdm
+
+# Extra dependencies for development
+pytest
+coverage
+sphinx
+sphinx-rtd-theme
+pytest-cov

openirf-0.1.0/ruff.toml

@@ -0,0 +1 @@
+line-length = 160

openirf-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

openirf-0.1.0/src/OpenIRF.egg-info/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: OpenIRF
+Version: 0.1.0
+Summary: An Open-Source Package for Impulse Response Function Estimation
+Author-email: Oliver Maximilian Zobel <oliver.zobel@tum.de>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/openirf/openirf
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Dynamic: license-file
+
+![OpenIRF Logo](https://gitlab.com/openirf/gitlab-profile/-/raw/main/logo_small.png)
+
+# OpenIRF: An Open-Source Package for Impulse Response Function Estimation
+
+![coverage](https://gitlab.com/OliverZobel/openirf/badges/main/coverage.svg)
+[![OpenIRF Build Status](https://app.readthedocs.org/projects/openirf/badge/)](https://openirf.readthedocs.io/)
+
+A collection of tools for the time domain analysis of mechanical systems.
+
+## Installation
+
+To install OpenIRF through pip, use the following command:
+
+`pip install openirf`

openirf-0.1.0/src/OpenIRF.egg-info/SOURCES.txt

@@ -0,0 +1,30 @@
+.gitignore
+.gitlab-ci.yml
+.readthedocs.yaml
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+requirements_dev.txt
+ruff.toml
+.vscode/settings.json
+docs/Makefile
+docs/conf.py
+docs/experimental_irf.rst
+docs/index.rst
+docs/make.bat
+docs/numerical_irf.rst
+docs/requirements.in
+docs/requirements.txt
+src/OpenIRF.egg-info/PKG-INFO
+src/OpenIRF.egg-info/SOURCES.txt
+src/OpenIRF.egg-info/dependency_links.txt
+src/OpenIRF.egg-info/requires.txt
+src/OpenIRF.egg-info/top_level.txt
+src/openirf/__init__.py
+src/openirf/experimental_irf.py
+src/openirf/numerical_irf.py
+src/openirf/utils.py
+tests/mck_import_test.py
+tests/string_print_test.py
+tests/time_series_import_test.py

openirf-0.1.0/src/OpenIRF.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

openirf-0.1.0/src/OpenIRF.egg-info/requires.txt

@@ -0,0 +1,3 @@
+numpy
+scipy
+matplotlib

openirf-0.1.0/src/OpenIRF.egg-info/top_level.txt

@@ -0,0 +1 @@
+openirf

openirf-0.1.0/src/openirf/__init__.py

@@ -0,0 +1,3 @@
+from .experimental_irf import ExperimentalIRF
+from .numerical_irf import NumericalIRF
+from .utils import *

openirf-0.1.0/src/openirf/experimental_irf.py

@@ -0,0 +1,153 @@
+import numpy as np
+import scipy as sp
+from .utils import *
+
+
+class ExperimentalIRF:
+    """
+    OpenIRF Experimental IRF Class
+    ------------------------------
+
+    Stores time series (t_vec,y_vec_,f_vec) for IRF calculation.
+
+    Shape of time series arrays
+    ---------------------------
+    - 3D: Multiple dofs, multiple measurements (dof,number_of_measurements,points)
+    - 2D: Single dof, multiple measurements (number_of_measurements,points)
+    - 1D: Single dof, one measurement (points)
+
+    Constraints
+    -----------
+    - t_vec must matched stored t_vec (if already stored)
+    - All data must share the same t_vec
+    - Data cannot be added without a specified or already stored t_vec
+
+    Attributes
+    ----------
+    :param t_vec: Time vector of time series y_vec and f_vec.
+    :type t_vec: ndarray
+    :param y_vec: Time series of system responses.
+    :type y_vec: ndarray
+    :param f_vec: Time series of applied forces.
+    :type f_vec: ndarray
+
+    """
+
+    # Declare parameters as attributes
+    t_vec = np.empty((0))
+    y_vec = np.empty((0, 0, 0))
+    f_vec = np.empty((0, 0, 0))
+
+    def __init__(self, t_vec=np.empty((0)), y_vec=np.empty((0, 0, 0)), f_vec=np.empty((0, 0, 0))):
+        # Initialize ExperimentalIRF class with provided data
+        if t_vec.size != 0:
+            self.t_vec = self._convert_to_1d_array(t_vec)
+
+        if y_vec.size != 0 or f_vec.size != 0:
+            self.add_time_series(y_vec, f_vec, t_vec=self.t_vec)
+
+    # Trim unnecessary dimensions from array
+    def _convert_to_1d_array(self, array):
+        array = np.squeeze(array)
+
+        if array.ndim != 1:
+            raise ValueError(f"Expected 1D array. Got {array.ndim}D.")
+
+        return array
+
+    # Convert any array passed to ExperimentalIRF into a 3D array for concise internal storage.
+    def _convert_to_3d_array(self, array):
+        # Input convention:
+        # 3D: Multiple dofs, multiple measurements (dof,number_of_measurements,points)
+        # 2D: Single dof, multiple measurements (number_of_measurements,points)
+        # 1D: Single dof, one measurement (points)
+
+        if array.ndim == 1:
+            array = array[np.newaxis, np.newaxis, :]
+        elif array.ndim == 2:
+            array = array[np.newaxis, :, :]
+        elif array.ndim == 3:
+            pass
+        else:
+            raise ValueError(f"Expected 1D, 2D, or 3D array. Got {array.ndim}D.")
+
+        return array
+
+    def __str__(self):
+        # Prints a formatted object summary of the ExperimentalIRF object
+        def print_array(arr):
+            if arr is None or arr.size == 0:
+                return "None"
+            else:
+                return str(arr.shape)
+
+        return (
+            "==== OpenIRF Experimental IRF Object Summary ====\n"
+            f"t_vec: {print_array(self.t_vec)}\n"
+            f"y_vec: {print_array(self.y_vec)}\n"
+            f"f_vec: {print_array(self.f_vec)}"
+        )
+
+    def __repr__(self):
+        # Return the same output as __str__ for IPython outputs
+        return self.__str__()
+
+    def add_time_series(self, y_vec, f_vec, t_vec=None):
+        """
+        Add Time Series
+        ---------------
+
+        This method allows to add time series to the class istance.
+
+        Shape of time series arrays
+        ---------------------------
+        - 3D: Multiple dofs, multiple measurements (dof,number_of_measurements,points)
+        - 2D: Single dof, multiple measurements (number_of_measurements,points)
+        - 1D: Single dof, one measurement (points)
+
+        Constraints
+        -----------
+        - t_vec must matched stored t_vec (if already stored)
+        - All data must share the same t_vec
+        - Data cannot be added without a specified or already stored t_vec
+
+        Parameters
+        ----------
+        :param t_vec: Time vector of time series y_vec and f_vec.
+        :type t_vec: ndarray
+        :param y_vec: Time series of system responses.
+        :type y_vec: ndarray
+        :param f_vec: Time series of applied forces.
+        :type f_vec: ndarray, optional
+
+        """
+        # Shape input data
+        if t_vec is not None:
+            t_vec = self._convert_to_1d_array(t_vec)
+        y_vec = self._convert_to_3d_array(y_vec)
+        f_vec = self._convert_to_3d_array(f_vec)
+
+        # Input check - Time Vector
+        if self.t_vec.size != 0 and t_vec is not None:
+            if not np.array_equal(self.t_vec, t_vec):
+                raise Exception("Provided t_vec does not match stored t_vec.")
+        if self.t_vec.size == 0:  # Assign provided time vector if previously self.t_vec was empty
+            if t_vec is None or t_vec.size == 0:  # No t_vec provided for data
+                raise Exception("No t_vec provided for data.")
+            self.t_vec = t_vec
+
+        # Input check - Data
+        if y_vec.shape[-1] != len(self.t_vec):
+            raise Exception("Provided y_vec does not match length of stored t_vec.")
+        if f_vec.shape[-1] != len(self.t_vec):
+            raise Exception("Provided f_vec does not match length of stored t_vec.")
+
+        if self.y_vec.size != 0:  # Only y_vec or f_vec must be checked here, since they can only be initialized in pairs.
+            y_vec_new = np.append(self.y_vec, y_vec, axis=0)
+            f_vec_new = np.append(self.f_vec, f_vec, axis=0)
+        else:
+            y_vec_new = y_vec
+            f_vec_new = f_vec
+
+        self.y_vec = y_vec_new
+        self.f_vec = f_vec_new