Problem Description
Some the the ??solve functions inconsistent signature:
Almost all of them start with H, state0, tlist, the collapse if used, expectation, args and finally options.
But
- For
brmesolve, c_ops comes after e_ops.
- For HEOM: the bath is between the Hamiltonian and the initial state.
- Stochastic solver have
e_ops options and args as keyword only.
ntraj is positional for mcsolve, but keyword only for stochastic solver.
- Solver specific parameters are between
e_ops and args for floquet, between args and options for bloch redfield and after sc_ops in stochastic.
Proposed Solution
Make e_ops, args, options and ntraj keyword only from 5.3, with a warning message from 5.1.
This would make is all signatures, except HEOM, match.
For HEOM, the bath and max_depth should be swapped for the state and tlist.
Alternate Solutions
No response
Additional Context
No response
Problem Description
Some the the
??solvefunctions inconsistent signature:Almost all of them start with
H, state0, tlist, the collapse if used, expectation,argsand finally options.But
brmesolve,c_opscomes aftere_ops.e_opsoptionsandargsas keyword only.ntrajis positional formcsolve, but keyword only for stochastic solver.e_opsandargsfor floquet, betweenargsandoptionsfor bloch redfield and aftersc_opsin stochastic.Proposed Solution
Make
e_ops,args,optionsandntrajkeyword only from 5.3, with a warning message from 5.1.This would make is all signatures, except HEOM, match.
For HEOM, the
bathandmax_depthshould be swapped for thestateandtlist.Alternate Solutions
No response
Additional Context
No response