Skip to content

Commit b170507

Browse files
committed
update roadmaps and consistently use movement (monospace)
1 parent a790122 commit b170507

File tree

4 files changed

+18
-15
lines changed

4 files changed

+18
-15
lines changed

docs/source/community/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Community
22

3-
Contributions to movement are absolutely encouraged, whether to fix a bug,
3+
Contributions to `movement` are absolutely encouraged, whether to fix a bug,
44
develop a new feature, or improve the documentation.
55
To help you get started, we have prepared a statement on the project's [mission and scope](target-mission),
66
a [roadmap](target-roadmaps) outlining our current priorities, and a detailed [contributing guide](target-contributing).

docs/source/community/mission-scope.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Mission
55

6-
``movement`` aims to **facilitate the study of animal behaviour**
6+
`movement` aims to **facilitate the study of animal behaviour**
77
by providing a suite of **Python tools to analyse body movements**
88
across space and time.
99

@@ -40,13 +40,13 @@ packages specialized for this purpose, which will be compatible with
4040

4141
## Design principles
4242

43-
movement is committed to:
43+
`movement` is committed to:
4444
- __Ease of installation and use__. We aim for a cross-platform installation and are mindful of dependencies that may compromise this goal.
4545
- __User accessibility__, catering to varying coding expertise by offering both a GUI and a Python API.
4646
- __Comprehensive documentation__, enriched with tutorials and examples.
4747
- __Robustness and maintainability__ through high test coverage.
4848
- __Scientific accuracy and reproducibility__ by validating inputs and outputs.
4949
- __Performance and responsiveness__, especially for large datasets, using parallel processing where appropriate.
50-
- __Modularity and flexibility__. We envision movement as a platform for new tools and analyses, offering users the building blocks to craft their own workflows.
50+
- __Modularity and flexibility__. We envision `movement` as a platform for new tools and analyses, offering users the building blocks to craft their own workflows.
5151

5252
Some of these principles are shared with, and were inspired by, napari's [Mission and Values](napari:community/mission_and_values) statement.

docs/source/community/roadmaps.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
11
(target-roadmaps)=
22
# Roadmaps
33

4-
The roadmap outlines **current development priorities** and aims to **guide core developers** and to **encourage community contributions**. It is a living document and will be updated as the project evolves.
4+
This page outlines **current development priorities** and aims to **guide core developers** and to **encourage community contributions**. It is a living document and will be updated as the project evolves.
55

6-
The roadmap is **not meant to limit** movement features, as we are open to suggestions and contributions. Join our [Zulip chat](movement-zulip:) to share your ideas. We will take community demand and feedback into account when planning future releases.
6+
The roadmaps are **not meant to limit** `movement` features, as we are open to suggestions and contributions. Join our [Zulip chat](movement-zulip:) to share your ideas. We will take community demand and feedback into account when planning future releases.
77

88
## Long-term vision
99
The following features are being considered for the first stable version `v1.0`.
1010

11-
- __Import/Export pose tracks from/to diverse formats__. We aim to interoperate with leading tools for animal pose estimation and behaviour classification, and to enable conversions between their formats.
12-
- __Standardise the representation of pose tracks__. We represent pose tracks as [xarray data structures](xarray:user-guide/data-structures.html) to allow for labelled dimensions and performant processing.
13-
- __Interactively visualise pose tracks__. We are considering [napari](napari:) as a visualisation and GUI framework.
14-
- __Clean pose tracks__, including, but not limited to, handling of missing values, filtering, smoothing, and resampling.
15-
- __Derive kinematic variables__ like velocity, acceleration, joint angles, etc., focusing on those prevalent in neuroscience.
16-
- __Integrate spatial data about the animal's environment__ for combined analysis with pose tracks. This covers regions of interest (ROIs) such as the arena in which the animal is moving and the location of objects within it.
11+
- __Import/Export motion tracks from/to diverse formats__. We aim to interoperate with leading tools for animal tracking and behaviour classification, and to enable conversions between their formats.
12+
- __Standardise the representation of motion tracks__. We represent tracks as [xarray data structures](xarray:user-guide/data-structures.html) to allow for labelled dimensions and performant processing.
13+
- __Interactively visualise motion tracks__. We are experimenting with [napari](napari:) as a visualisation and GUI framework.
14+
- __Clean motion tracks__, including, but not limited to, handling of missing values, filtering, smoothing, and resampling.
15+
- __Derive kinematic variables__ like velocity, acceleration, joint angles, etc., focusing on those prevalent in neuroscience and ethology.
16+
- __Integrate spatial data about the animal's environment__ for combined analysis with motion tracks. This covers regions of interest (ROIs) such as the arena in which the animal is moving and the location of objects within it.
1717
- __Define and transform coordinate systems__. Coordinates can be relative to the camera, environment, or the animal itself (egocentric).
18+
- __Provide common metrics for specialised applications__. These applications could include gait analysis, pupillometry, spatial
19+
navigation, social interactions, etc.
20+
- __Integrate with neurophysiological data analysis tools__. We eventually aim to facilitate combined analysis of motion and neural data.
1821

1922
## Short-term milestone - `v0.1`
20-
We plan to release version `v0.1` of movement in early 2024, providing a minimal set of features to demonstrate the project's potential and to gather feedback from users. At minimum, it should include:
23+
We plan to release version `v0.1` of `movement` in early 2025, providing a minimal set of features to demonstrate the project's potential and to gather feedback from users. At minimum, it should include:
2124

2225
- [x] Ability to import pose tracks from [DeepLabCut](dlc:), [SLEAP](sleap:) and [LightningPose](lp:) into a common `xarray.Dataset` structure.
2326
- [x] At least one function for cleaning the pose tracks.
2427
- [x] Ability to compute velocity and acceleration from pose tracks.
2528
- [x] Public website with [documentation](target-movement).
2629
- [x] Package released on [PyPI](https://pypi.org/project/movement/).
2730
- [x] Package released on [conda-forge](https://anaconda.org/conda-forge/movement).
28-
- [ ] Ability to visualise pose tracks using [napari](napari:). We aim to represent pose tracks via napari's [Points](napari:howtos/layers/points) and [Tracks](napari:howtos/layers/tracks) layers and overlay them on video frames.
31+
- [ ] Ability to visualise pose tracks using [napari](napari:). We aim to represent pose tracks as napari [layers](napari:howtos/layers/index.html), overlaid on video frames.

docs/source/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Installation, first steps and key concepts.
1717
:link: examples/index
1818
:link-type: doc
1919

20-
A gallery of examples using movement.
20+
A gallery of examples using `movement`.
2121
:::
2222

2323
:::{grid-item-card} {fas}`comments;sd-text-primary` Join the movement

0 commit comments

Comments
 (0)