bpwave 0.0.3

Installation

$ cd <project_root>
$ pip install -U .

Generating documentation

$ cd <project_root>
$ pip install -U .[docs]
$ cd <project_root>/docs
$ make clean
$ make html

This creates <project_root>/docs/build/html/index.html, that can be opened in a browser.

Tests

$ cd <project_root>
$ pip install -U .[tests]
$ python -m pytest
$ python -m pytest --cov --cov-report=html

Tests requiring human evaluation (like visualisations) can be skipped or run separately (these are marked with the @pytest.mark.human decorator):

$ python -m pytest -m human
$ python -m pytest -m "not human"

BP waveforms used for tests and examples were downloaded from the Autonomic Aging: A dataset to quantify changes of cardiovascular autonomic function during healthy aging [AAC] dataset of [PhysioNet].

Development

This project uses some automated QA and source formatting tools, such as isort, Flake8, Black and mypy:

$ cd <project_root>
$ pip install -U .[dev]
$ isort .
$ flake8 .
$ black .
$ mypy .

References

0.0.3 (2024-04-30)

Features:

• SignalReader base class and CsvReader.

• Signal.plot: grid on by default. New parameter t0.

• to_csv: simple CSV export

• ChPoints.plot: plot independently of the containing signal.

• Slicing of ChPoints, shifting indices with scalar (+, -)

• visu.plot_signal_slices.

Fixes:

• Signal.__getitem__ can no longer produce empty slices in Signal.slices.

• Signal.slices validation error messages now contain the key.

0.0.2 (2024-02-27)

Breaking changes:

• Signal.copy: arguments made keyword-only

Features:

• CpIndices.NAMES

• New attribute Signal.slices

• Slicing Signal by time or onsets: by_t, by_onset.

• Signal.t2i accepts backward (negative) time point.

Fixes:

• Error message in Signal.chpoints setter.

• Typing of Signal.y.

• Validate in Signal that y, t and marks value is 1D (to prevent scalar values from wrongly called numpy functions).

0.0.1 (2023-01-12)

First release.