_images/logo.svg

Quick links: Installation | Source Repository | Issue Tracker | PyPI

Cavcalc is an open-source tool for computing parameters associated with Fabry-Perot optical cavities. Both a CLI and Python API are provided for interacting with cavcalc. The CLI represents a convenient way of quickly calculating / plotting cavity properties, whilst the API can be used more broadly in a cavity / interferometer design and analysis workflow — e.g. alongside other programs such as Finesse 3.

card-img-top

User Guide

The user guide is the best place to begin learning how to use cavcalc. It contains an installation guide, tutorials, and examples.

card-img-top

API Documentation

The API reference contains detailed descriptions of the modules, objects, and functions included in cavcalc.

card-img-top

Contributor’s Guide

Follow these general guides for reporting bugs, and more broadly contributing to cavcalc.