Skip to content

Commit

Permalink
Fix installation link and add quick install (#185)
Browse files Browse the repository at this point in the history
* Fix installation link in readme

It was returning 404

* Add quick install

* Remove TOC

* Include full in installation link highlight
  • Loading branch information
sfmig authored May 23, 2024
1 parent b2de775 commit 36fa102
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,25 @@

A Python toolbox for analysing body movements across space and time, to aid the study of animal behaviour in neuroscience.

> [!Note]
> Read the [documentation](https://movement.neuroinformatics.dev) for more information, including [installation instructions](https://movement.neuroinformatics.dev/getting_started.html#installation) and [examples](https://movement.neuroinformatics.dev/examples/index.html).
- [Overview](#overview)
- [Status](#status)
- [Join the movement](#join-the-movement)
- [License](#license)
- [Package template](#package-template)

![](docs/source/_static/movement_overview.png)

## Quick install

First, create and activate a conda environment with the required dependencies:
```
conda create -n movement-env -c conda-forge python=3.10 pytables
conda activate movement-env
```

Then install the `movement` package:
```
pip install movement
```

> [!Note]
> Read the [documentation](https://movement.neuroinformatics.dev) for more information, including [full installation instructions](https://movement.neuroinformatics.dev/getting_started/installation.html) and [examples](https://movement.neuroinformatics.dev/examples/index.html).
## Overview

Pose estimation tools, such as [DeepLabCut](https://www.mackenziemathislab.org/deeplabcut) and [SLEAP](https://sleap.ai/) are now commonplace when processing video data of animal behaviour. There is not yet a standardised, easy-to-use way to process the pose tracks produced from these software packages.
Expand Down

0 comments on commit 36fa102

Please sign in to comment.