pyFRF
=====
Frequency response function as used in structural dynamics.
-----------------------------------------------------------
For more information check out the showcase examples and see documentation_.
Basic ``pyFRF`` usage:
----------------------
Make an instance of ``FRF`` class:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
a = pyFRF.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": "https://github.com/ladisk/pyFRF",
"name": "pyFRF",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "FRF,MIMO,SIMO,ODS",
"author": "Janko Slavi\u010d, Luka Novak, Martin \u010cesnik, et al.",
"author_email": "janko.slavic@fs.uni-lj.si",
"download_url": "https://files.pythonhosted.org/packages/1c/c1/10dbb9beb2245e174aa051ad92d821ec936e56fd8b6243dc74ea0370498d/pyFRF-1.1.tar.gz",
"platform": null,
"description": "pyFRF\n=====\n\nFrequency response function as used in structural dynamics.\n-----------------------------------------------------------\nFor more information check out the showcase examples and see documentation_.\n\nBasic ``pyFRF`` usage:\n----------------------\n\nMake an instance of ``FRF`` class:\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n a = pyFRF.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",
"bugtrack_url": null,
"license": "",
"summary": "Frequency response function as used in structural dynamics.",
"version": "1.1",
"project_urls": {
"Homepage": "https://github.com/ladisk/pyFRF"
},
"split_keywords": [
"frf",
"mimo",
"simo",
"ods"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dde0cdfc30aa047cc458e0a91a79f9a1cc9cb81da2bb5449980e68c9dc5bfea",
"md5": "7e56ae49ee49c94a970b437e59e10ccd",
"sha256": "f0b8ca26540d92f6939aa1d282381a0819d54ec059c0379058dcd20da34fc6b5"
},
"downloads": -1,
"filename": "pyFRF-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e56ae49ee49c94a970b437e59e10ccd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13853,
"upload_time": "2023-10-03T18:38:19",
"upload_time_iso_8601": "2023-10-03T18:38:19.779902Z",
"url": "https://files.pythonhosted.org/packages/6d/de/0cdfc30aa047cc458e0a91a79f9a1cc9cb81da2bb5449980e68c9dc5bfea/pyFRF-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1cc110dbb9beb2245e174aa051ad92d821ec936e56fd8b6243dc74ea0370498d",
"md5": "7df4a7356d911c4666a161dab8ca1ab2",
"sha256": "0537d1690bc1c63106b167802639b3e894b20771d7e2a90ced61c9ced86d64d1"
},
"downloads": -1,
"filename": "pyFRF-1.1.tar.gz",
"has_sig": false,
"md5_digest": "7df4a7356d911c4666a161dab8ca1ab2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13655,
"upload_time": "2023-10-03T18:38:21",
"upload_time_iso_8601": "2023-10-03T18:38:21.160398Z",
"url": "https://files.pythonhosted.org/packages/1c/c1/10dbb9beb2245e174aa051ad92d821ec936e56fd8b6243dc74ea0370498d/pyFRF-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-03 18:38:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladisk",
"github_project": "pyFRF",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyfrf"
}
JSON
