From 8fde8cf5939e30c6471c61ec27c0f6e7a359df49 Mon Sep 17 00:00:00 2001 From: t-sasatani <33111879+t-sasatani@users.noreply.github.com> Date: Mon, 11 Nov 2024 21:18:55 +0900 Subject: [PATCH] add change log, update version to v0.5.0 --- docs/meta/changelog.md | 18 ++++++++++++++++++ miniscope_io/stream_daq.py | 1 + pyproject.toml | 2 +- 3 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/meta/changelog.md b/docs/meta/changelog.md index 2c3194ae..630e5d7e 100644 --- a/docs/meta/changelog.md +++ b/docs/meta/changelog.md @@ -1,5 +1,23 @@ # Changelog +## 0.5 + +### 0.5.0 - 24-11-11 +Enhancements and bugfixes to `StreamDaq`; adding `device_update` module; CI/CD updates. + +#### Features / bugfixes +- **Over-the-air device config:** modules and commands for updating and rebooting; *e.g.,* `mio update --key LED --value 10`, `mio device --reboot`. +- **Continuous run:** updated error handling to continuously capture even when the data stream is interrupted. +- **UNIX timestamp:** added UNIX timestamp to metadata file export. +- **More Opal Kelly bitfiles:** added FPGA configuration images and organized them based on Manchester encoding conventions, frequency, etc. +#### CI/CD +- Switched to `pdm` from `poetry`; now `pdm install --with all` for contributing. +- Added workflow for readthedocs preview link in PRs. +- Added snake_case enforcement (Lint). + +Related PRs: [#45](https://github.com/Aharoni-Lab/miniscope-io/pull/45), [#48](https://github.com/Aharoni-Lab/miniscope-io/pull/48), [#49](https://github.com/Aharoni-Lab/miniscope-io/pull/49), [#50](https://github.com/Aharoni-Lab/miniscope-io/pull/50), [#53](https://github.com/Aharoni-Lab/miniscope-io/pull/53), +Contributors: [@t-sasatani](https://github.com/t-sasatani), [@sneakers-the-rat](https://github.com/sneakers-the-rat), [@MarcelMB](https://github.com/MarcelMB), [@phildong](https://github.com/phildong) + ## 0.4 ### 0.4.1 - 24-09-01 diff --git a/miniscope_io/stream_daq.py b/miniscope_io/stream_daq.py index e4491cf3..83dd5abc 100644 --- a/miniscope_io/stream_daq.py +++ b/miniscope_io/stream_daq.py @@ -58,6 +58,7 @@ def exact_iter(f: Callable, sentinel: Any) -> Generator[Any, None, None]: else: yield val + class StreamDaq: """ A combined class for configuring and reading frames from a UART and FPGA source. diff --git a/pyproject.toml b/pyproject.toml index 85fe1967..fd387b79 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "miniscope_io" -version = "0.4.1" +version = "0.5.0" description = "Generic I/O for miniscopes" authors = [ {name = "sneakers-the-rat", email = "sneakers-the-rat@protonmail.com"},