lasprs/README.md

29 lines
1.0 KiB
Markdown
Raw Normal View History

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.
2024-07-11 19:10:38 +00:00
## Note to potential users
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.**
2024-07-11 19:10:38 +00:00
2023-11-25 16:08:32 +00:00
## Documentation
Documentation is provided at [doc.rs](https://docs.rs/lasprs/latest/lasprs).
2023-11-25 16:08:32 +00:00
## Python bindings and examples
2023-11-25 16:08:32 +00:00
The library has Python bindings (via [pyo3](https://pyo3.rs), which can be installed via:
```
$ pip install lasprs
2023-11-25 16:08:32 +00:00
```
2023-11-22 13:56:25 +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.