sdypy-FRF 0.1.0__tar.gz

sdypy_frf-0.1.0/.gitignore

@@ -0,0 +1,109 @@
+# 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/
+*.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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/build/
+docs/source/api/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# 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/
+
+# VSCode
+.vscode/

sdypy_frf-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,78 @@
+Contributing Guide
+==================
+
+Contributions are welcome and greatly appreciated!
+
+
+.. _contributing-workflow-label:
+
+Workflow
+--------
+
+A bug-fix or enhancement is delivered using a pull request. A good pull request
+should cover one bug-fix or enhancement feature. This ensures the change set is
+easier to review and less likely to need major re-work or even be rejected.
+
+The workflow that developers typically use to fix a bug or add enhancements
+is as follows.
+
+* Fork the ``sdypy_template_project`` repo into your account.
+
+* Obtain the source by cloning it onto your development machine.
+
+  .. code-block:: console
+
+      $ git clone ttps://github.com/sdypy/sdypy_template_project.git
+      $ cd sdypy_template_project
+
+* Create a branch for local development:
+
+  .. code-block:: console
+
+      $ git checkout -b name-of-your-bugfix-or-feature
+
+  Now you can make your changes locally.
+
+
+* Develop fix or enhancement:
+
+  * Make a fix or enhancement (e.g. modify a class, method, function, module,
+    etc).
+
+  * Update an existing unit test or create a new unit test module to verify
+    the change works as expected.
+
+  * Run the test suite.
+
+    .. code-block:: console
+
+        $ pytest
+
+
+* The docs should be updated for anything but trivial bug fixes. 
+
+
+Perform docs check.
+
+    .. code-block:: console
+
+        $ cd docs
+        $ make clean
+        $ make html
+
+
+* Commit and push changes to your fork.
+
+  .. code-block:: console
+
+      $ git add .
+      $ git commit -m "A detailed description of the changes."
+      $ git push origin name-of-your-bugfix-or-feature
+
+  A pull request should preferably only have one commit upon the current
+  master HEAD, (via rebases and squash).
+
+* Submit a pull request through the service website (e.g. Github, Gitlab).
+
+* Check automated continuous integration steps all pass. Fix any problems
+  if necessary and update the pull request.

sdypy_frf-0.1.0/License

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Domen Gorjup 2019
+
+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.

sdypy_frf-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.1
+Name: sdypy-FRF
+Version: 0.1.0
+Summary: Frequency response function as used in structural dynamics.
+Project-URL: homepage, https://github.com/sdypy/sdypy-FRF
+Project-URL: documentation, https://pyfrf.readthedocs.io/en/latest/index.html
+Project-URL: source, https://github.com/sdypy/sdypy-FRF
+Author-email: "Janko Slavič et al." <janko.slavic@fs.uni-lj.si>
+Maintainer-email: "Janko Slavič et al." <janko.slavic@fs.uni-lj.si>
+License-Expression: MIT
+License-File: License
+Keywords: Frequency response function,MIMO,SIMO/MISO,SISO,structural dynamics
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: pyfrf>=1.0
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Requires-Dist: wheel; extra == 'dev'
+Description-Content-Type: text/x-rst
+
+sdypy-FRF
+=========
+
+Frequency response function as used in structural dynamics.
+-----------------------------------------------------------
+
+The ``sdypy-FRF`` is a namespace project of the ``sdypy`` framework and is a direct link
+to the ``pyFRF`` package.
+
+Use the ``sdypy`` package to convieniently access the functionallity of the
+`pyFRF <https://github.com/ladisk/pyFRF>`_ package through its namespace (see example below). 
+
+Other functionalities of the ``sdypy`` framework include:
+
+- `sdypy-EMA <https://github.com/sdypy/sdypy-EMA>`_: Experimental Modal Analysis
+- `sdypy-io <https://github.com/sdypy/sdypy-io>`_: Input/Output operations (LVM files, UFF files)
+
+
+For more information check out the showcase examples and see documentation_.
+
+Basic ``sdypy-FRF`` usage:
+--------------------------
+
+Import the module:
+~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    from sdypy import FRF
+
+Make an instance of ``FRF`` class:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    a = FRF.FRF(
+        sampling_freq,
+        exc=None,
+        resp=None,
+        exc_type='f', resp_type='a',
+        window='none',
+        weighting='linear',
+        fft_len=None,
+        nperseg=None,
+        noverlap=None,
+        archive_time_data=False,
+        frf_type='H1',
+        copy=True
+    )
+
+Adding data:
+~~~~~~~~~~~~
+We can add the excitation and response data at the beginning through ``exc`` and ``resp`` arguments, otherwise, the excitation and response 
+data can be added later via ``add_data()`` method:
+
+.. code:: python
+
+    a.add_data(exc, resp)
+
+Computing FRF:
+~~~~~~~~~~~~~~
+Preferable way to get the frequency response functions is via ``get_FRF()`` method:
+
+.. code:: python
+
+    frf = a.get_FRF(type="default", form="receptance")
+
+We can also directly get the requested FRF via other methods: ``get_H1()``, ``get_H2()``, ``get_Hv()`` and, ``get_ods_frf()``:
+
+.. code:: python
+
+    H1 = a.get_H1()
+    H2 = a.get_H2()
+    Hv = a.get_Hv()
+    ods_frf = a.get_ods_frf()
+
+.. _documentation: https://pyfrf.readthedocs.io/en/latest/
+
+|pytest|
+
+|binder| to test the *Showcase.ipynb*.
+
+.. |binder| image:: https://mybinder.org/badge_logo.svg
+   :target: https://mybinder.org/v2/gh/ladisk/pyFRF/main
+.. |pytest| image:: https://github.com/ladisk/pyFRF/actions/workflows/python-package.yml/badge.svg
+    :target: https://github.com/ladisk/pyFRF/actions
+

