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

move segmentation 1d and 3d to tutorials/ #103

Merged
merged 8 commits into from
Nov 28, 2023

Conversation

alessandrofelder
Copy link
Member

@alessandrofelder alessandrofelder commented Nov 16, 2023

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

We don't have tutorials (in the diataxis sense) for brainglobe-segmentation.

What does this PR do?

  • moves the previous brainglobe-segmentation tutorials
  • edits them for simplicity with added screenshots
  • adds a simple (hacky, for now) script to produce screenshots automatically on my local machine.

References

Closes #83

Opened brainglobe/brainrender#280 to track a code snippet that I removed from the previous text - in case it comes in handy.

How has this PR been tested?

Repeated reading, and trying, of the tutorials.

Is this a breaking change?

Yes (some pages stop existing)

Does this PR require an update to the documentation?

This is an update to the documentation

Checklist:

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

Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

Very nice. I've left a few small comments.

docs/source/tutorials/segmenting-1d-tracks.md Outdated Show resolved Hide resolved
docs/source/tutorials/segmenting-1d-tracks.md Outdated Show resolved Hide resolved
docs/source/tutorials/segmenting-1d-tracks.md Outdated Show resolved Hide resolved
docs/source/tutorials/segmenting-1d-tracks.md Outdated Show resolved Hide resolved
docs/source/tutorials/segmenting-3d-structures.md Outdated Show resolved Hide resolved
alessandrofelder and others added 2 commits November 28, 2023 09:47
Co-authored-by: Adam Tyson <code@adamltyson.com>
@alessandrofelder alessandrofelder merged commit 2820d6b into main Nov 28, 2023
1 check passed
@alessandrofelder alessandrofelder deleted the segmentation-tutorials branch November 28, 2023 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add a simple tutorial outlining brainreg-segment
2 participants