qutip_qtrl package

High-level interfaces

High-level interfaces to the optimal control features.

qutip_qtrl.pulseoptim

Wrapper functions that will manage the creation of the objects, build the configuration, and execute the algorithm required to optimise a set of ctrl pulses for a given (quantum) system.

Utilities

Optimal control utility functions.

`qutip_qtrl.dump`	Classes that enable the storing of historical objects created during the pulse optimisation.
`qutip_qtrl.errors`	Exception classes for the Quantum Control library
`qutip_qtrl.loadparams`	Loads parameters for config, termconds, dynamics and Optimiser objects from a parameter (ini) file with appropriate sections and options, these being Sections: optimconfig, termconds, dynamics, optimizer The options are assumed to be properties for these classes Note that new attributes will be created, even if they are not usually defined for that object
`qutip_qtrl.io`
`qutip_qtrl.stats`	Statistics for the optimisation Note that some of the stats here are redundant copies from the optimiser used here for calculations

Low-level interfaces

Internal interfaces to the optimal control features.

`qutip_qtrl.dynamics`	Classes that define the dynamics of the (quantum) system and target evolution to be optimised.
`qutip_qtrl.fidcomp`	Fidelity Computer
`qutip_qtrl.optimizer`	Classes here are expected to implement a run_optimization function that will use some method for optimising the control pulse, as defined by the control amplitudes.
`qutip_qtrl.optimconfig`	Configuration parameters for control pulse optimisation
`qutip_qtrl.optimresult`	Class containing the results of the pulse optimisation
`qutip_qtrl.propcomp`	Propagator Computer Classes used to calculate the propagators, and also the propagator gradient when exact gradient methods are used
`qutip_qtrl.pulsegen`	Pulse generator - Generate pulses for the timeslots Each class defines a gen_pulse function that produces a float array of size num_tslots.
`qutip_qtrl.symplectic`	Utility functions for symplectic matrices
`qutip_qtrl.termcond`	Classes containing termination conditions for the control pulse optimisation i.e. attributes that will be checked during the optimisation, that will determine if the algorithm has completed its task / exceeded limits.
`qutip_qtrl.tslotcomp`	Timeslot Computer These classes determine which dynamics generators, propagators and evolutions are recalculated when there is a control amplitude update.