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

Update Orientations api #303

Merged
merged 16 commits into from
Apr 17, 2024
Merged

Update Orientations api #303

merged 16 commits into from
Apr 17, 2024

Conversation

stefsmeets
Copy link
Contributor

@stefsmeets stefsmeets commented Apr 10, 2024

This PR adds some convenience methods to Orientations to make the api more accessible.

It also renames msad -> autocorrelation.

Closes #296
Closes #297

Todo

  • Update notebook

@stefsmeets stefsmeets marked this pull request as ready for review April 11, 2024 15:05
@stefsmeets
Copy link
Contributor Author

Hi @SCiarella could you have a look at this?

Particularly:

  1. msad -> autocorrelation change
  2. if it makes sense to derive nr_central_atoms from the trajectory directly

@stefsmeets stefsmeets requested a review from SCiarella April 15, 2024 11:07
Copy link
Contributor

@SCiarella SCiarella left a comment

Choose a reason for hiding this comment

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

Looks awesome!

I added a few comments. In particular, we could think about making cartesian_to_spherical return an Orientation and behave like the other transformations.


  1. msad -> autocorrelation change

Looks perfect

  1. if it makes sense to derive nr_central_atoms from the trajectory directly

Yes, it makes total sense

src/gemdat/__init__.py Show resolved Hide resolved
src/gemdat/orientations.py Show resolved Hide resolved
src/gemdat/orientations.py Show resolved Hide resolved
src/gemdat/utils.py Outdated Show resolved Hide resolved
src/gemdat/utils.py Outdated Show resolved Hide resolved
tests/orientations_test.py Show resolved Hide resolved
stefsmeets and others added 8 commits April 17, 2024 13:22
Co-authored-by: SCiarella <58949181+SCiarella@users.noreply.github.com>
Co-authored-by: SCiarella <58949181+SCiarella@users.noreply.github.com>
Co-authored-by: SCiarella <58949181+SCiarella@users.noreply.github.com>
@stefsmeets stefsmeets merged commit cdf4298 into main Apr 17, 2024
4 checks passed
@stefsmeets stefsmeets deleted the orientations-api branch April 17, 2024 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename 'mean squared angular displacement' to 'autocorrelation' everywhere Streamline Orientations api
2 participants