Finesse API docs
Below you can find the API documentation for Finesse. Please note that the API documentation is not a substitute for the actual documentation. If critical information is only available in the api, please submit a bug report.
The API documentation is meant for power users who want to use Finesse as a library, e.g. writing building software on top of Finesse. You should not need to read any of the API docs to learn how to run a regular Finesse simulation.
- finesse
- finesse package
- Subpackages
- finesse.analysis package
- finesse.cli package
- finesse.components package
- finesse.cymath package
- finesse.detectors package
- finesse.knm package
- finesse.ligo package
- finesse.plotting package
- finesse.script package
- finesse.simulations package
- finesse.solutions package
- finesse.thermal package
- finesse.tracing package
- finesse.utilities package
- finesse.virgo package
- Submodules
- finesse.compilation_hash module
- finesse.config module
- finesse.constants module
- finesse.cyexpr module
- finesse.datastore module
- finesse.densematrix module
- finesse.element module
- finesse.element_workspace module
- finesse.enums module
- finesse.env module
- finesse.exceptions module
BeamTraceExceptionBrokenDOFLinkErrorComponentNotConnectedContextualArgumentErrorContextualTypeErrorContextualValueErrorControlledByDOFExceptionConvergenceExceptionDoubleConnectionErrorEvaluateResolvingSymbolErrorFinesseExceptionIllegalSelfReferencingInvalidRTLErrorLostLockModelAttributeErrorModelClassAttributeErrorModelMissingAttributeErrorModelParameterDefaultValueErrorModelParameterSelfReferenceErrorNoABCDCouplingNoCouplingErrorNoLinearEquationsNodeExceptionNotChangeableDuringSimulationParameterLockedTotalReflectionError
- finesse.freeze module
- finesse.frequency module
- finesse.gaussian module
- finesse.locks module
- finesse.materials module
- finesse.model module
- finesse.parameter module
- finesse.paths module
- finesse.symbols module
ConstantFunctionLazySymbolMAKE_LOP()MAKE_LOP_simplify_truediv()MAKE_ROP()MAKE_ROP_simplify_truediv()MAKE_simplify_add()MAKE_simplify_mul()MAKE_simplify_neg()MAKE_simplify_pos()MAKE_simplify_pow()MAKE_simplify_sub()MatrixResolvingSymbolVariableadd_sort_key()as_symbol()base_exponent()coefficient_and_term()collect()display()eval_symbolic_numpy()evaluate()expand()expand_mul()expand_pow()finesse2sympy()format_arg()is_integer()mul_sort_key()np_eval_symbolic_numpy()operator_add()operator_mul()operator_sub()reduce_mul_args()simplification()sympy2finesse()
- finesse.tree module
- finesse.warnings module
- Module contents
- Subpackages
- finesse package