Movement

What's Changed

New features
* Compute Forward Vector by b-peri in https://github.com/neuroinformatics-unit/movement/pull/276
* Compute pairwise distances by lochhh in https://github.com/neuroinformatics-unit/movement/pull/278
* Implement `compute_speed` and `compute_path_length` by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/280
* Add the option for multiple views loading - take2 by vigji in https://github.com/neuroinformatics-unit/movement/pull/346

Breaking changes
* Drop the `.move` accessor by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/322
* Removed "analysis" level from namespace by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/333
* Reorder dimensions by lochhh in https://github.com/neuroinformatics-unit/movement/pull/351

Docs/website improvements
* Fix command for installation of docs dependencies in the guide. by sfmig in https://github.com/neuroinformatics-unit/movement/pull/323
* Add example to convert file formats and changing keypoints by Lauraschwarz in https://github.com/neuroinformatics-unit/movement/pull/304
* Encourage R users to check out `animovement` by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/335
* Update overview, mission, scope, and roadmaps by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/352
* Restructure "Getting Started" page to a "User Guide" - take 2 by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/356
* Bounding boxes example by sfmig in https://github.com/neuroinformatics-unit/movement/pull/312
* Add inaugural blogpost by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/359

Housekeeping
* Add bbox centroid fix by sfmig in https://github.com/neuroinformatics-unit/movement/pull/303
* General validator function for checking dimensions and coordinates by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/294
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/318
* Update integration tests by sfmig in https://github.com/neuroinformatics-unit/movement/pull/295
* Refactor auto-generate API docs by lochhh in https://github.com/neuroinformatics-unit/movement/pull/331
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/338
* Fix for check-manifest pre-commit hook in Python 3.12 by sfmig in https://github.com/neuroinformatics-unit/movement/pull/344
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/355
* Fix and relax bboxes requirements by sfmig in https://github.com/neuroinformatics-unit/movement/pull/313

New Contributors
* Lauraschwarz made their first contribution in https://github.com/neuroinformatics-unit/movement/pull/304
* vigji made their first contribution in https://github.com/neuroinformatics-unit/movement/pull/346

**Full Changelog**: https://github.com/neuroinformatics-unit/movement/compare/v0.0.20...v0.0.21

