Skip to content

Commit

Permalink
v0.5.1 - maintenance
Browse files Browse the repository at this point in the history
  • Loading branch information
sneakers-the-rat committed Jul 9, 2024
1 parent 2f6de57 commit 6e2c543
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 12 deletions.
38 changes: 27 additions & 11 deletions docs/changelog/v0.5.0.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
# v0.5.0a0 - ~The Data Modeling Edition~
# v0.5.0

## v0.5.1 - Maintenance patch

Fixes to keep it sort of running and catch up on dependency drift....

Still haven't gotten pyside6 to work yet though which is a PROBLEM

- [#211](https://github.com/auto-pi-lot/autopilot/pull/211)
- Fix: [#209](https://github.com/auto-pi-lot/autopilot/issues/209) - update location of dtoverlays
- Convert travis-based tests to github actions so they actually run
- Don't raise `NotImplementedError` in datajoint module on import - what the hell was i thinking lmao
- don't access deprecated alias `np.float`, just use `float`
- fix a bunch of docs stuff to make it build
- update dep versions and remove some upper bounds

## v0.5.0a0 - ~The Data Modeling Edition~
(changelog_v050a)=

A lot. Namely a whole rewriting of the {mod}`autopilot.data` module.
Expand All @@ -7,7 +23,7 @@ This is being released as an alpha version while we finish working out a few of
system because Jonny is finishing their dissertation and has a deadline determined by the viscera of
institutional science rather than software development!

## Upgrading From <v0.5.0
### Upgrading From <v0.5.0

- The subject class will attempt to update any of your existing
.h5 files to the new format -- it should be nondestructive (making a backup of the whole file first
Expand All @@ -21,7 +37,7 @@ institutional science rather than software development!
- We advise updating pigpio to at least [`3c23715`](https://github.com/sneakers-the-rat/pigpio/commit/3c237159e5995ec58cd673579bdd66a8d819b269) to
avoid warnings and make use of some new functionality.

## Package Structure
### Package Structure

- The `autopilot.core` module was removed entirely, and was split into
- {mod}`autopilot.agent`: which contains the {class}`.Terminal` and {class}`.Pilot` classes and a stub metaclass
Expand All @@ -37,7 +53,7 @@ institutional science rather than software development!
- Code files were given `755` permissions to allow execution (as opposed to `644`)
- The unused git submodules for pigpio and an old temperature sensor were removed.

## Major updates
### Major updates

- {mod}`autopilot.data` is the major change in this release! See the module-level doc page for more details
- `autopilot.core.subject` was moved to {mod}`autopilot.data.subject` and remains the main interface to autopilot data.
Expand Down Expand Up @@ -75,7 +91,7 @@ institutional science rather than software development!
also has an optional `disable_gc` (False by default) parameter that allows the garbage collector to be disabled
in the process for further (unquantified) jitter reduction.

## Minor updates
### Minor updates

- The bandwidth test ({class}`.Bandwidth_Test` widget and {meth}`.Pilot.l_bandwidth` listen) was updated to allow selecting
compression, use of a random array, or preserialized messages
Expand All @@ -92,7 +108,7 @@ institutional science rather than software development!
- Two utility functions {func}`.common.walk_dicts` and {func}`.common.flatten_dicts` were added to make handling nested dictionaries a bit easier.
-

## Bugfixes
### Bugfixes

- The Subject class would incorrectly overwrite data given a mismatch in system times between the Terminal and Pilot.
The subject class should now ideally no longer overwrite anything ever.
Expand All @@ -104,13 +120,13 @@ institutional science rather than software development!
- `jackd_source` script uses correct `https://` rather than `git://` protocol.
- A `_TASK_LIST` was added to {mod}`.utils.registry` to support deprecated task specifications.

## Regressions
### Regressions

- With additional checking for monotonic increases in `trial_num` and checks that prevent data overwriting,
individual writes of trial data are now a bit slower, which should be optimized for when we complete the transition to
uniform data models throughout the library.

## Prefs
### Prefs

- `PIGPIOD` - `bool` - if `True`, start pigpiod on pilot start
- Stubs were created for converting the prefs to using data models, but they have not been filled yet.
Expand All @@ -119,7 +135,7 @@ institutional science rather than software development!
- A `AUTOPILOT_WARN_DEFAULTS` environment variable controls whether warnings should be printed for when a default pref value
is retrieved, because that warning is a good one but can be really annoying.

## Packaging & Dependencies
### Packaging & Dependencies

- Autopilot is now packaged with Poetry! This allows for fully deterministic installation with the poetry.lock file and
updates from the old setuptools style of dependency specification.
Expand Down Expand Up @@ -147,7 +163,7 @@ institutional science rather than software development!
- A lot more dependencies were taken from being implicit versions to explicit
by the conversion to using Poetry...

## Docs
### Docs

- [Configuration](configuration) was moved to its own page, documenting setting up the system as well as the contents of the user directory.
- A [faq](FAQ) page was stubbed out (but is still pretty skeletal)
Expand All @@ -163,7 +179,7 @@ institutional science rather than software development!
use the public/private distinction more systematically to make it more understandable.
- Examples was split off into its own folder and links to wiki plugins. Blink was moved with it

## Tests
### Tests

- We have started importing some of the pigpio mocking tools from the [People's Ventilator Project](https://peoplesvent.org)
to start writing GPIO tests!
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "auto-pi-lot"
version = "0.5.0"
version = "0.5.1"
description = "Distributed behavioral experiments"
authors = ["Jonny Saunders <[email protected]>"]
license = "MPL-2.0"
Expand Down

0 comments on commit 6e2c543

Please sign in to comment.