Spectral Analysis for Modal Parameter Linear Estimate
Python package with tools for spectral analysis and modal parameters estimate
Table of Contents
Install
We recommend installing in a virtual environment. For how to create virtual environments, please, refer to the official documentation for venv or conda.
You can install the sample
package from PyPI via pip.
pip install lim-sample
Available extras are
-
plots
: for plotting utilities -
notebooks
: for running notebooks -
gui
: for running the GUI
GUI
If you don't want write code to use SAMPLE, you can use the graphical user interface
Windows
For Windows, a stand-alone executable is available. You can download the latest version from GitHub:
- Go to https://github.com/limunimi/sample/releases
- Download the zip file from the latest release (
SAMPLE_win_<version>.zip
) - Unzip the
SAMPLE.exe
file - That's it, you can run it!
Python
You can install the GUI from the command line with Python via pip.
We recommend to install in a virtual environment
pip install lim-sample[gui]
To run the GUI from the command line, run
python -m sample.gui
Documentation
API documentation can be found online here:
https://limunimi.github.io/SAMPLE
Source Code
Source code is available on GitHub
https://github.com/limunimi/sample
Notebooks
For learning to use the package, you can refer to the interactive notebooks in the notebooks folder
Scripts
In the scripts folder, there are Python scripts for the reproducibility of experiments
References
References are available both as a BibTeX and a CITATION.cff file.
If you use this software in your research, please, consider citing the following items
- The SMC 2020 paper "Spectral Analysis for Modal Parameters Linear Estimate"
- The SAMPLE package for Python