Skip to content

Making matplotlib_scalebar optional#555

Merged
argerlt merged 22 commits into
pyxem:developfrom
argerlt:make-matplotlib_scalebar-optional
Sep 22, 2025
Merged

Making matplotlib_scalebar optional#555
argerlt merged 22 commits into
pyxem:developfrom
argerlt:make-matplotlib_scalebar-optional

Conversation

@argerlt
Copy link
Copy Markdown
Collaborator

@argerlt argerlt commented May 2, 2025 •
edited by hakonanes
Loading

Description of the change

As discussed in #540, matplotlib_scalebar has caused install problems on certain systems. This PR would make the package an optional dependency.

This PR is currently a draft, contributions welcome. It still needs unit tests written and Jupyter notebooks updated (crystal_map.ipynb for sure, possibly others).

Completed and ready for review

Progress of the PR

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in
    .zenodo.json.

@argerlt argerlt marked this pull request as draft May 2, 2025 00:21
@argerlt argerlt added the status: needs-review This pull request needs a maintainer's review label May 16, 2025
@CSSFrancis CSSFrancis mentioned this pull request May 16, 2025
Closed
5 tasks
@argerlt argerlt marked this pull request as ready for review May 19, 2025 04:28
@argerlt argerlt mentioned this pull request Jun 23, 2025
Closed
@argerlt argerlt added this to the v0.14.0 milestone Jul 1, 2025
@argerlt argerlt requested a review from CSSFrancis July 3, 2025 17:32
hakonanes
hakonanes requested changes Jul 13, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@hakonanes hakonanes left a comment

Choose a reason for hiding this comment

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

Good stuff. I've requested some changes.

Comment thread CHANGELOG.rst Outdated
Comment thread orix/plot/crystal_map_plot.py Outdated
Comment thread orix/plot/crystal_map_plot.py Outdated
Comment thread orix/plot/crystal_map_plot.py Outdated
Comment thread orix/tests/plot/test_crystal_map_plot.py Outdated
Comment thread orix/tests/plot/test_crystal_map_plot.py Outdated
Comment thread orix/tests/test_crystal_map.py Outdated
Comment thread orix/tests/plot/test_crystal_map_plot.py Outdated
Comment thread pyproject.toml
@argerlt argerlt added status: waiting-for-author This pull request has comments the author must address and removed status: needs-review This pull request needs a maintainer's review labels Jul 13, 2025
hakonanes
hakonanes reviewed Jul 16, 2025
View reviewed changes
Comment thread orix/tests/test_plot/test_crystal_map_plot.py Outdated
hakonanes
hakonanes reviewed Jul 16, 2025
View reviewed changes
Comment thread orix/tests/test_crystal_map.py Outdated
hakonanes
hakonanes reviewed Jul 16, 2025
View reviewed changes
Comment thread orix/plot/crystal_map_plot.py Outdated
hakonanes
hakonanes reviewed Jul 17, 2025
View reviewed changes
Comment thread orix/plot/crystal_map_plot.py Outdated
@hakonanes
Copy link
Copy Markdown
Member

hakonanes commented Jul 17, 2025

If you rebase or merge develop into this branch, the doc build should pass.

@argerlt
Copy link
Copy Markdown
Collaborator Author

argerlt commented Jul 17, 2025 •
edited
Loading

> If you rebase or merge develop into this branch, the doc build should pass.

I merged, but it's still failing:
https://app.readthedocs.org/projects/orix/builds/28890391/#278844915--38
It looks like it's failing though because it's reading the package requirements form orix 0.13.dev3? That makes it sound like it's reading this build:
https://github.com/pyxem/orix/tree/v0.13.3

I'm not sure though; I've never set up anything on readthedocs before.

Nevermind, I'm bad at git and merged the wrong branch. It's fixed, and ow it's failing for a new, different reason.

@argerlt argerlt mentioned this pull request Jul 18, 2025
Draft
7 tasks
@argerlt argerlt added status: needs-review This pull request needs a maintainer's review and removed status: waiting-for-author This pull request has comments the author must address labels Jul 18, 2025
@hakonanes hakonanes removed the status: needs-review This pull request needs a maintainer's review label Jul 24, 2025
hakonanes
hakonanes reviewed Jul 24, 2025
View reviewed changes
Comment thread orix/plot/crystal_map_plot.py Outdated
hakonanes
hakonanes reviewed Jul 24, 2025
View reviewed changes
Comment thread orix/plot/crystal_map_plot.py Outdated
hakonanes
hakonanes reviewed Jul 24, 2025
View reviewed changes
Comment thread orix/plot/crystal_map_plot.py Outdated
hakonanes
hakonanes reviewed Jul 24, 2025
View reviewed changes
Comment thread orix/plot/crystal_map_plot.py Outdated
hakonanes
hakonanes reviewed Jul 24, 2025
View reviewed changes
Comment thread orix/plot/crystal_map_plot.py Outdated
@hakonanes hakonanes added the dev Package maintenance label Jul 24, 2025
@hakonanes
Copy link
Copy Markdown
Member

hakonanes commented Sep 22, 2025

Fixing the merge conflict here.

@hakonanes
Merge branch 'develop' into make-matplotlib_scalebar-optional
458ae6c 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Minor improvements to the installation guide
223f15f 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Re-add missing functionality in the orix.plot.__all__ list
76b9f21 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Correct default for scalebar param, check for it early to raise early
2d47daa 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Correct pytest invocation call when running "slow" tests
4b4bace 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Also update default in CrystalMap.plot()
41199cc 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Skip tests using matplotlib-scalebar when it's unavailable
63e2da8 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Clarify TODO removal comment
1a030bc 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Separate crystal map plot tests to one w/o matplotlib-scalebar
bdbbb18 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
hakonanes
hakonanes approved these changes Sep 22, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@hakonanes hakonanes left a comment

Choose a reason for hiding this comment

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

Good stuff! I'm happy with this now.

@argerlt argerlt merged commit 8cfa11a into pyxem:develop Sep 22, 2025
11 checks passed
@argerlt argerlt mentioned this pull request Sep 22, 2025
Closed
@argerlt argerlt deleted the make-matplotlib_scalebar-optional branch September 22, 2025 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hakonanes hakonanes hakonanes approved these changes

@CSSFrancis CSSFrancis Awaiting requested review from CSSFrancis

Assignees

No one assigned

Labels

dev Package maintenance

Projects

None yet

Milestone

v0.14.0

Development

Successfully merging this pull request may close these issues.

2 participants

@argerlt @hakonanes