Metadata-Version: 2.5
Name: pyEMA
Version: 0.27.0
Summary: Experimental and operational modal analysis (port of sdypy-EMA).
Project-URL: homepage, https://github.com/ladisk/pyEMA
Project-URL: documentation, https://pyema.readthedocs.io/en/latest/index.html
Project-URL: source, https://github.com/sdypy/sdypy-EMA
Project-URL: issues, https://github.com/sdypy/sdypy-EMA/issues
Author: Klemen Zaletelj, Domen Gorjup, Tomaž Bregar, Miha Pogačar
Author-email: Janko Slavič <janko.slavic@fs.uni-lj.si>
Maintainer-email: Janko Slavič <janko.slavic@fs.uni-lj.si>
License-Expression: MIT
License-File: LICENSE
Keywords: EMA,Experimental Modal Analysis,OMA,Structural Dynamics
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: sdypy-ema>=0.29.1
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
Description-Content-Type: text/x-rst

pyEMA
=====

Experimental and operational modal analysis.

------------

``pyEMA`` is a port of `sdypy-EMA`_, which is part of the `SDyPy`_ project. The code is
maintained in ``sdypy-EMA``; this package makes the same code available under the
``pyEMA`` name, so that existing code keeps working.

**Please report issues and open pull requests at** `sdypy-EMA`_.

Installing ``pyEMA`` also installs ``sdypy-EMA``. These two imports give the same code:

.. code:: python

   import pyEMA
   from sdypy import EMA as pyEMA

For new code, use ``sdypy-EMA`` directly:

.. code:: cmd

   pip install sdypy-EMA

.. code:: python

   from sdypy import EMA

------------

Basic ``pyEMA`` usage
---------------------

Make an instance of ``Model`` class:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

   a = pyEMA.Model(
       frf_matrix,
       frequency_array,
       lower=50,
       upper=10000,
       pol_order_high=60
       )

Compute poles:
~~~~~~~~~~~~~~

.. code:: python

   a.get_poles()

Determine correct poles:
~~~~~~~~~~~~~~~~~~~~~~~~

The stable poles can be determined in two ways:

1. Display **stability chart**

.. code:: python

    a.select_poles()

The stability chart displayes calculated poles and the user can hand-pick the stable ones.

2. If the approximate values of natural frequencies are already known, it is not necessary to display the stability chart:

.. code:: python

    approx_nat_freq = [314, 864]
    a.select_closest_poles(approx_nat_freq)

After the stable poles are selected, the natural frequencies and damping coefficients can now be accessed:

.. code:: python

   a.nat_freq # natrual frequencies
   a.nat_xi # damping coefficients

Reconstruction:
~~~~~~~~~~~~~~~

There are two types of reconstruction possible:

1. Reconstruction using **own** poles (the default option):

.. code:: python

    H, A = a.get_constants(whose_poles='own')

where **H** is reconstructed FRF matrix and **A** is a matrix of modal constants.

2. Reconstruction on **c** using poles from **a**:

.. code:: python

    c = pyEMA.Model(frf_matrix, frequency_array, lower=50, upper=10000, pol_order_high=60)

    H, A = c.get_constants(whose_poles=a)

|DOI|

.. _documentation: https://pyema.readthedocs.io/en/latest/index.html

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4016671.svg?
   :target: https://doi.org/10.5281/zenodo.4016671

.. _SDyPy: https://github.com/sdypy/sdypy

.. _sdypy-EMA: https://github.com/sdypy/sdypy-EMA
