Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/user_guide/input_output.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ To programmatically query the supported source software names and their file suf
| [Anipose](anipose:) | | triangulation .csv file, or corresponding pandas DataFrame | Pose | Load |
| [VGG Image Annotator](via:) | VIA | .csv file for [tracks annotation](via:docs/face_track_annotation.html) | Bounding box | Load & Save |
| [Neurodata Without Borders](https://nwb-overview.readthedocs.io/en/latest/) | NWB | .nwb file or NWBFile object with the [ndx-pose extension](https://github.com/rly/ndx-pose) | Pose | Load & Save |
| [animovement](https://animovement.dev) / [aniframe](https://github.com/roaldarbol/aniframe) | | .parquet file | Pose | Load |
| Any | | Numpy arrays | Pose or Bounding box | Load & Save\* |

\*Exporting any `movement` DataArray to a NumPy array is as simple as calling xarray's built-in {meth}`xarray.DataArray.to_numpy()` method, so no specialised "Export/Save As" function is needed, see [xarray's documentation](xarray:user-guide/duckarrays.html) for more details.
Expand Down
18 changes: 18 additions & 0 deletions docs/source/user_guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ You may exchange `pyqt6` for `pyside6` if you prefer a different Qt backend.
See [napari's installation guide](napari:tutorials/fundamentals/installation.html)
for more details on available backends.

To enable loading [`aniframe`](https://animovement.dev/aniframe/) `.parquet`
files, additionally install `pyarrow` and `rdata`:
```sh
conda install -c conda-forge movement pyarrow rdata
```

:::

:::{tab-item} From PyPI using pip
Expand All @@ -59,6 +65,12 @@ If you wish to use the GUI, which requires [napari](napari:), run instead:
```sh
pip install "movement[napari]"
```
To enable loading [`aniframe`](https://animovement.dev/aniframe/) `.parquet`
files, install with the `aniframe` extra:
```sh
pip install "movement[aniframe]"
```
Extras can be combined, e.g. `pip install "movement[napari,aniframe]"`.
:::

:::{tab-item} From PyPI using uv
Expand All @@ -70,6 +82,12 @@ If you wish to use the GUI, which requires [napari](napari:), run instead:
```sh
uv pip install "movement[napari]"
```
To enable loading [`aniframe`](https://animovement.dev/aniframe/) `.parquet`
files, install with the `aniframe` extra:
```sh
uv pip install "movement[aniframe]"
```
Extras can be combined, e.g. `uv pip install "movement[napari,aniframe]"`.
:::

::::
Expand Down
Loading
Loading