API Documentation

This reference manual details the modules, classes and functions included in Finesse, describing what they are, what they do and (where relevant) mathematical descriptions of how they work. More in-depth coverage of the physics behind the code can be found in the Manual.

For learning how to get started with using Finesse, see also Getting Started.

finesse.analysis

Contains actions which can be performed on a model.

finesse.cmath

Fast C functions for common mathematical routines used across all the various Cython extensions of Finesse.

finesse.cmatrix

Sparse matrix objects with factorisation and solving routines performed via KLU.

finesse.components

The components module contains all the component type of an interferometer configuration including the general objects required to connect them and register node connections.

finesse.constants

finesse.densematrix

Sub-module consisting of the Simulation for performing specific executions of a Model.

finesse.detectors

The detectors sub-module contains various non-physical detectors that can be used to probe to simulation at any point.

finesse.element

The fundamental elements of a Finesse model - including parameters, symbols and operations.

finesse.enums

finesse.exceptions

Custom exception types raised by different Finesse functions and class methods.

finesse.freeze

Tools for making an arbitrary Finesse object freezable.

finesse.frequency

Frequency analysis tools.

finesse.gaussian

Gaussian beam related tools and utilities.

finesse.knm

Functions for the computation of coupling coefficients.

finesse.locks

Controlling an interferometer via error signals.

finesse.model

A sub-module containing the configuration container class Model which is used for building and manipulating interferometer systems.

finesse.paths

Containers for paths traversed through a configuration.

finesse.plotting

Plotting tools for Finesse, providing convenient style templates for matplotlib.pyplot and functions for quick visualisation of detector and/or probe outputs.

finesse.script

Parsing of both Finesse 3 model files and Finesse 2 kat files.

finesse.simulations

Holds the various instances of simulation classes.

finesse.solutions

Outputs from a simulation / analysis run.

finesse.tracing

Tools for tracing Gaussian beams through a Finesse Model instance.

finesse.tree

Tree data structure.

finesse.utilities

Useful common utility functions and classes used throughout the Finesse package.