qnet package

Main QNET package

The qnet package exposes all of QNET’s functionality for easy interactive or programmative use.

For interactive usage, the package should be initialized as follows:

>>> import qnet
>>> qnet.init_printing()

QNET provides a “flat” API. That is, after

>>> import qnet

all submodules are directly accessible, e.g.

>>> qnet.algebra.core.operator_algebra.OperatorSymbol
<class 'qnet.algebra.core.operator_algebra.OperatorSymbol'>

Furthermore, every package exports the “public” symbols of any of its submodules/subpackages (public symbols are those listed in __all__)

>>> (qnet.algebra.core.operator_algebra.OperatorSymbol is
...  qnet.algebra.core.OperatorSymbol is qnet.algebra.OperatorSymbol is
...  qnet.OperatorSymbol)
True

In an interactive context (and only there!), a star import such as

from qnet.algebra import *

may be useful.

Subpackages:

Summary

__all__: ABCD, Adjoint, AlgebraError, AlgebraException, BadLiouvillianError, BasisKet, BasisNotSetError, Beamsplitter, Bra, BraKet, CIdentity, CPermutation, CannotConvertToABCD, CannotConvertToSLH, CannotEliminateAutomatically, CannotSimplify, CannotSymbolicallyDiagonalize, CannotVisualize, Circuit, CircuitSymbol, CircuitZero, CoherentDriveCC, CoherentStateKet, Commutator, Component, Concatenation, Create, Destroy, Displace, Expression, FB, Feedback, FockIndex, FullSpace, HilbertSpace, II, IdentityOperator, IdentitySuperOperator, IdxSym, ImAdjoint, ImMatrix, IncompatibleBlockStructures, IndexOverFockSpace, IndexOverList, IndexOverRange, IndexedSum, InfiniteSumError, IntIndex, Jminus, Jmjmcoeff, Jpjmcoeff, Jplus, Jz, Jzjmcoeff, Ket, KetBra, KetIndexedSum, KetPlus, KetSymbol, KroneckerDelta, LocalKet, LocalOperator, LocalProjector, LocalSigma, LocalSpace, MatchDict, Matrix, NonSquareMatrix, NullSpaceProjector, Operation, Operator, OperatorIndexedSum, OperatorOperation, OperatorPlus, OperatorPlusMinusCC, OperatorSymbol, OperatorTimes, OperatorTimesKet, OperatorTrace, OverlappingSpaces, P_sigma, Pattern, Phase, PhaseCC, ProductSpace, PseudoInverse, ReAdjoint, ReMatrix, SCALAR_TYPES, SLH, SLH_to_qutip, SPost, SPre, ScalarTimesExpression, ScalarTimesKet, ScalarTimesOperator, ScalarTimesSuperOperator, SeriesInverse, SeriesProduct, SingleOperatorOperation, Singleton, SingletonType, SpaceTooLargeError, Squeeze, StrLabel, SuperAdjoint, SuperCommutativeHSOrder, SuperOperator, SuperOperatorOperation, SuperOperatorPlus, SuperOperatorSymbol, SuperOperatorTimes, SuperOperatorTimesOperator, TensorKet, TrivialKet, TrivialSpace, UnequalSpaces, WrongCDimError, WrongSignatureError, X, Y, Z, ZeroKet, ZeroOperator, ZeroSuperOperator, adjoint, all_symbols, anti_commutator, ascii, block_matrix, cid, cid_1, circuit_identity, commutator, configure_printing, connect, convert_to_qutip, convert_to_sympy_matrix, create_operator_pm_cc, decompose_space, diagm, dotprint, draw_circuit, draw_circuit_canvas, eval_adiabatic_limit, evaluate_commutators, expand_commutators_leibniz, expand_indexed_sum, expand_operator_pm_cc, extra_binary_rules, extra_rules, extract_signal, extract_signal_circuit, factor_coeff, factor_for_trace, getABCD, get_coeffs, get_common_block_structure, hstackm, identity_matrix, indexed_sum_over_const, indexed_sum_over_kronecker, init_printing, latex, lindblad, liouvillian, liouvillian_normal_form, map_signals, map_signals_circuit, match_pattern, move_drive_to_H, no_instance_caching, no_rules, pad_with_identity, pattern, pattern_head, permutation_matrix, prepare_adiabatic_limit, print_tree, simplify, simplify_by_method, simplify_scalar, singleton_object, space, srepr, substitute, temporary_instance_cache, tex, tr, tree, try_adiabatic_elimination, unicode, vstackm, wc, zerosm

Reference