Library Structure¶
Subpackage Organization¶
QNET is organized into the sub-packages outlined in the above diagram. Each package may in turn contain several sub-modules. The arrows indicate which package imports from which other package.
Every package exports all public symbol from all of its sub-packages/-modules in a “flat” API. Thus, a user can directly import from the top-level qnet package.
In order from high-level to low-level:
qnet |
Main QNET package |
qnet.convert |
Conversion to QuTiP and Sympy |
qnet.visualization |
Visualization routines, e.g. |
qnet.printing |
Printing system for QNET Expressions and related objects |
qnet.algebra |
Symbolic quantum and photonic circuit (SLH) algebra |
qnet.algebra.toolbox |
Collection of tools to manually manipulate algebraic expressions |
qnet.algebra.library |
Collection of algebraic objects extending core |
qnet.algebra.core |
The fundamental object hiearchies that constitute QNET’s various algebras |
qnet.algebra.pattern_matching |
QNET’s pattern matching engine. |
qnet.utils |
Auxiliary utilities, mostly for internal use |
See also the full Module Index