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

Rename dynamics solver functions #9

Open
cerisola opened this issue Jul 6, 2023 · 1 comment
Open

Rename dynamics solver functions #9

cerisola opened this issue Jul 6, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@cerisola
Copy link
Member

cerisola commented Jul 6, 2023

Currently, all dynamics functions are called diffeqsolver, which, while to the point of what it does, might not be the clearest name for a new user. Furthermore, it makes the spin vs harmonic-oscillator difference very subtle (maybe this is good?).

We could rename these functions, so that they are more explicit, e.g. spin_dynamics(...) and harmonic_osc_dynamics(...) (or something like stochastic_dynamics(...) if we want to keep the same name for both).

To keep backwards compatibility, we could still define the diffeqsolver function names, so if current users update the library, their code keeps running (once we have proper releases and versioning, we can then drop the backwards compatibility at an appropriate major release).

@cerisola cerisola added the enhancement New feature or request label Jul 6, 2023
@mekise
Copy link
Member

mekise commented Feb 2, 2024

I think we can keep this on hold until the major release with Chebyshev poly is released. Then, we can rename as spin_dynamics and harmonic_oscillator_dynamics dropping backward compatibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants