pyfrf

Frequency response function as used in structural dynamics

https://github.com/ladisk/pyfrf

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Frequency response function as used in structural dynamics

Basic Info
  • Host: GitHub
  • Owner: ladisk
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 18.9 MB
Statistics
  • Stars: 39
  • Watchers: 9
  • Forks: 21
  • Open Issues: 1
  • Releases: 3
Created over 9 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

readme.rst

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

Owner

  • Name: Ladisk
  • Login: ladisk
  • Kind: organization
  • Email: janko.slavic@fs.uni-lj.si

Laboratory for Dynamics of Machines and Structures at the University of Ljubljana, Faculty of Mech Eng

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: pyFRF: Frequency response function as used in structural dynamics
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Janko
    family-names: Slavič
    email: janko.slavic@fs.uni-lj.si
    affiliation: >-
      University of Ljubljana, Faculty of Mechanical
      Engineering
    orcid: 'https://orcid.org/0000-0002-5982-8377'
  - given-names: Martin
    family-names: Česnik
    email: martin.cesnik@fs.uni-lj.si
    affiliation: >-
      University of Ljubljana, Faculty of Mechanical
      Engineering
    orcid: 'https://orcid.org/0000-0003-2807-5031'
  - given-names: Klemen
    family-names: Zaletelj
    email: klemen.zaletelj@fs.uni-lj.si
    affiliation: >-
      University of Ljubljana, Faculty of Mechanical
      Engineering
    orcid: 'https://orcid.org/0000-0001-7314-3916'
  - given-names: Luka
    family-names: Novak
    email: luka.novak@fs.uni-lj.si
    affiliation: >-
      University of Ljubljana, Faculty of Mechanical
      Engineering
identifiers:
  - type: url
    value: 'https://github.com/ladisk/pyFRF'

GitHub Events

Total
  • Release event: 2
  • Watch event: 3
  • Delete event: 1
  • Push event: 4
  • Pull request event: 2
  • Create event: 3
Last Year
  • Release event: 2
  • Watch event: 3
  • Delete event: 1
  • Push event: 4
  • Pull request event: 2
  • Create event: 3

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 314 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 24
  • Total maintainers: 3
pypi.org: pyfrf

Frequency response function as used in structural dynamics.

  • Versions: 24
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 314 Last month
Rankings
Forks count: 8.6%
Dependent packages count: 10.0%
Stargazers count: 11.0%
Average: 15.6%
Dependent repos count: 21.8%
Downloads: 26.6%
Maintainers (3)
Last synced: 7 months ago

Dependencies

requirements.txt pypi
  • colorama >=0.3.7
  • lvm_read >=1.17
  • nose >=1.3.7
  • numpy >=1.12.0
  • py >=1.4.32
  • pytest >=3.0.5
setup.py pypi
  • numpy *