ASCEE/lasprs
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs and readme

Browse Source
This commit is contained in:
Anne de Jong 2024-07-11 21:10:38 +02:00
parent 245f4ebfb2
commit 9a9192d4b4
2 changed files with 30 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -4,6 +4,12 @@ Welcome to LASPrs: Library for Acoustic Signal Processing. LASPrs is a rust
library that provides tools and measurement software that enables the acquisition 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. 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
Documentation is provided at [doc.rs](https://docs.rs/lasprs/latest/lasprs). Documentation is provided at [doc.rs](https://docs.rs/lasprs/latest/lasprs).

32
src/lib.rs
View File

@ -1,20 +1,38 @@
//! # Library for acoustic signal processing //! # Library for acoustic signal processing
//! //!
//! This crate contains structures and functions to perform acoustic measurements, interact with //! This crate contains structures and functions to perform acoustic
//! data acquisition devices and apply common acoustic analysis operations on them. //! measurements, interact with data acquisition devices and apply common
//! acoustic analysis operations on them.
//!
//! You will find the following stuff in this crate:
//!
//! - Data acquisition, recording, signal generation
//! - Power spectra estimation, transfer function estimation tools.
//! - Sound Level Meter implementation.
//! - Filter design tools, maybe borrowed from other crates?
//!
//! ## 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. Use at your own risk and responsibility.**
//!
//! ## Author information
//!
//! The main developer is J.A. de Jong from [ASCEE](https://www.ascee.nl). In
//! case of bug reports, please file them to info@ascee.nl.
//!
#![warn(missing_docs)] #![warn(missing_docs)]
#![allow(non_snake_case)] #![allow(non_snake_case)]
#![allow(non_upper_case_globals)] #![allow(non_upper_case_globals)]
#![allow(unused_imports)] #![allow(unused_imports)]
mod config; mod config;
use config::*; use config::*;
pub use config::Flt; pub use config::Flt;
pub mod filter;
pub mod daq; pub mod daq;
pub mod filter;
pub mod ps; pub mod ps;
pub mod siggen; pub mod siggen;
use filter::*; use filter::*;
@ -22,9 +40,8 @@ use filter::*;
/// A Python module implemented in Rust. /// A Python module implemented in Rust.
#[cfg(feature = "python-bindings")] #[cfg(feature = "python-bindings")]
#[pymodule] #[pymodule]
#[pyo3(name="_lasprs")] #[pyo3(name = "_lasprs")]
fn lasprs(m: &Bound<'_, PyModule>) -> PyResult<()> { fn lasprs(m: &Bound<'_, PyModule>) -> PyResult<()> {
daq::add_py_classses(m)?; daq::add_py_classses(m)?;
// Add filter submodule // Add filter submodule
@ -33,6 +50,5 @@ fn lasprs(m: &Bound<'_, PyModule>) -> PyResult<()> {
m.add_class::<filter::BiquadBank>()?; m.add_class::<filter::BiquadBank>()?;
m.add_class::<siggen::Siggen>()?; m.add_class::<siggen::Siggen>()?;
Ok(()) Ok(())
} }