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

Prepare for 0.6rc1 release #216

Merged
merged 12 commits into from
May 13, 2024
Merged

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented May 11, 2024

Description of the change

Release prep:

  • Bump version to release candidate 0.6rc1
  • Add @CSSFrancis to package credits
  • Update README to use format in orix
  • Update license year to 2024

Other changes:

  • Actually remove the class method StructureLibrary.from_crystal_systems(). The method previously threw a NotImplementedError, but will now throw an AttributeError. Mentioned in the changelog under Removed.
  • Replaced deprecated call to Rotation.from_neo_euler() with Rotation.from_axes_angles().

I've cleaned up the test suite a bit:

  • Replaced most uses of xfail(error) with with pytest.raises(error):. To me, it seems like best practice is to use the latter when we intentionally raise errors in the code, while the former is mostly used as a temporary measure for bugs that will be fixed.
  • Silenced some warnings by making pytest ignoring them
  • Close most of "opened" Matplotlib plots in tests using plt.close() (silencing a warning of > 20 open plots from Matplotlib)
  • Yield a temporary pickle file to tests via fixture, removing the need for manually removing the file in a test

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 diffsims/release_info.py and
    in .zenodo.json.

@hakonanes hakonanes added the dev label May 11, 2024
@hakonanes hakonanes added this to the v0.6.0 milestone May 11, 2024
@hakonanes hakonanes mentioned this pull request May 11, 2024
16 tasks
@hakonanes hakonanes requested a review from CSSFrancis May 11, 2024 08:46
@hakonanes
Copy link
Member Author

@CSSFrancis, I listed you as a maintainer alongside Duncan, Phillip, and myself in the release info. Which I thought you already were. I hope this is OK?

Copy link
Member

@CSSFrancis CSSFrancis left a comment

Choose a reason for hiding this comment

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

@CSSFrancis, I listed you as a maintainer alongside Duncan, Phillip, and myself in the release info. Which I thought you already were. I hope this is OK?

That's probably fine. I haven't really done much with diffsims until recently so it makes sense, I was planning on doing some more in the next couple of months.

As far as the PR goes I looked through all of the changes and it looks good to me

@hakonanes
Copy link
Member Author

Great and great!

Thanks for looking it over. We should be good to merge and release once your doc examples PR is in.

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>
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>
…tice

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes changed the title Prepare for 0.6.0 release Prepare for 0.6rc1 release May 13, 2024
@CSSFrancis CSSFrancis merged commit 870d632 into pyxem:main May 13, 2024
12 checks passed
@hakonanes hakonanes deleted the prep-for-0.6.0-release branch May 14, 2024 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants