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

Improve setting explanation in the guide #2403

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Ericgig
Copy link
Member

@Ericgig Ericgig commented Apr 23, 2024

Description
Completed the guide page of the settings to include missing entries as well as options included in settings.core and settings.compile. Added CoreOptions and CompileOptions to the apidoc and completed the docstrings.

I also removed settings that are no longer used anywhere.

Lastly I changed the default for accept_float compile option.

Presently, if an args is a float it cannot be updated to a complex:

>>> a = qutip.coefficient("A", args={"A": 1.})
>>> a(0, A=1j)
TypeError: must be real number, not complex

Creating a new coefficient work would be needed.

This will certainly cause an issue eventually, but updating it to complex automatically would cause some error with brmesolve spectra: (w > w0) as complex cannot be compared.

Without types, string are not any better than functions so removing them altogether is not ideal.

So I changed it to use complex when no comparison are done and float otherwise.

Related issues or PRs
fix #1524

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.

Document changed and new settings
1 participant