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

Remove most unicode from public API #242

Merged
merged 3 commits into from
Mar 4, 2024
Merged

Remove most unicode from public API #242

merged 3 commits into from
Mar 4, 2024

Conversation

kbarros
Copy link
Member

@kbarros kbarros commented Mar 3, 2024

Replace keyword arguments:

  • Δt with dt
  • λ with damping

Using the old symbols will emit a deprecation warning, and will break in 0.6.

@kbarros kbarros requested a review from ddahlbom March 3, 2024 18:13
Copy link
Member

@ddahlbom ddahlbom left a comment

Choose a reason for hiding this comment

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

Took a quick pass over this. Looks good to me.

You want to eliminate the omegas and and energy_epsilon at a later point?

@kbarros
Copy link
Member Author

kbarros commented Mar 4, 2024

Follow-up from discussion on Slack:

For LSWT, I will replace energy_ϵ with a new maxshift that only applies the shift if the quadratic hamiltonian has negative eigenvalues, and then, only as much as needed (up to maxshift). Then additionally, I will add energy_cutoff that cuts off intensities below an energy threshold, for consistency with KPM. Some of this might get pushed to 0.6.

For the ω related changes, I think we will do something like energies = ... where the right-hand side is a Julia Range. This new interface would take liberty to adapt the dt as needed. I'd like more time to think about it, and it might also get pushed to 0.6.

The immediate need that this PR addresses is avoiding the introduction of more unicode in the integrators that would soon be deprecated. That was the main blocker to Sunny 0.5.9.

@kbarros kbarros merged commit 76a15b2 into main Mar 4, 2024
4 checks passed
@kbarros kbarros deleted the less_unicode branch March 4, 2024 16:52
ddahlbom pushed a commit that referenced this pull request Mar 10, 2024
* Replace λ with damping
* Replace Δt with dt
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.

2 participants