Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve and update brainrender installation docs #107

Merged
merged 3 commits into from
Nov 29, 2023

Conversation

alessandrofelder
Copy link
Member

@alessandrofelder alessandrofelder commented Nov 29, 2023

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

  • For the upcoming release of brainrender we move to NEP 29.

What does this PR do?

  • Updates and future-proofs the brainrender install docs to the upcoming release
  • Mention in the installation docs that some Windows users need pyside2 from conda
  • Mention in the installtion docs that videos need ffmpeg installed

References

Closes #106
Closes #102

Partially addresses brainglobe/brainrender#253

How has this PR been tested?

Inspection of locally built website.

Is this a breaking change?

Nope.

Does this PR require an update to the documentation?

NA

Checklist:

  • The code has been tested locally (manually)
  • [NA] Tests have been added to cover all new functionality (unit & integration)
  • [NA] The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit


```bash
conda create --name brainrender python=3.8 -y
conda create --name brainrender -y
Copy link
Member

@adamltyson adamltyson Nov 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We surely need to install Python right? Might just be easiest to remove this section and just point to the general BG & conda docs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea I think this is a good idea. One nice thing about the new brainrender is that it's in line with the other BrainGlobe packages now.

@adamltyson adamltyson merged commit f39395b into main Nov 29, 2023
2 checks passed
@adamltyson adamltyson deleted the improve-brainrender-install branch November 29, 2023 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants