Metadata-Version: 2.1
Name: lim-sample
Version: 1.5.0a2
Summary: Package for the SAMPLE method
Home-page: https://github.com/limunimi/sample
Author: Marco Tiraboschi
Author-email: marco.tiraboschi@unimi.it
Maintainer: Marco Tiraboschi
Maintainer-email: marco.tiraboschi@unimi.it
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: gui
Provides-Extra: plots
Provides-Extra: notebooks
Provides-Extra: test
Provides-Extra: docs
Provides-Extra: lint
Provides-Extra: cov
Provides-Extra: packaging
Provides-Extra: installer
License-File: LICENSE

# Spectral Analysis for Modal Parameter Linear Estimate
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/limunimi/sample/main/main?event=push)](https://github.com/limunimi/sample/actions?query=workflow%3Amain)
[![Coverage](https://gist.githubusercontent.com/chromaticisobar/fb3ce2e55493c80839ca8985d0c38146/raw/lim-sample-coverage-badge.svg)](https://github.com/limunimi/sample/actions?query=workflow%3Amain)
[![Pylint](https://gist.githubusercontent.com/chromaticisobar/fb3ce2e55493c80839ca8985d0c38146/raw/lim-sample-pylint-badge.svg)](https://github.com/limunimi/sample/actions?query=workflow%3Amain)
[![PyPI version](https://badge.fury.io/py/lim-sample.svg)](https://badge.fury.io/py/lim-sample)

## Install
You can install the `sample` package from [PyPI](https://pypi.org/project/lim-sample) 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

> Please, note that the GUI is still in its alpha release phase

### 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!

You can change the theme of the GUI (e.g. use a dark theme) this way:

 - Create a shortcut to the `SAMPLE.exe` file
   (right-click on the file and select `Create shortcut`)
 - Right-click on the shortcut and open `Properties`
 - In the `Shortcut` tab, go to `Target` (it should be
   set to the path of the `SAMPLE.exe` file, e.g.
   `C:\Users\User\Downloads\SAMPLE.exe`)
 - Add the theme option `--theme <theme name>` after the
   file path. E.g. if you want to use the theme `equilux`,
   you should add `--theme equilux`
 - That's it, you can run it by clicking on the shortcut!

For a full list of supported themes go to
[ttkthemes.readthedocs.io](https://ttkthemes.readthedocs.io/en/latest/themes.html).  
The default theme for Windows is [Arc](https://ttkthemes.readthedocs.io/en/latest/themes.html#arc). 
Suggested dark theme is [Equilux](https://ttkthemes.readthedocs.io/en/latest/themes.html#equilux).

### Python
You can install the GUI from the command line with Python via pip.  
It is recommended run these commands in a virtual environment in  
order to to keep your system clean

```pip install lim-sample[gui]==1.5.0a2```

To run the GUI from the command line, run

```python -m sample.gui```

You can change the theme of the GUI (e.g. use a dark theme) by
specifying a theme option 

```python -m sample.gui --theme <theme name>```

E.g. if you want to use the theme `equilux`, you should run

```python -m sample.gui --theme equilux```

For a full list of supported themes go to
[ttkthemes.readthedocs.io](https://ttkthemes.readthedocs.io/en/latest/themes.html).  
The default theme is [Radiance](https://ttkthemes.readthedocs.io/en/latest/themes.html#radiance-ubuntu)
for Linux and [Arc](https://ttkthemes.readthedocs.io/en/latest/themes.html#arc) for
all other systems.  
Suggested dark theme is [Equilux](https://ttkthemes.readthedocs.io/en/latest/themes.html#equilux).

## 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](https://github.com/limunimi/sample/tree/master/notebooks) folder


