Vallen AE Python Tools

Documentation · Examples

Python tools to extract and analyze Acoustic Emission measurement data. The package includes following modules:

• vallenae.io: Reading (and writing) of Vallen Systeme SQLite database files (*.pridb, *.tradb, *.trfdb)
• vallenae.features: Extraction of Acoustic Emission features
• vallenae.timepicker: Timepicking algorithms for arrival time estimations

Note: A free/lite version of the Vallen AE Suite is available since the release R2020. If offers the basic features for real-time data visualization and analysis with VisualAE. So you could write you own pridb/tradb files and have real-time visualizations with VisualAE.

The Vallen AE Suite can be downloaded here.

Installation

Install the latest version from PyPI:

$ pip install vallenae

If you want to run the latest version of the code, you can install from the master branch directly:

$ pip install -U git+https://github.com/vallen-systems/pyVallenAE.git
# Or if you don't have git installed
$ pip install -U https://github.com/vallen-systems/pyVallenAE/zipball/master

Please note, that vallenae requires Python 3.6 or newer. On Linux systems, pip is usually mapped to Python 2, so use pip<version> (e.g. pip3 or pip3.7) instead. Alternatively, you can run pip from your specific Python version with python<version> -m pip.

Contributing

Feature requests, bug reports and fixes are always welcome! Just create an issue or make a pull-request.

Development setup

# Clone this repository
$ git clone https://github.com/vallen-systems/pyVallenAE.git
$ cd pyVallenAE

# Install package and dependencies
$ pip install -e .[dev]

# Run the test suite with tox
$ tox

# Build the documentation with Sphinx
$ cd docs
$ make html  # on Linux
$ ./make.bat html  # on Windows