Logo
3.0a1
  • Introduction to Finesse
    • Motivation and History
  • Getting started
    • Installation
      • Release version
      • From source
        • Linux / Mac OSX / WSL
        • Windows
      • Keeping your development version up to date
      • Troubleshooting installation from source on Windows
    • Key concepts
      • Detectors and probes
      • The model graph
      • The simulation matrix
    • Migrating from Pykat + Finesse 2
      • Trace verbosity
        • Listing TEM modes used (‘trace 1’)
        • Accessing cavity parameters (‘trace 2’)
        • Current mode mismatch parameters (‘trace 4’)
        • Beam parameters for every node (‘trace 8’)
        • Access Gouy phases for all spaces (‘trace 16’)
        • Coupling coefficients of components (‘trace 32’)
        • Mode mismatches during a simulation (‘trace 64’)
        • Nodes found during the beam tracing (‘trace 128’)
      • Example of migration from Pykat + Finesse 2
        • Finesse 2
        • Finesse 3
      • Creating a model
      • Major syntax changes
      • The port and node system
      • Inline expressions
      • Variables, constants and references
      • Running a model
    • Example 1 - simple cavity
      • The optical configuration
      • The Finesse model
      • Plotting the outputs
      • Printing model information
    • Example 2 - a Pound-Drever-Hall lock
      • The optical setup
      • Optimising the demodulation phase
      • Closing the loop
      • Using complex power demodulation for demodulation phase calculation
    • Example 3 - near unstable cavities
      • The model
      • Designing an input telescope
      • Plotting a cavity scan
    • Example 4 - extracting geometrical parameters
      • Geometrical parameters
      • Finesse model
      • Relating the models
      • Discussion
    • Example 5 - modulation and Bessel functions
      • The optical configuration
      • The Finesse model
      • Output plots
    • Example 6 - radiation pressure
      • The optical configuration
      • The Finesse model
      • Output plots
    • Example 7 - squeezing and homodyne detection
      • The optical configuration
      • The Finesse model
      • Output plots
    • Example 8 - optical spring
      • The optical configuration
      • The Finesse model
      • Output plots
    • Example 9 - quantum-noise limited sensitivity of Advanced LIGO
      • The optical configuration
      • The Finesse model
      • Output plots
  • Using Finesse
    • Building and interacting with models
      • KatScript
        • A quick example
        • Language fundamentals
        • Components and detectors
        • Commands and analyses
        • Ports and nodes
        • Paths
        • Expressions and references
        • Arrays
        • Generating KatScript from a model
      • Python API
    • Model elements
      • Components and detectors
        • Optics
        • Sources
        • Connectors
        • Detectors
        • Readouts
        • Control and filtering
      • Other elements
        • Variables
        • Gaussian beams
    • The port and node system
      • Basic usage of ports and nodes
        • Accessing ports
        • What does a port contain?
        • Accessing nodes — via a component
        • Accessing nodes — via the model
    • Commands
    • Actions, Analyses, and Solutions
      • Introduction
        • The ‘xaxis’ and ‘noxaxis’ action
        • Solutions
        • Analysis with multiple actions - ‘series’
        • Actions and model state changes
        • Analysis with multiple actions - ‘parallel’
        • Extracting model states from an analysis
        • Action events
        • Python API
      • Groups
      • Axes
      • Physics
      • Utilities
    • Modelling with higher-order modes
      • Selecting the modes to model
        • Maximum TEM order
        • Selection method
        • Assigning to modes property
        • Including additional modes
        • A note on specifying mode indices explicitly
      • Defining the modal basis
        • Using cavity objects
        • Defining manual beam parameters
      • Creating and detecting mode mismatches
        • Defining a figure of merit
        • Creating a custom mismatch
        • Detecting mode mismatches
        • Trace priority
      • Capturing beam images with camera objects
        • Detecting a single pixel
        • Capturing a full beam image
        • Producing animated beam images
      • Beam propagation
        • The ‘propagate_beam’ function
        • Symbolic beam propagation
      • Computing arbitrary scattering matrices
        • Calculating coupling matrices via the Bayer-Helms formalism
    • Linear time invariant system modelling
      • Modelling transfer functions
        • Operating points: Carrier and signals — DC and AC
        • Computing transfer functions - manual method
      • The ‘frequency_response’ action for modelling transfer functions
      • Closing control loops
        • DC control loops - ‘lock’
        • AC control loops
    • Finesse 2 support
      • Supported legacy syntax
        • Components
        • Detectors
        • Commands
        • Axes
      • Internal differences from Finesse 2
        • Modulator sideband amplitudes
    • Viewing logs
      • Making log messages visible
        • Option 1: use command line interface option
        • Option 2: call ‘finesse.config.configure’
        • Option 3: wrap your code in a ‘finesse.utilities.misc.logs’ context
        • Option 4: configure via the Python ‘logging’ module
      • Filtering log channels
    • Command line interface
      • Quick start
      • Getting help
      • Running KatScript files
      • Looking up KatScript syntax
      • Controlling verbosity
        • Showing or hiding log messages
        • Showing tracebacks
        • Fancy error messages
      • Keeping multiple plots open using job control
        • Bourne-compatible shells (e.g. ‘bash’)
        • Windows command prompt
      • Command reference
        • Shared options
        • kat3
        • kat3 info
        • kat3 syntax
        • kat3 convert
    • Numerical precision
      • In elements
      • In simulations
  • Physics of Finesse
    • Plane-wave optics
      • Mirror and beamsplitter
        • Mirror
        • Beam splitter
      • Modulation of light fields
        • Phase Modulation
        • Frequency modulation
        • Amplitude modulation
      • Input fields or the ‘right hand side’ vector
        • Carrier frequencies
        • Signal frequencies
        • TODO
    • Higher-order spatial modes
      • Transformation of the beam parameter
      • Cavity eigenmodes
      • Tracing the beam
        • Algorithm details
      • Coupling of higher-order-modes
        • Solving the overlap integral
        • Scattering matrices
        • API for coupling coefficient calculations
    • Radiation Pressure
      • Radiation Pressure at a Mirror
        • Surface motion to optical field coupling
        • Optical field to surface motion coupling
  • Developer guide
    • Getting started with Finesse development
      • Submitting a bug report
      • Contributing to the project
        • Setting up your fork
        • How to contribute
    • Guide to the Finesse source code
      • The Finesse Cython extensions
        • Structure
        • The ‘finesse.cymath’ extension
        • Optimising Cython code
        • Managing exceptions
        • Checking a Cython extension for CPython interaction
        • Documenting Cython extensions
        • Useful resources
      • The KatScript parser
        • Introduction
        • Grammar
        • The parsing toolchain
      • Adding and modifying dependencies
        • Adding a package to the requirements
        • Changing the pinned version of a requirement
        • Removing a required package
    • Packaging Finesse
      • Pip
      • Conda
    • Contributing to the documentation
      • Structure of the project
      • Comments and todo items
      • Writing Sphinx compatible docstrings
      • Linking to internal and external module objects
      • Documenting Cython extensions
      • Showing output from inline scripts
      • Style guide
        • Line length
        • Sections
        • Grammar
        • Capitalisation
        • Code examples
      • Building the documentation
      • Linting tools
    • Finesse code style
      • Specific notes
        • ‘__init__.py’ files
        • Absolute and relative imports
        • Indentation of multi-line quotes
        • Singletons
    • Testing
      • Running and writing tests
        • Pytest
        • Running the tests provided with Finesse
        • Types of test
        • Writing tests
      • Analytical test documentation
        • Plane-wave Radiation Pressure Effects
    • Debugging Finesse
      • Compile Cython extensions with debug symbols
      • Run the code using a debugger
  • API Documentation
    • finesse
      • finesse.analysis
        • finesse.analysis.actions
        • finesse.analysis.axes
        • finesse.analysis.beamtrace
        • finesse.analysis.noise
        • finesse.analysis.runners
      • finesse.cli
        • finesse.cli.config
        • finesse.cli.debug
        • finesse.cli.docs
        • finesse.cli.model
        • finesse.cli.script
        • finesse.cli.util
      • finesse.cmatrix
        • finesse.cmatrix.CCSMatrix
        • finesse.cmatrix.KLUMatrix
        • finesse.cmatrix.SubCCSMatrixView
        • finesse.cmatrix.SubCCSMatrixViewDiagonal
        • finesse.cmatrix.SubCCSView
        • finesse.cmatrix.SubCCSView1DArray
        • finesse.cmatrix.SubCCSView2DArray
      • finesse.components
        • finesse.components.beamsplitter
        • finesse.components.cavity
        • finesse.components.directional_beamsplitter
        • finesse.components.dof
        • finesse.components.electronics
        • finesse.components.gauss
        • finesse.components.general
        • finesse.components.isolator
        • finesse.components.laser
        • finesse.components.lens
        • finesse.components.ligo
        • finesse.components.mechanical
        • finesse.components.mirror
        • finesse.components.modal
        • finesse.components.modulator
        • finesse.components.node
        • finesse.components.nothing
        • finesse.components.optical_bandpass
        • finesse.components.readout
        • finesse.components.signal
        • finesse.components.space
        • finesse.components.squeezer
        • finesse.components.surface
        • finesse.components.trace_dependency
        • finesse.components.wire
        • finesse.components.workspace
      • finesse.config
        • finesse.config.ConfigNotFoundError
        • finesse.config.ExistingLogHandlerError
        • finesse.config.autoconfigure
        • finesse.config.config_instance
        • finesse.config.configure
        • finesse.config.log_handler_instance
      • finesse.constants
      • finesse.cyexpr
      • finesse.cymath
        • finesse.cymath.complex
        • finesse.cymath.gaussbeam
        • finesse.cymath.homs
        • finesse.cymath.math
      • finesse.datastore
        • finesse.datastore.has_singleton
        • finesse.datastore.init_singleton
        • finesse.datastore.invalidate
        • finesse.datastore.invalidate_singleton
      • finesse.densematrix
        • finesse.densematrix.DenseMatrix
      • finesse.detectors
        • finesse.detectors.amplitude_detector
        • finesse.detectors.astigmatism_detector
        • finesse.detectors.bpdetector
        • finesse.detectors.camera
        • finesse.detectors.cavity_detector
        • finesse.detectors.compute
        • finesse.detectors.general
        • finesse.detectors.gouy
        • finesse.detectors.knmdetector
        • finesse.detectors.mismatch_detector
        • finesse.detectors.motion_detector
        • finesse.detectors.powerdetector
        • finesse.detectors.quantum_noise_detector
        • finesse.detectors.workspace
      • finesse.element
        • finesse.element.BaseCValues
        • finesse.element.ElementValues
        • finesse.element.ElementWorkspace
        • finesse.element.ModelElement
      • finesse.enums
        • finesse.enums.SpatialType
      • finesse.environment
        • finesse.environment.has_pygraphviz
        • finesse.environment.is_interactive
        • finesse.environment.reset_traceback_handler
        • finesse.environment.show_tracebacks
        • finesse.environment.tb
        • finesse.environment.traceback_handler_instance
      • finesse.exceptions
        • finesse.exceptions.BeamTraceException
        • finesse.exceptions.ComponentNotConnected
        • finesse.exceptions.FinesseException
        • finesse.exceptions.ModelAttributeError
        • finesse.exceptions.ModelParameterDefaultValueError
        • finesse.exceptions.ModelParameterSelfReferenceError
        • finesse.exceptions.NodeException
        • finesse.exceptions.ParameterLocked
        • finesse.exceptions.TotalReflectionError
      • finesse.freeze
        • finesse.freeze.Freezable
        • finesse.freeze.canFreeze
      • finesse.frequency
        • finesse.frequency.Frequency
        • finesse.frequency.FrequencyContainer
        • finesse.frequency.Fsig
        • finesse.frequency.generate_frequency_list
      • finesse.gaussian
        • finesse.gaussian.BeamParam
        • finesse.gaussian.HGMode
        • finesse.gaussian.transform_beam_param
        • finesse.gaussian.ws_overlap
        • finesse.gaussian.ws_overlap_grid
      • finesse.knm
        • finesse.knm.bayerhelms
        • finesse.knm.matrix
        • finesse.knm.tools
      • finesse.ligo
        • finesse.ligo.DARM_RF_to_DC
        • finesse.ligo.DRFPMI_state
        • finesse.ligo.get_lock_error_signals
        • finesse.ligo.make_aligo
        • finesse.ligo.set_lock_gains
      • finesse.locks
        • finesse.locks.Lock
      • finesse.model
        • finesse.model.Event
        • finesse.model.IOMatrix
        • finesse.model.InputMatrix
        • finesse.model.Model
        • finesse.model.OutputMatrix
        • finesse.model.PhaseConfig
        • finesse.model.locked_when_built
      • finesse.parameter
        • finesse.parameter.GeometricParameter
        • finesse.parameter.Parameter
        • finesse.parameter.ParameterRef
        • finesse.parameter.parameterproperty
        • finesse.parameter.bool_parameter
        • finesse.parameter.enum_parameter
        • finesse.parameter.float_parameter
        • finesse.parameter.info_parameter
        • finesse.parameter.int_parameter
      • finesse.paths
        • finesse.paths.OpticalPath
      • finesse.plotting
        • finesse.plotting.graph
        • finesse.plotting.plot
        • finesse.plotting.style
        • finesse.plotting.tools
      • finesse.script
        • finesse.script.adapter
        • finesse.script.compiler
        • finesse.script.containers
        • finesse.script.exceptions
        • finesse.script.generator
        • finesse.script.graph
        • finesse.script.highlighter
        • finesse.script.legacy
        • finesse.script.memoize
        • finesse.script.parser
        • finesse.script.shell
        • finesse.script.spec
        • finesse.script.tokenizer
        • finesse.script.tokens
        • finesse.script.util
      • finesse.simulations
        • finesse.simulations.KLU
        • finesse.simulations.base
        • finesse.simulations.basematrix
        • finesse.simulations.debug
      • finesse.solutions
        • finesse.solutions.array
        • finesse.solutions.base
        • finesse.solutions.beamtrace
      • finesse.symbols
        • finesse.symbols.Constant
        • finesse.symbols.Operation
        • finesse.symbols.Resolving
        • finesse.symbols.Symbol
        • finesse.symbols.Variable
        • finesse.symbols.as_symbol
        • finesse.symbols.display
        • finesse.symbols.evaluate
        • finesse.symbols.finesse2sympy
        • finesse.symbols.sympy2finesse
      • finesse.tracing
        • finesse.tracing.ctracer
        • finesse.tracing.cytools
        • finesse.tracing.tools
      • finesse.tree
        • finesse.tree.TreeNode
      • finesse.utilities
        • finesse.utilities.blockdiag
        • finesse.utilities.components
        • finesse.utilities.cyomp
        • finesse.utilities.homs
        • finesse.utilities.misc
        • finesse.utilities.text
        • finesse.utilities.units
  • Appendix
    • About us
    • Impact
    • History
    • Todo List
    • Bibliography
  • Glossary
  • Index
Finesse 3.0
  • »
  • API Documentation »
  • finesse »
  • finesse.cli

finesse.cli¶

Sub-modules

finesse.cli.config

Configuration information.

finesse.cli.debug

finesse.cli.docs

finesse.cli.model

finesse.cli.script

finesse.cli.util

Previous Next

© Copyright 1999 to 2021 by The Finesse team. Last updated on Nov 07, 2021.

Built with Sphinx using a theme provided by Read the Docs.