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 package
- Subpackages
- finesse.analysis package
- finesse.cli package
- finesse.components package
- Subpackages
- Submodules
- finesse.components.beamsplitter module
- finesse.components.cavity module
- finesse.components.directional_beamsplitter module
- finesse.components.dof module
- finesse.components.electronics module
- finesse.components.frequency_loss module
- finesse.components.gauss module
- finesse.components.general module
- finesse.components.isolator module
- finesse.components.laser module
- finesse.components.lens module
- finesse.components.mechanical module
- finesse.components.mirror module
- finesse.components.modulator module
- finesse.components.node module
- finesse.components.nothing module
- finesse.components.optical_bandpass module
- finesse.components.readout module
- finesse.components.replace module
- finesse.components.signal module
- finesse.components.space module
- finesse.components.squeezer module
- finesse.components.surface module
- finesse.components.telescope module
- finesse.components.trace_dependency module
- finesse.components.wire module
- finesse.components.workspace module
- Module contents
- finesse.cymath package
- finesse.detectors package
- Subpackages
- Submodules
- finesse.detectors.amplitude_detector module
- finesse.detectors.astigmatism_detector module
- finesse.detectors.bpdetector module
- finesse.detectors.camera module
- finesse.detectors.cavity_detector module
- finesse.detectors.field_detector module
- finesse.detectors.general module
- finesse.detectors.gouy module
- finesse.detectors.knmdetector module
- finesse.detectors.math_detector module
- finesse.detectors.mismatch_detector module
- finesse.detectors.motion_detector module
- finesse.detectors.optimal_q module
- finesse.detectors.pdtypes module
- finesse.detectors.powerdetector module
- finesse.detectors.quantum_noise_detector module
- finesse.detectors.workspace module
- Module contents
- finesse.knm package
- finesse.ligo package
- finesse.plotting package
- finesse.script package
- Submodules
- finesse.script.adapter module
- finesse.script.compiler module
- finesse.script.containers module
- finesse.script.exceptions module
- finesse.script.generator module
- finesse.script.graph module
- finesse.script.highlighter module
- finesse.script.legacy module
- finesse.script.memoize module
- finesse.script.parser module
- finesse.script.spec module
- finesse.script.tokenizer module
- finesse.script.tokens module
- finesse.script.util module
- Module contents
- finesse.simulations package
- finesse.solutions package
- finesse.thermal package
- finesse.tracing package
- finesse.utilities package
- Submodules
- finesse.utilities.aberrations module
- finesse.utilities.blockdiag module
- finesse.utilities.bug_report module
- finesse.utilities.collections module
- finesse.utilities.components module
- finesse.utilities.control module
- finesse.utilities.cyomp module
- finesse.utilities.docs module
- finesse.utilities.functools module
- finesse.utilities.graph module
- finesse.utilities.homs module
- finesse.utilities.logging module
- finesse.utilities.maps module
- finesse.utilities.misc module
- finesse.utilities.network_filter module
- finesse.utilities.numbers module
- finesse.utilities.polyfit module
- finesse.utilities.storage module
- finesse.utilities.tables module
- finesse.utilities.text module
- finesse.utilities.types module
- finesse.utilities.units module
- finesse.utilities.wigner module
- Module contents
- finesse.virgo package
- Submodules
- finesse.config module
- finesse.constants module
- finesse.cyexpr module
- finesse.datastore module
- finesse.densematrix module
DenseMatrixDenseMatrix.SubMatrixViewDenseMatrix.add_block()DenseMatrix.clear_rhs()DenseMatrix.construct()DenseMatrix.declare_equations()DenseMatrix.declare_subdiagonal_view()DenseMatrix.declare_submatrix_view()DenseMatrix.get_matrix_elements()DenseMatrix.get_submatrix()DenseMatrix.nameDenseMatrix.num_equationsDenseMatrix.print_matrix()DenseMatrix.print_rhs()DenseMatrix.set_rhs()DenseMatrix.solve()
- finesse.element module
- finesse.element_workspace module
- finesse.enums module
- finesse.env module
- finesse.exceptions module
BeamTraceExceptionComponentNotConnectedContextualArgumentErrorContextualTypeErrorContextualValueErrorConvergenceExceptionDoubleConnectionErrorEvaluateResolvingSymbolErrorExternallyControlledExceptionFinesseExceptionIllegalSelfReferencingInvalidRTLErrorLostLockModelAttributeErrorModelClassAttributeErrorModelMissingAttributeErrorModelParameterDefaultValueErrorModelParameterSelfReferenceErrorNoABCDCouplingNoCouplingErrorNoLinearEquationsNodeExceptionNotChangeableDuringSimulationParameterLockedTotalReflectionError
- finesse.freeze module
- finesse.frequency module
- finesse.gaussian module
- finesse.locks module
- finesse.materials module
- finesse.model module
EventIOMatrixInputMatrixModelModel.ABCD()Model.NhomsModel.acc_gouy()Model.add()Model.add_all_ad()Model.add_fd_to_every_node()Model.add_frequency()Model.add_matched_gauss()Model.add_parameter()Model.all_parametersModel.analysisModel.beam_trace()Model.built()Model.cavitiesModel.cavity_mismatch()Model.cavity_mismatches_table()Model.chain()Model.component_tree()Model.componentsModel.compute_space_gouys()Model.connect()Model.create_mismatch()Model.deepcopy()Model.detect_mismatches()Model.detectorsModel.disconnect()Model.display_signal_blockdiagram()Model.dofsModel.element_order()Model.elementsModel.f0Model.frequenciesModel.gaussesModel.get()Model.get_active_signal_nodes()Model.get_changing_edges_elements()Model.get_element()Model.get_elements_connected_to()Model.get_elements_of_type()Model.get_frequency_object()Model.get_network()Model.get_open_ports()Model.get_parameters()Model.hom_labelsModel.homsModel.include_modes()Model.info()Model.input_matrix_dcModel.is_builtModel.is_modalModel.is_tracedModel.k0Model.lambda0Model.last_traceModel.link()Model.locksModel.merge()Model.mismatches_table()Model.mode_index_mapModel.modes()Model.modes_settingModel.networkModel.optical_networkModel.optical_nodesModel.parametersModel.parse()Model.parse_file()Model.parse_legacy()Model.parse_legacy_file()Model.path()Model.phase_config()Model.phase_levelModel.plot_dcfields_graph()Model.plot_graph()Model.plot_symbolic_network()Model.propagate_beam()Model.propagate_beam_astig()Model.readoutsModel.reduce_get_attr()Model.reduce_set_attr()Model.remove()Model.remove_modes()Model.replace()Model.reset_sim_trace_config()Model.run()Model.save()Model.set()Model.signal_nodesModel.sim_initial_trace_argsModel.sim_trace_configModel.sim_trace_config_manager()Model.sort_elements()Model.space_gouys_table()Model.sub_model()Model.switch_off_homs()Model.symbolic_networkModel.tag_node()Model.temporary_parameters()Model.to_component_network()Model.trace_forestModel.trace_orderModel.trace_order_namesModel.unbuild()Model.unparse()Model.unparse_file()Model.update_gauss()
OutputMatrixload()locked_when_built()make_optical_network_view()
- finesse.parameter module
EnumCasterGeometricParameterParameterParameter.changeable_during_simulationParameter.datatypeParameter.datatype_cast()Parameter.descriptionParameter.eval()Parameter.eval_stringParameter.full_nameParameter.is_changingParameter.is_default_for_ownerParameter.is_externally_controlledParameter.is_geometricParameter.is_nrParameter.is_symbolicParameter.is_tunableParameter.lambdify()Parameter.lockedParameter.nameParameter.ownerParameter.refParameter.remove_external_setter()Parameter.resolve()Parameter.set_descendants()Parameter.set_external_setter()Parameter.stateParameter.unitsParameter.value
ParameterRefParameterStatePostValidatorValidatorbool_parameter()deref()enum_parameter()float_parameter()info_parameter()int_parameter()parameterproperty
- 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()MatrixResolvingSymbolSymbol.all()Symbol.arccos()Symbol.arcsin()Symbol.arctan()Symbol.arctan2()Symbol.changing_parameters()Symbol.collect()Symbol.conj()Symbol.conjugate()Symbol.cos()Symbol.deg2rad()Symbol.degrees()Symbol.eval()Symbol.exp()Symbol.expand()Symbol.expand_symbols()Symbol.imagSymbol.is_changingSymbol.lambdify()Symbol.log()Symbol.log10()Symbol.parameters()Symbol.rad2deg()Symbol.radians()Symbol.realSymbol.sin()Symbol.sqrt()Symbol.substitute()Symbol.sympy_simplify()Symbol.tan()Symbol.to_binary_add_mul()Symbol.to_nary_add_mul()Symbol.to_sympy()Symbol.value
Variableadd_sort_key()as_symbol()base_exponent()coefficient_and_term()collect()display()eval_symbolic_numpy()evaluate()expand()expand_mul()expand_pow()finesse2sympy()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
- 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.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
BeamTraceExceptionComponentNotConnectedContextualArgumentErrorContextualTypeErrorContextualValueErrorConvergenceExceptionDoubleConnectionErrorEvaluateResolvingSymbolErrorExternallyControlledExceptionFinesseExceptionIllegalSelfReferencingInvalidRTLErrorLostLockModelAttributeErrorModelClassAttributeErrorModelMissingAttributeErrorModelParameterDefaultValueErrorModelParameterSelfReferenceErrorNoABCDCouplingNoCouplingErrorNoLinearEquationsNodeExceptionNotChangeableDuringSimulationParameterLockedTotalReflectionError
- 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()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