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
Raw data
{
"_id": null,
"home_page": "",
"name": "sdypy-FRF",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "\"Janko Slavi\u010d et al.\" <janko.slavic@fs.uni-lj.si>",
"keywords": "Frequency response function,MIMO,SIMO/MISO,SISO,structural dynamics",
"author": "",
"author_email": "\"Janko Slavi\u010d et al.\" <janko.slavic@fs.uni-lj.si>",
"download_url": "https://files.pythonhosted.org/packages/4c/2a/c33c67b6a530d6e51992aa876dcadb17bd0b3589e44ab97cd63c528d9447/sdypy_frf-0.1.0.tar.gz",
"platform": null,
"description": "sdypy-FRF\n=========\n\nFrequency response function as used in structural dynamics.\n-----------------------------------------------------------\n\nThe ``sdypy-FRF`` is a namespace project of the ``sdypy`` framework and is a direct link\nto the ``pyFRF`` package.\n\nUse the ``sdypy`` package to convieniently access the functionallity of the\n`pyFRF <https://github.com/ladisk/pyFRF>`_ package through its namespace (see example below). \n\nOther functionalities of the ``sdypy`` framework include:\n\n- `sdypy-EMA <https://github.com/sdypy/sdypy-EMA>`_: Experimental Modal Analysis\n- `sdypy-io <https://github.com/sdypy/sdypy-io>`_: Input/Output operations (LVM files, UFF files)\n\n\nFor more information check out the showcase examples and see documentation_.\n\nBasic ``sdypy-FRF`` usage:\n--------------------------\n\nImport the module:\n~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n from sdypy import FRF\n\nMake an instance of ``FRF`` class:\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n a = FRF.FRF(\n sampling_freq,\n exc=None,\n resp=None,\n exc_type='f', resp_type='a',\n window='none',\n weighting='linear',\n fft_len=None,\n nperseg=None,\n noverlap=None,\n archive_time_data=False,\n frf_type='H1',\n copy=True\n )\n\nAdding data:\n~~~~~~~~~~~~\nWe can add the excitation and response data at the beginning through ``exc`` and ``resp`` arguments, otherwise, the excitation and response \ndata can be added later via ``add_data()`` method:\n\n.. code:: python\n\n a.add_data(exc, resp)\n\nComputing FRF:\n~~~~~~~~~~~~~~\nPreferable way to get the frequency response functions is via ``get_FRF()`` method:\n\n.. code:: python\n\n frf = a.get_FRF(type=\"default\", form=\"receptance\")\n\nWe can also directly get the requested FRF via other methods: ``get_H1()``, ``get_H2()``, ``get_Hv()`` and, ``get_ods_frf()``:\n\n.. code:: python\n\n H1 = a.get_H1()\n H2 = a.get_H2()\n Hv = a.get_Hv()\n ods_frf = a.get_ods_frf()\n\n.. _documentation: https://pyfrf.readthedocs.io/en/latest/\n\n|pytest|\n\n|binder| to test the *Showcase.ipynb*.\n\n.. |binder| image:: https://mybinder.org/badge_logo.svg\n :target: https://mybinder.org/v2/gh/ladisk/pyFRF/main\n.. |pytest| image:: https://github.com/ladisk/pyFRF/actions/workflows/python-package.yml/badge.svg\n :target: https://github.com/ladisk/pyFRF/actions\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Frequency response function as used in structural dynamics.",
"version": "0.1.0",
"project_urls": {
"documentation": "https://pyfrf.readthedocs.io/en/latest/index.html",
"homepage": "https://github.com/sdypy/sdypy-FRF",
"source": "https://github.com/sdypy/sdypy-FRF"
},
"split_keywords": [
"frequency response function",
"mimo",
"simo/miso",
"siso",
"structural dynamics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "014d56261f2122dc7b59bc24b462acedc7ab3dbb1f7c875282b36fc17303b822",
"md5": "ee0e4de50aa2732e6421f510b231fb11",
"sha256": "a9d717b0f0da8b7afe306fbcc5909e79b74b2ef88ee73442334333ab4ff71d0c"
},
"downloads": -1,
"filename": "sdypy_frf-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee0e4de50aa2732e6421f510b231fb11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3242,
"upload_time": "2024-02-16T06:46:27",
"upload_time_iso_8601": "2024-02-16T06:46:27.212203Z",
"url": "https://files.pythonhosted.org/packages/01/4d/56261f2122dc7b59bc24b462acedc7ab3dbb1f7c875282b36fc17303b822/sdypy_frf-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c2ac33c67b6a530d6e51992aa876dcadb17bd0b3589e44ab97cd63c528d9447",
"md5": "73e0964b41a78721476b69a8aa7e3b25",
"sha256": "f52ffc4791f09fffb4c4444d196f6fd1ae531fe5deb6364b9cfa35c7a602f072"
},
"downloads": -1,
"filename": "sdypy_frf-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "73e0964b41a78721476b69a8aa7e3b25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7601,
"upload_time": "2024-02-16T06:46:29",
"upload_time_iso_8601": "2024-02-16T06:46:29.637583Z",
"url": "https://files.pythonhosted.org/packages/4c/2a/c33c67b6a530d6e51992aa876dcadb17bd0b3589e44ab97cd63c528d9447/sdypy_frf-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 06:46:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sdypy",
"github_project": "sdypy-FRF",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "sdypy-frf"
}
JSON
