Document napari plugin

[niksirbi]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other: Documentation

Why is this PR needed?

Closes #283

What does this PR do?
This PR puts some final necessary touches before we are able to release the napari plugin into the world.

• It modifies installation instructions to account for the napari plugin
• Add napari-video and pyvideoreader to the [napari] extras dependencies. These are necessary for loading videos into as an image layer in napari.
• Adds a new page on the "User guide" documenting how to install and use the movement plugin for napari. This guide includes some warnings, to manage expectations, and some advice on how to troubleshoot video playback issues.
• To ameliorate the aforementioned playback issues, which mostly manifest when trying to "play" the video in napari at hifgh fps, I modified the default behaviour of the plugin. Previously, the plugin changed napari's playback fps setting to the same value as the loaded data (e.g. if loading data tracked at 60 fps, the plugin would automatically set napari's palyback speed to that values, so that the video would play "in real time" by default). This PR removes that feature, and instead leaves that choice entirely to the user (documented in the guide). This means that user's will get napari's default playback rate of 10 fps, and can choose to change that however they like.

References

After this PR is successfully merged into napari-dev, we will have achieved all tasks listed under the meta-issue #31.
After that, we can finally merge napari-dev into main, write a blogpost about the plugin and finally make our v0.1.0 release.

How to review this PR

The best way to review the PR would be to build the docs locally, and then follow the instructions in updated docs, i.e.:

• install movement in dev mode (this also gets you all the napari-related dependencies
• Follow "The napari plugin" user guide and see if you can reproduce my steps. You can use some of our sample data if you don't have access to your own. The datasets containing "EPM" or "Aeon" have associated videos with them, so you can do ds = sample_data.fetch_dataset(filename, with_video=True), and find the files in ~/.movement.

The reason I'm tagging many reviewers here is the following:

• I want the workflow to be tested on as may computers and OSes as possible
• @willGraham01. @sfmig and @stellaprins will soon be undertaking further napari plugin development, so I thought y'all will benefit from seeing the current (limited) status quo.
• @lochhh is a Windows user and has previously reported some issues with napari.

How has this PR been tested?

No new functionality has been added. Some tests were modified to account for the removal of the aforementioned fps functionality.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

It is, for the most part, an update to documentation.

Checklist:

• The code has been tested locally
• [n/a] Tests have been added to cover all new functionality
• The documentation has been updated to reflect any changes
• The code has been formatted with pre-commit

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.82%. Comparing base (5d5e5ed) to head (28a5dfa).
Report is 10 commits behind head on napari-dev.

Additional details and impacted files

@@             Coverage Diff             @@
##           napari-dev     #393   +/-   ##
===========================================
  Coverage       99.82%   99.82%           
===========================================
  Files              18       18           
  Lines            1122     1172   +50     
===========================================
+ Hits             1120     1170   +50     
  Misses              2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.