Developer guide

• Getting started with Finesse development
  • Submitting a bug report
  • Contributing to development
    • Installing git
    • Setting up your fork
    • Setting up the Finesse development environment
    • Rebuilding extensions
• 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
  • KatScript grammar, parser and generator
    • Grammar
    • Parsing
    • Unparsing
  • Requirements for building, running and developing Finesse
    • Python package requirements for Finesse
• Finesse internal code structure
  • Interferometer Matrix Equation
    • Solution Vector
    • Right hand side vector
    • Interferometer Matrix
  • Simulation
  • Solver
  • ModelElement
  • Detector
  • Port
  • Node
  • Parameters
  • Workspace
  • Model
  • Signal Matrix
• Developer tools
  • Tool configuration
• Packaging Finesse
  • Conda
  • Wheels
    • Building for ‘manylinux’
    • Building for Mac OSX
• Releasing finesse
  • PyPi
  • Conda-forge
    • Automatic releases
    • Manual releases
    • Patches
    • Updating requirements
    • Chat channel
• Contributing to the documentation
  • How to build the documentation
  • Supported formats
  • Directory organization
  • Updating the Changelog
  • Comments and todo items
  • Writing Sphinx compatible docstrings
  • Documenting Cython extensions
  • Style guide
    • Grammar
    • Capitalisation
  • Linting tools
  • Authoring documentation
    • reStructuredText (reST)
    • Markedly Structured Text (MyST)
    • Special formatting of the word Finesse
    • What to add at the top of a page
    • References and links
    • Linking to internal and external objects
    • Showing output from inline scripts
    • Code examples
• How to add a notebook to the documentation
  • Before starting, some info
  • Step 0: Discuss your plan
  • Step 1. Write your notebook
  • Step 2. Create your git branch from an up-to-date development branch
  • Step 3. Add your notebook to the documentation
  • Step 4. Create a merge request
  • Step 5. Your merge request is reviewed
  • Step 6. Your page is accepted and merged
  • Annexe: Quick MyST reference
    • Headers
    • Labels and references
    • Citations
    • Horizontal lines
    • Links
    • Tables
    • Figures and images
    • Mathematical equations
    • Executing code
    • Admonitions
    • Code
    • Lists
    • Footnotes
• Contributing to the editor extensions
  • JupyterLab
    • pip
    • npm
  • Visual Studio Code
    • Visual Studio Marketplace
    • Open VSX
  • Vim
  • Pygments
• 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
  • Test suite guide
    • Plane-wave radiation pressure effects tests
• Todo List
• Continuous integration
  • Configuring the pipeline
  • Pushing code without triggering the pipeline
  • Wheels built by the pipeline
    • Mac OSX on AMD64
• Debugging Finesse