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

Implement several renamings #105

Merged
merged 1 commit into from
Aug 1, 2023
Merged

Implement several renamings #105

merged 1 commit into from
Aug 1, 2023

Conversation

kbarros
Copy link
Member

@kbarros kbarros commented Jul 28, 2023

As described in versions.md:

Rename `polarize_spin!` to [`set_dipole!`](@ref) for consistency with
[`set_coherent!`](@ref). The behavior of the former function is unchanged: the
spin at a given site will still be polarized along the provided direction.

Rename `reshape_geometry` to [`reshape_supercell`](@ref), which is the
fundamental reshaping function. Rename `resize_periodically` to
[`resize_supercell`](@ref).

The constructor [`SpinInfo`](@ref) now requires a ``g``-factor or tensor as a
named argument.

@kbarros
Copy link
Member Author

kbarros commented Jul 28, 2023

@ddahlbom and @Lazersmoke, there is not much to review in the implementation, but I added you as reviewers in case you have comments about these breaking changes.

In particular, making g a required argument to SpinInfo will impact a lot of code. I think it's the right thing to do, and @ddahlbom had suggested it, but I was hoping to get final confirmation before merging.

@kbarros kbarros force-pushed the renames branch 2 times, most recently from 5db4e25 to 935814f Compare August 1, 2023 17:02
These replace reshape_geometry and resize_periodically.
@kbarros kbarros merged commit d645a74 into main Aug 1, 2023
3 checks passed
@kbarros kbarros deleted the renames branch August 1, 2023 21:53
@kbarros
Copy link
Member Author

kbarros commented Aug 1, 2023

David gave the thumbs up to merge.

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.

1 participant