# Vallen AE Python Tools
[![CI](https://github.com/vallen-systems/pyVallenAE/workflows/CI/badge.svg)](https://github.com/vallen-systems/pyVallenAE/actions)
[![Documentation Status](https://readthedocs.org/projects/pyvallenae/badge/?version=latest)](https://pyvallenae.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://coveralls.io/repos/github/vallen-systems/pyVallenAE/badge.svg?branch=master)](https://coveralls.io/github/vallen-systems/pyVallenAE)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI](https://img.shields.io/pypi/v/vallenae)](https://pypi.org/project/vallenae)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vallenae)](https://pypi.org/project/vallenae)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
**[Documentation](https://pyvallenae.readthedocs.io/) ยท [Examples](https://pyvallenae.readthedocs.io/en/stable/_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](https://www.vallen.de/downloads/).
## Installation
Install the latest version from [PyPI](https://pypi.org/project/vallenae):
```shell
$ pip install vallenae
```
If you want to run the latest version of the code, you can install from the master branch directly:
```shell
$ 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](https://github.com/vallen-systems/pyVallenAE/issues/new) or make a pull-request.
### Development setup
```shell
# 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
```
Raw data
{
"_id": null,
"home_page": "",
"name": "vallenae",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "AMSY,Acoustic Emission,SQLite,Vallen,WaveLine,analysis,data acquisition,pridb,timepicker,tradb,trfdb",
"author": "",
"author_email": "Lukas Berbuer <software@vallen.de>",
"download_url": "https://files.pythonhosted.org/packages/0f/18/c02137ccf19e2ac7a56e5efe3b1a3d47acadeea7e9b94be90abe64e372ee/vallenae-0.9.0.tar.gz",
"platform": null,
"description": "# Vallen AE Python Tools\n\n[![CI](https://github.com/vallen-systems/pyVallenAE/workflows/CI/badge.svg)](https://github.com/vallen-systems/pyVallenAE/actions)\n[![Documentation Status](https://readthedocs.org/projects/pyvallenae/badge/?version=latest)](https://pyvallenae.readthedocs.io/en/latest/?badge=latest)\n[![Coverage Status](https://coveralls.io/repos/github/vallen-systems/pyVallenAE/badge.svg?branch=master)](https://coveralls.io/github/vallen-systems/pyVallenAE)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PyPI](https://img.shields.io/pypi/v/vallenae)](https://pypi.org/project/vallenae)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vallenae)](https://pypi.org/project/vallenae)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n\n**[Documentation](https://pyvallenae.readthedocs.io/) \u00b7 [Examples](https://pyvallenae.readthedocs.io/en/stable/_examples)**\n\nPython tools to extract and analyze Acoustic Emission measurement data.\nThe package includes following modules:\n\n- vallenae.**io**: Reading (and writing) of Vallen Systeme SQLite database files (*.pridb, *.tradb, *.trfdb)\n- vallenae.**features**: Extraction of Acoustic Emission features\n- vallenae.**timepicker**: Timepicking algorithms for arrival time estimations\n\n> **Note**:\n> A free/lite version of the Vallen AE Suite is available since the release R2020.\n> If offers the basic features for real-time data visualization and analysis with VisualAE.\n> So you could write you own pridb/tradb files and have real-time visualizations with VisualAE.\n>\n> The Vallen AE Suite can be downloaded [here](https://www.vallen.de/downloads/).\n\n## Installation\n\nInstall the latest version from [PyPI](https://pypi.org/project/vallenae):\n\n```shell\n$ pip install vallenae\n```\n\nIf you want to run the latest version of the code, you can install from the master branch directly:\n\n```shell\n$ pip install -U git+https://github.com/vallen-systems/pyVallenAE.git\n# Or if you don't have git installed\n$ pip install -U https://github.com/vallen-systems/pyVallenAE/zipball/master\n```\n\nPlease 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`.\n\n## Contributing\n\nFeature requests, bug reports and fixes are always welcome!\nJust [create an issue](https://github.com/vallen-systems/pyVallenAE/issues/new) or make a pull-request.\n\n### Development setup\n\n```shell\n# Clone this repository\n$ git clone https://github.com/vallen-systems/pyVallenAE.git\n$ cd pyVallenAE\n\n# Install package and dependencies\n$ pip install -e .[dev]\n\n# Run the test suite with tox\n$ tox\n\n# Build the documentation with Sphinx\n$ cd docs\n$ make html # on Linux\n$ ./make.bat html # on Windows\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Extract and analyze Acoustic Emission measurement data",
"version": "0.9.0",
"project_urls": {
"Changelog": "https://github.com/vallen-systems/pyVallenAE/blob/master/CHANGELOG.md",
"Issues": "https://github.com/vallen-systems/pyVallenAE/issues",
"Source": "https://github.com/vallen-systems/pyVallenAE"
},
"split_keywords": [
"amsy",
"acoustic emission",
"sqlite",
"vallen",
"waveline",
"analysis",
"data acquisition",
"pridb",
"timepicker",
"tradb",
"trfdb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72a5d0363460d92b12e96e8101ecbe21755288f1fbf925cf79e32f8e600c0264",
"md5": "6d4fc5e5477932557dd7271b5b2c0e84",
"sha256": "a5e37e7e00e97876b2668f9a8dc5fbcfc79db43e8d9f2ac5cdee9780da6adb69"
},
"downloads": -1,
"filename": "vallenae-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d4fc5e5477932557dd7271b5b2c0e84",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35962,
"upload_time": "2024-02-14T15:13:42",
"upload_time_iso_8601": "2024-02-14T15:13:42.231851Z",
"url": "https://files.pythonhosted.org/packages/72/a5/d0363460d92b12e96e8101ecbe21755288f1fbf925cf79e32f8e600c0264/vallenae-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f18c02137ccf19e2ac7a56e5efe3b1a3d47acadeea7e9b94be90abe64e372ee",
"md5": "7205e6db17692efc25ffdba4f6e4835f",
"sha256": "9a65f958b3ace840e7164d6c1aa1124ae43872773f021586e300d5adfb46a4b1"
},
"downloads": -1,
"filename": "vallenae-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "7205e6db17692efc25ffdba4f6e4835f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6019963,
"upload_time": "2024-02-14T15:13:43",
"upload_time_iso_8601": "2024-02-14T15:13:43.654978Z",
"url": "https://files.pythonhosted.org/packages/0f/18/c02137ccf19e2ac7a56e5efe3b1a3d47acadeea7e9b94be90abe64e372ee/vallenae-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 15:13:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vallen-systems",
"github_project": "pyVallenAE",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vallenae"
}