lasprs/README.md

# LASPrs: Library for Acoustic Signal Processing in Rust

Welcome to LASPrs: Library for Acoustic Signal Processing. LASPrs is a rust 
library that provides tools and measurement software that enables the acquisition
and processing of (multi) sensor data in real time on a PC and output results.

## Note to potential users

**This crate is still under heavy development. API changes happen on the fly. Documentation is not finished. Use with caution but except things to be broken and buggy.**

## Documentation

Documentation is provided at [doc.rs](https://docs.rs/lasprs/latest/lasprs).

## Python bindings and examples

The library has Python bindings (via [pyo3](https://pyo3.rs), which can be installed via:

```
$ pip install lasprs
```

which pulls the library from [Pypi](https://pypi.org).

Examples of how to use the library are provided in Jupyter Notebooks, which  can be found in the repository, see [lasprs/examples_py](https://code.ascee.nl/ASCEE/lasprs/src/branch/main/examples_py).

More examples will follow in the near future.
Added readme 2023-11-22 13:56:25 +00:00			`# LASPrs: Library for Acoustic Signal Processing in Rust`

			`Welcome to LASPrs: Library for Acoustic Signal Processing. LASPrs is a rust`
			`library that provides tools and measurement software that enables the acquisition`
			`and processing of (multi) sensor data in real time on a PC and output results.`

Updated docs and readme 2024-07-11 19:10:38 +00:00			`## Note to potential users`

Comment syntax markdown fix 2024-07-18 15:40:57 +00:00			`This crate is still under heavy development. API changes happen on the fly. Documentation is not finished. Use with caution but except things to be broken and buggy.`
Updated docs and readme 2024-07-11 19:10:38 +00:00
Readme update 2023-11-25 16:08:32 +00:00			`## Documentation`

Removed unnecessary complex API with APSResult and switched to two methods: compute_last and compute_all. Improved docstrings and fixes in docstrings. 2024-07-11 19:02:21 +00:00			`Documentation is provided at [doc.rs](https://docs.rs/lasprs/latest/lasprs).`
Readme update 2023-11-25 16:08:32 +00:00
Rolled back to older Pyo3 version to make it compatible with Rust-Numpy that is not yet ready to go to new Pyo3 API. Improved power spectra estimator by removing DC value before going into window. Later overwriting it. Improved functionality of Python bindings 2024-08-28 12:59:10 +00:00			`## Python bindings and examples`
Readme update 2023-11-25 16:08:32 +00:00
			`The library has Python bindings (via [pyo3](https://pyo3.rs), which can be installed via:`

			```
TimeWeighting __eq__ method added. Improved comments. Tested Python code. Now ready for implementing WindowType Python wrapper 2024-08-28 19:51:16 +00:00			`$ pip install lasprs`
Readme update 2023-11-25 16:08:32 +00:00			```
Added readme 2023-11-22 13:56:25 +00:00
TimeWeighting __eq__ method added. Improved comments. Tested Python code. Now ready for implementing WindowType Python wrapper 2024-08-28 19:51:16 +00:00			`which pulls the library from [Pypi](https://pypi.org).`

			`Examples of how to use the library are provided in Jupyter Notebooks, which can be found in the repository, see [lasprs/examples_py](https://code.ascee.nl/ASCEE/lasprs/src/branch/main/examples_py).`

			`More examples will follow in the near future.`