Skip to content

Guide about unit and scale aware rendering#1032

Open
TimMonko wants to merge 8 commits into
napari:mainfrom
TimMonko:units-guide
Open

Guide about unit and scale aware rendering#1032
TimMonko wants to merge 8 commits into
napari:mainfrom
TimMonko:units-guide

Conversation

@TimMonko
Copy link
Copy Markdown
Contributor

@TimMonko TimMonko commented May 28, 2026

References and relevant issues

Closes #38
Closes #954

napari PRs:
the original units to layers PR: napari/napari#6979
rendering calculation with units: napari/napari#7889
updating unit rendering example: napari/napari#8767
setting pixel as default scale bar unit: napari/napari#8900 (comment)
scale bar units from layers: napari/napari#8907 (comment)
removing scale_bar.unit (will be merged soon): napari/napari#9007

napari-metadata discussion: how things work with pint and units: napari/napari-metadata#115

discussions about scale bar, units, appearance, and scale:
https://forum.image.sc/t/increasing-font-size-and-repositioning-the-scale-bar/97972/3
https://forum.image.sc/t/check-out-and-and-give-feedback-on-napari-0-7-0rc0/119662/2

Description

Adding narrative documentation as a guide about scale and unit aware rendering.
See: #release > 0.7.1 units and scalebar -- not working as intended?? for my ask for help and discussion on some issues
I intentionally cross reference to gallery examples and other documentation to avoid duplication and maintenance.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 28, 2026
Copy link
Copy Markdown
Contributor

@brisvag brisvag left a comment

Choose a reason for hiding this comment

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

Left some suggestions!

One general note: while I get the reason of always pairing scale with units (it's a simple hand-in-hand combination), it should be made clear that all transforms are unit-aware (at least I hope so ??)

Comment thread docs/guides/units.md Outdated
@TimMonko TimMonko added this to the 0.7.1 milestone May 28, 2026
@TimMonko TimMonko added the highlight highlight this PR in release notes label May 28, 2026
@TimMonko
Copy link
Copy Markdown
Contributor Author

@Czaki, I added highlight to this because I think its worth linking to in the release notes to help explain all the changes that come in 0.7.1 (and also 0.7.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation highlight highlight this PR in release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add unit rendering info to docs Include user-facing info about scale bars

2 participants