finesse

Finesse is a Python package for simulating interferometers in the frequency domain.

Sub-modules

finesse.analysis

Contains actions which can be performed on a model.

finesse.cli

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.config

Configuration tools.

finesse.constants

finesse.cyexpr

Compiled symbolic expressions used internally via parameters and element workspaces.

finesse.cymath

Fast C functions providing common mathematical routines for the Cython level code in Finesse.

finesse.datastore

Finesse datastore tools.

finesse.densematrix

finesse.detectors

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

finesse.element

finesse.enums

finesse.env

Finesse environment information.

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

Library of coupling coefficient data structures and calculations.

finesse.locks

Controlling an interferometer via error signals.

finesse.materials

Material objects are a simple structure that contain commonly used properties for calculations.

finesse.model

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

finesse.parameter

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 and unparsing of Finesse kat files and models.

finesse.simulations

Holds the various instances of simulation classes.

finesse.solutions

Outputs from a simulation / analysis run.

finesse.symbols

Symbolic manipulations (expand, collect, etc.) are based on the book:

finesse.thermal

finesse.tracing

The beam tracing library of Finesse.

finesse.tree

Tree data structure.

finesse.utilities

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

finesse.warnings

Finesse-specific warnings.