Highlight
- New `movement` dataset type to store bounding boxes. Tracked bounding boxes can be loaded from files in [VGG Image Annotator format](https://www.robots.ox.ac.uk/~vgg/software/via/) or constructed from Numpy arrays. Spearheaded by sfmig 🎉



What's Changed
Support for bounding boxes
* Add a ValidVIAtracksCSV class (2/4) by sfmig in https://github.com/neuroinformatics-unit/movement/pull/219
* Small edits to ValidBboxesDataset (1/4) by sfmig in https://github.com/neuroinformatics-unit/movement/pull/230
* Getting started docs update for bboxes by sfmig in https://github.com/neuroinformatics-unit/movement/pull/245
* Load bboxes dataset from VIA tracks file (3/4) by sfmig in https://github.com/neuroinformatics-unit/movement/pull/229
* Adapt move accessor to bboxes datasets by sfmig in https://github.com/neuroinformatics-unit/movement/pull/255
* Simplify and expand filtering tests for bboxes by sfmig in https://github.com/neuroinformatics-unit/movement/pull/267
* Extend tests for bboxes datasets by sfmig in https://github.com/neuroinformatics-unit/movement/pull/246
* added new movement datasets figure, with caption by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/286
* Small refactor to filtering tests by sfmig in https://github.com/neuroinformatics-unit/movement/pull/287
* Simplify and expand kinematic tests for bboxes by sfmig in https://github.com/neuroinformatics-unit/movement/pull/265

New vector utilities
* Add utilities for vector magnitude and normalisation by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/243

Housekeeping and docs improvements
* Add citation information by adamltyson in https://github.com/neuroinformatics-unit/movement/pull/240
* Refactor names and fix docs formatting in `validators` by lochhh in https://github.com/neuroinformatics-unit/movement/pull/251
* Pin pandas version for Py3.12 tests by sfmig in https://github.com/neuroinformatics-unit/movement/pull/259
* Fix `tox requires` section by sfmig in https://github.com/neuroinformatics-unit/movement/pull/261
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/258
* Update setup docs by lochhh in https://github.com/neuroinformatics-unit/movement/pull/264
* Revert "Pin pandas version for Py3.12 tests" by sfmig in https://github.com/neuroinformatics-unit/movement/pull/272
* Configure intersphinx by lochhh in https://github.com/neuroinformatics-unit/movement/pull/269
* Suggestion to treat warnings as errors in sphinx-build by sfmig in https://github.com/neuroinformatics-unit/movement/pull/256
* Refactor derivative by lochhh in https://github.com/neuroinformatics-unit/movement/pull/270
* Remove `defaults` from test_and_deploy.yml by sfmig in https://github.com/neuroinformatics-unit/movement/pull/275
* Updated movement overview figure by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/288
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/296
* Fix xarray FutureWarning about dims vs sizes by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/297

**Full Changelog**: https://github.com/neuroinformatics-unit/movement/compare/v0.0.19...v0.0.20

What's Changed

For users
Changes in user-facing interface:
* Refactor `filtering` module to take DataArrays as input by lochhh in https://github.com/neuroinformatics-unit/movement/pull/209

Bugfix:
* Accessor `compute_` to only validate required `position` data variable by lochhh in https://github.com/neuroinformatics-unit/movement/pull/206

For developers

Changes in code architecture, aiming at improving ease of contribution and maintainability.

* Refactor validators by sfmig in https://github.com/neuroinformatics-unit/movement/pull/204
* Move logging.py inside utils by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/216
* Refactor validators tests by sfmig in https://github.com/neuroinformatics-unit/movement/pull/207
* Make video download optional for sample datasets by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/224
* Re-organise API reference by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/213

Paving the way for upcoming features:
* Add a ValidBboxesDataset class by sfmig in https://github.com/neuroinformatics-unit/movement/pull/201
* Add bboxes sample data by sfmig in https://github.com/neuroinformatics-unit/movement/pull/231

Housekeeping:
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/202
* Update supported Python versions by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/208
* Use raw string for ASCII art in CLI entrypoint by lochhh in https://github.com/neuroinformatics-unit/movement/pull/212
* Add missing __init__.py files by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/215
* Update python version in README.md by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/221
* Added ruff rule to check for numpy2.0 compatibility by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/227
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/233


**Full Changelog**: https://github.com/neuroinformatics-unit/movement/compare/v0.0.18...v0.0.19

What's Changed
* Tutorial polar coordinates by sfmig in https://github.com/neuroinformatics-unit/movement/pull/180
* Suggestion to rename ValidPosesCSV to ValidDeepLabCutCSV by sfmig in https://github.com/neuroinformatics-unit/movement/pull/195
* Added example using `median_filter()` and `savgol_filter()` by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/193
* Refactored modules related to input-output by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/194


**Full Changelog**: https://github.com/neuroinformatics-unit/movement/compare/v0.0.17...v0.018

What's Changed
* Unpin sphinx version in docs requirements by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/183
* Fix installation link and add quick install by sfmig in https://github.com/neuroinformatics-unit/movement/pull/185
* Suggestion to rename private loader by sfmig in https://github.com/neuroinformatics-unit/movement/pull/187
* Rename roadmap -> roadmaps in docs by sfmig in https://github.com/neuroinformatics-unit/movement/pull/188
* Added new smoothing functions to API index by ivanvrlg in https://github.com/neuroinformatics-unit/movement/pull/189

New Contributors
* ivanvrlg made their first contribution in https://github.com/neuroinformatics-unit/movement/pull/189

**Full Changelog**: https://github.com/neuroinformatics-unit/movement/compare/v0.0.16...v0.0.17

What's Changed

New features
* Polar kinematics by lochhh in https://github.com/neuroinformatics-unit/movement/pull/155
* Support video and frames files associated with sample data by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/171
* Add CLI entrypoint by lochhh in https://github.com/neuroinformatics-unit/movement/pull/176
* Implement Median and Savitzky-Golay Filters by b-peri in https://github.com/neuroinformatics-unit/movement/pull/163

Interface changes
* Rename pose_tracks to position by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/149
* Refactor accessor to provide methods instead of properties by lochhh in https://github.com/neuroinformatics-unit/movement/pull/174

Documentation
* Define the "movement dataset" and reorganise the Getting Started section by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/177

Housekeeping
* use Dataset.sizes instead of Dataset.dims for getting dimension sizes by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/153
* add merge_group as workflow trigger by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/154
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/157
* Overhaul linting and formatting by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/156
* Add viz extras to xarray dependency by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/161
* Enforce linting of docstrings by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/165
* Remove cibuildwheel config by adamltyson in https://github.com/neuroinformatics-unit/movement/pull/169
* Changed macos runners for GitHub CI by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/170
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/173
* update pypi dev status from pre-alpha to alpha by niksirbi in https://github.com/neuroinformatics-unit/movement/pull/172

New Contributors
* adamltyson made their first contribution in https://github.com/neuroinformatics-unit/movement/pull/169

**Full Changelog**: https://github.com/neuroinformatics-unit/movement/compare/v0.0.15...v0.0.16