sdypy_frf-0.1.0/README.rst

@@ -0,0 +1,87 @@
+sdypy-FRF
+=========
+
+Frequency response function as used in structural dynamics.
+-----------------------------------------------------------
+
+The ``sdypy-FRF`` is a namespace project of the ``sdypy`` framework and is a direct link
+to the ``pyFRF`` package.
+
+Use the ``sdypy`` package to convieniently access the functionallity of the
+`pyFRF <https://github.com/ladisk/pyFRF>`_ package through its namespace (see example below). 
+
+Other functionalities of the ``sdypy`` framework include:
+
+- `sdypy-EMA <https://github.com/sdypy/sdypy-EMA>`_: Experimental Modal Analysis
+- `sdypy-io <https://github.com/sdypy/sdypy-io>`_: Input/Output operations (LVM files, UFF files)
+
+
+For more information check out the showcase examples and see documentation_.
+
+Basic ``sdypy-FRF`` usage:
+--------------------------
+
+Import the module:
+~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    from sdypy import FRF
+
+Make an instance of ``FRF`` class:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    a = FRF.FRF(
+        sampling_freq,
+        exc=None,
+        resp=None,
+        exc_type='f', resp_type='a',
+        window='none',
+        weighting='linear',
+        fft_len=None,
+        nperseg=None,
+        noverlap=None,
+        archive_time_data=False,
+        frf_type='H1',
+        copy=True
+    )
+
+Adding data:
+~~~~~~~~~~~~
+We can add the excitation and response data at the beginning through ``exc`` and ``resp`` arguments, otherwise, the excitation and response 
+data can be added later via ``add_data()`` method:
+
+.. code:: python
+
+    a.add_data(exc, resp)
+
+Computing FRF:
+~~~~~~~~~~~~~~
+Preferable way to get the frequency response functions is via ``get_FRF()`` method:
+
+.. code:: python
+
+    frf = a.get_FRF(type="default", form="receptance")
+
+We can also directly get the requested FRF via other methods: ``get_H1()``, ``get_H2()``, ``get_Hv()`` and, ``get_ods_frf()``:
+
+.. code:: python
+
+    H1 = a.get_H1()
+    H2 = a.get_H2()
+    Hv = a.get_Hv()
+    ods_frf = a.get_ods_frf()
+
+.. _documentation: https://pyfrf.readthedocs.io/en/latest/
+
+|pytest|
+
+|binder| to test the *Showcase.ipynb*.
+
+.. |binder| image:: https://mybinder.org/badge_logo.svg
+   :target: https://mybinder.org/v2/gh/ladisk/pyFRF/main
+.. |pytest| image:: https://github.com/ladisk/pyFRF/actions/workflows/python-package.yml/badge.svg
+    :target: https://github.com/ladisk/pyFRF/actions
+

