Update setup docs

[lochhh]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?
This PR closes #254 and #262

What does this PR do?
This PR:

• updates the documentation to include conda installation instructions
• replaces pip install instructions in repo README quick install with conda instructions
• updates any mention of python 3.10 in the setup to python 3.11

References

#254 #262

How has this PR been tested?

Installed movement from conda locally and ran movement info
Docs built locally and on CI

Checklist:

• The code has been tested locally
• 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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.76%. Comparing base (8c45183) to head (99b9700).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #264   +/-   ##
=======================================
  Coverage   99.76%   99.76%           
=======================================
  Files          14       14           
  Lines         866      866           
=======================================
  Hits          864      864           
  Misses          2        2           

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

[sfmig]

thanks @lochhh for updating! yay for spotting the inconsistencies 🦅

Mostly minor comments on phrasing, which you can ofc take or leave. I had a go at using nested tabs, to retain the previous users/developers split, and also separated install and upgrade instructions. I like it, but feel free to edit or revert, it was mostly to see how it looked.

Re movement vs movement: I will dump my current thoughts in PR #266. For this PR I think it makes sense to just make it consistent with itself. If we later decide to go monospace we will need to search / review everything anyways.

[lochhh]

Thanks @sfmig for the suggestions! I agree that the update instructions seem hidden and love the idea of splitting install and update!

Regarding the users/developers tabs, I'm thinking now, if we should just redirect developers to the contributing guide, as

• the contributing guide has the same but more complete instructions (with the additional step to initialise the precommit hooks),
• this increases maintainability (we don't need to update the duplicate info in two places)

If we go with the "redirect developers" method, should we have these in separate subheadings, rather than having a Developers tab which they click into, only to find that they need to click again (this is just my personal preference though 🤔). I also think it looks cleaner like this:

I also changed the update instructions to recommend starting fresh instead, to prevent potential incompatibility issues - happy to revert if this is unnecessary.

Lmk your thoughts! 😄

[sonarcloud]

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 SonarCloud

[sfmig]

TLDR: I agree with everything 😁

I'm thinking now, if we should just redirect developers to the contributing guide

Yes, good call! Much better for the reasons you say

If we go with the "redirect developers" method, should we have these in separate subheadings

Yes, it looks great! Feels more spacious ✨ 👩‍🚀 (and as you say less clicking, yay!)

I also changed the update instructions to recommend starting fresh instead, to prevent potential incompatibility issues - happy to revert if this is unnecessary.

Again good call, love the clarity!

Thanks @lochhh, it's looking neat! 🚀