Skip to content

Commit

Permalink
add change log, update version to v0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
t-sasatani committed Nov 11, 2024
1 parent a860f87 commit 8fde8cf
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
18 changes: 18 additions & 0 deletions docs/meta/changelog.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions miniscope_io/stream_daq.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"},
Expand Down

0 comments on commit 8fde8cf

Please sign in to comment.