sdypy_frf-0.1.0/docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+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)

sdypy_frf-0.1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

sdypy_frf-0.1.0/docs/source/conf.py

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+sys.setrecursionlimit(1500)
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'sdypy-FRF'
+copyright = '2024, Janko Slavič, et al.'
+author = 'Janko Slavič, et al.'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '2023'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    # 'rinoh.frontend.sphinx',
+    'sphinx_copybutton',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sdypy-FRFdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    
+    'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    
+    'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    
+    'preamble': '',
+
+    # Latex figure (float) alignment
+    
+    'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'sdypy-FRF.tex', 'sdypy-FRF Documentation',
+     'Janko Slavič, et al.', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'sdypy-FRF', 'sdypy-FRF Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'sdypy-FRF', 'sdypy-FRF Documentation',
+     author, 'sdypy-FRF', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+# Autodoc options (to show __init__ function in docs)
+autodoc_default_options = {
+    'members': None,
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': True,
+}

sdypy_frf-0.1.0/docs/source/index.rst

@@ -0,0 +1,27 @@
+Welcome to ``SDyPy-FRF`` documentation!
+======================================
+
+This is the documentation for the ``SDyPy-FRF`` package, part of ``SDyPy`` framework_. Check out the project on GitHub_.
+
+To use the package, install the ``sdypy`` package:
+
+.. code:: bash
+
+   pip install sdypy
+
+The ``FRF`` module is imported as follows:
+
+.. code:: python
+
+   from sdypy import FRF
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   pyFRF <https://pyfrf.readthedocs.io/en/latest/index.html>
+
+
+.. _GitHub: https://github.com/sdypy/sdypy-FRF
+.. _framework: https://github.com/sdypy

sdypy_frf-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sdypy-FRF"
+version = "0.1.0"
+authors = [{name = "Janko Slavič et al.", email = "janko.slavic@fs.uni-lj.si"}]
+maintainers = [{name = "Janko Slavič et al.", email = "janko.slavic@fs.uni-lj.si"}]
+license = "MIT"
+description = "Frequency response function as used in structural dynamics."
+readme = "README.rst"
+keywords = ["Frequency response function", "MIMO", "SIMO/MISO", "SISO", "structural dynamics"]
+requires-python = ">=3.10"
+dependencies = ["pyFRF >= 1.0"]
+classifiers = [
+    'Development Status :: 5 - Production/Stable',
+    'Intended Audience :: Developers',
+    'Topic :: Scientific/Engineering',
+    'Programming Language :: Python :: 3.10',
+    "License :: OSI Approved :: MIT License",
+]
+
+[tool.hatch.build.targets.wheel]
+include = ["sdypy"]
+
+[project.optional-dependencies]
+dev = [
+    "sphinx",
+    "twine",
+    "wheel",
+    "pytest",
+    "build",
+    "sphinx-rtd-theme",
+    "sphinx-copybutton>=0.5.2",
+]
+
+[project.urls]
+homepage = "https://github.com/sdypy/sdypy-FRF"
+documentation = "https://pyfrf.readthedocs.io/en/latest/index.html"
+source = "https://github.com/sdypy/sdypy-FRF"

sdypy_frf-0.1.0/requirements.dev.txt

@@ -0,0 +1,9 @@
+# Package requirements for developers
+-r requirements.txt
+sphinx
+twine
+wheel
+pytest
+build
+sphinx-rtd-theme
+sphinx-copybutton>=0.5.2

sdypy_frf-0.1.0/requirements.txt

@@ -0,0 +1,2 @@
+# Package requirements for users
+pyFRF >= 1.0

sdypy_frf-0.1.0/sdypy/FRF/__init__.py

@@ -0,0 +1,7 @@
+"""
+A project template for the sdPy effort..
+"""
+
+__version__ = "0.1.0"
+
+from pyFRF import *