Skip to content

Replace tutorial notebooks with example scripts#618

Draft
hakonanes wants to merge 10 commits intopyxem:developfrom
hakonanes:596-replace-tutorials-with-examples
Draft

Replace tutorial notebooks with example scripts#618
hakonanes wants to merge 10 commits intopyxem:developfrom
hakonanes:596-replace-tutorials-with-examples

Conversation

@hakonanes
Copy link
Member

@hakonanes hakonanes commented Jan 11, 2026

Description of the change

This PR replaces our tutorial notebooks with example scripts. The rationale for this is described in #596.

There's a large number of line changes. Little, if any, of the documentation content has been changed, just transferred from notebooks to example scripts. Therefore, when reviewing, it should be enough to go through the documentation and see that nothing was incorrectly formatted, i.e. focus on structure, not content.

Replacements:

  • clustering_across_fundamental_region_boundaries.ipynb -> orientations/clustering_across_fundamental_zone_boundaries.py
  • clustering_misorientations.ipynb -> misorientations/clustering_misorientations.py
  • crystal_directions.ipynb -> (split into many examples)
    • vectors/crystal_directions.py
    • vectors/crystal_plane_normals.py
    • vectors/zone_axes.py
    • vectors/trigonal_hexagonal_index_conventions.py
    • vectors/symmetrically_equivalent_directions_and_plane_normals.py
    • vectors/directions_and_planes_in_rotated_crystals.py
    • vectors/diamond_pole_figure.py
  • Crystal map
  • Inverse pole figures
  • Point groups
  • Pole density function
  • S2 sampling
  • Stereographic projection
  • Uniform sampling of orientation space

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.

…mple (pyxem#596)

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
…ple (pyxem#596)

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
…yxem#596)

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added this to the v0.15.0 milestone Jan 11, 2026
@hakonanes hakonanes added dev Package maintenance documentation Relates to the documentation labels Jan 11, 2026
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

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

Labels

dev Package maintenance documentation Relates to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant