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

Add description of how to navigate RGBA images to the kikuchipy documentation #653

Merged
merged 10 commits into from
Aug 29, 2023

Conversation

AndreasBugten
Copy link
Contributor

@AndreasBugten AndreasBugten commented Aug 28, 2023

Description of the change

In the kikuchipy documentation it is not described how one can navigate in RGBA images. The description can be added to the "Any image" part in the tutorial "Visualizing patterns" (https://kikuchipy.org/en/stable/tutorials/visualizing_patterns.html#Any-image).

Progress of the PR

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • [N/A] New functions are imported in corresponding __init__.py.
  • [N/A] New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • New contributors are added to release.py, .zenodo.json and
    .all-contributorsrc with the table regenerated.

Signed-off-by: AndreasBugten <andreas.v.bugten@ntnu.no>
@hakonanes
Copy link
Member

Thanks for this suggestion, @AndreasBugten. Can you remove the test.txt file and add the suggestion to the appropriate part of the relevant tutorial: https://github.com/pyxem/kikuchipy/blob/develop/doc/tutorials/visualizing_patterns.ipynb?

@hakonanes hakonanes added the documentation This relates to the documentation label Aug 28, 2023
@hakonanes hakonanes added this to the v0.9.0 milestone Aug 28, 2023
AndreasBugten and others added 7 commits August 28, 2023 16:45
Signed-off-by: AndreasBugten <andreas.v.bugten@ntnu.no>
Signed-off-by: AndreasBugten <andreas.v.bugten@ntnu.no>
Signed-off-by: AndreasBugten <andreas.v.bugten@ntnu.no>
Signed-off-by: AndreasBugten <andreas.v.bugten@ntnu.no>
Signed-off-by: AndreasBugten <andreas.v.bugten@ntnu.no>
@hakonanes
Copy link
Member

hakonanes commented Aug 29, 2023

The change looks good, @AndreasBugten! https://kikuchipy--653.org.readthedocs.build/en/653/tutorials/visualizing_patterns.html#Any-image

To clarify that the two new maps come from two different plotting commands, I'll split the cells into two after CrystalMap.plot() is called.

I'll also add you as a contributor. Is it OK if I add NTNU as your affiliation and your ORCID, like this?

"name": "Håkon Wiik Ånes",
"orcid": "0000-0002-1213-2911",
"affiliation": "Norwegian University of Science and Technology"

@AndreasBugten
Copy link
Contributor Author

AndreasBugten commented Aug 29, 2023

That is ok, @hakonanes! Thank you very much.

@hakonanes
Copy link
Member

Andreas V. Bugten or just Andreas Bugten?

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@AndreasBugten
Copy link
Contributor Author

Andreas V. Bugten is good. Thank you.

@hakonanes hakonanes merged commit b7d626c into pyxem:develop Aug 29, 2023
10 checks passed
@hakonanes
Copy link
Member

Thank you for your first contribution to kikuchipy, @AndreasBugten! I'm hoping for more...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants