Commit e727a77a authored by Sean Leavey's avatar Sean Leavey
Browse files

Merge branch 'feature/self-referencing-parameters' into fix/dependency-graph-parsing

parents a1c1acb8 d6952c89
......@@ -8,6 +8,28 @@
.. autoclass:: Beamsplitter
.. rubric:: Properties
.. autosummary::
:toctree: generated/
Beamsplitter.abcd12x
Beamsplitter.abcd12y
Beamsplitter.abcd21x
Beamsplitter.abcd21y
Beamsplitter.abcd34x
Beamsplitter.abcd34y
Beamsplitter.abcd43x
Beamsplitter.abcd43y
Beamsplitter.abcd13x
Beamsplitter.abcd13y
Beamsplitter.abcd31x
Beamsplitter.abcd31y
Beamsplitter.abcd24x
Beamsplitter.abcd24y
Beamsplitter.abcd42x
Beamsplitter.abcd42y
.. rubric:: Methods
.. autosummary::
......
......@@ -16,3 +16,4 @@
finesse.components.modal.modulator
finesse.components.modal.signal
finesse.components.modal.space
finesse.components.modal.variable
......@@ -28,4 +28,5 @@
Connector.__init__
Connector.coupling_type
Connector.interaction_type
Connector.check_coupling
Connector.ABCD
......@@ -8,6 +8,14 @@
.. autoclass:: Lens
.. rubric:: Properties
.. autosummary::
:toctree: generated/
Lens.abcdx
Lens.abcdy
.. rubric:: Methods
.. autosummary::
......
......@@ -8,6 +8,20 @@
.. autoclass:: Mirror
.. rubric:: Properties
.. autosummary::
:toctree: generated/
Mirror.abcd11x
Mirror.abcd11y
Mirror.abcd22x
Mirror.abcd22y
Mirror.abcd12x
Mirror.abcd12y
Mirror.abcd21x
Mirror.abcd21y
.. rubric:: Methods
.. autosummary::
......
......@@ -7,3 +7,12 @@
.. rubric:: Overview
.. autoclass:: BeamsplitterWorkspace
.. rubric:: Methods
.. autosummary::
:toctree: generated/
BeamsplitterWorkspace.__init__
BeamsplitterWorkspace.compile_abcd_cy_exprs
BeamsplitterWorkspace.update_parameter_values
=====================================
``finesse.components.modal.variable``
=====================================
.. automodule:: finesse.components.modal.variable
.. currentmodule:: finesse.components.modal.variable
.. rubric:: Classes
.. autosummary::
:toctree: variable/
VariableValues
VariableWorkspace
......@@ -7,3 +7,12 @@
.. rubric:: Overview
.. autoclass:: LensWorkspace
.. rubric:: Methods
.. autosummary::
:toctree: generated/
LensWorkspace.__init__
LensWorkspace.compile_abcd_cy_exprs
LensWorkspace.update_parameter_values
......@@ -7,3 +7,12 @@
.. rubric:: Overview
.. autoclass:: MirrorWorkspace
.. rubric:: Methods
.. autosummary::
:toctree: generated/
MirrorWorkspace.__init__
MirrorWorkspace.compile_abcd_cy_exprs
MirrorWorkspace.update_parameter_values
......@@ -7,3 +7,12 @@
.. rubric:: Overview
.. autoclass:: SpaceWorkspace
.. rubric:: Methods
.. autosummary::
:toctree: generated/
SpaceWorkspace.__init__
SpaceWorkspace.compile_abcd_cy_exprs
SpaceWorkspace.update_parameter_values
====================================================
``finesse.components.modal.variable.VariableValues``
====================================================
.. currentmodule:: finesse.components.modal.variable
.. rubric:: Overview
.. autoclass:: VariableValues
=======================================================
``finesse.components.modal.variable.VariableWorkspace``
=======================================================
.. currentmodule:: finesse.components.modal.variable
.. rubric:: Overview
.. autoclass:: VariableWorkspace
......@@ -7,3 +7,10 @@
.. rubric:: Overview
.. autoclass:: Photodiode
.. rubric:: Properties
.. autosummary::
:toctree: generated/
Photodiode.optical_node
......@@ -15,6 +15,7 @@
Space.portA
Space.portB
Space.abcd
.. rubric:: Methods
......
......@@ -16,3 +16,4 @@
ConnectorWorkspace.__init__
ConnectorWorkspace.set_fill_fn
ConnectorWorkspace.set_fill_rhs_fn
ConnectorWorkspace.compile_abcd_cy_exprs
======================================
``finesse.config.ConfigNotFoundError``
======================================
.. currentmodule:: finesse.config
.. rubric:: Overview
.. autoclass:: ConfigNotFoundError
================================
``finesse.config.FinesseConfig``
================================
.. currentmodule:: finesse.config
.. rubric:: Overview
.. autoclass:: FinesseConfig
.. rubric:: Methods
.. autosummary::
:toctree: generated/
FinesseConfig.__init__
FinesseConfig.user_config_paths
FinesseConfig.user_config_path
FinesseConfig.cwd_config_path
FinesseConfig.user_config_dir
FinesseConfig.write_user_config
========================================================
``finesse.detectors.compute.camera.FieldPixelWorkspace``
``finesse.detectors.compute.camera.ComplexCameraValues``
========================================================
.. currentmodule:: finesse.detectors.compute.camera
.. rubric:: Overview
.. autoclass:: FieldPixelWorkspace
.. autoclass:: ComplexCameraValues
===========================================================
``finesse.detectors.compute.camera.ComplexCameraWorkspace``
===========================================================
.. currentmodule:: finesse.detectors.compute.camera
.. rubric:: Overview
.. autoclass:: ComplexCameraWorkspace
......@@ -14,6 +14,7 @@
CameraWorkspace
CCDWorkspace
CCDLineWorkspace
ComplexCameraValues
ComplexCameraWorkspace
FieldCameraWorkspace
FieldLineWorkspace
FieldPixelWorkspace
......@@ -14,3 +14,4 @@
BPDetectorWorkspace
CPDetectorWorkspace
AstigmatismDetectorWorkspace
GouyDetectorWorkspace
============================================================
``finesse.detectors.compute.gaussian.GouyDetectorWorkspace``
============================================================
.. currentmodule:: finesse.detectors.compute.gaussian
.. rubric:: Overview
.. autoclass:: GouyDetectorWorkspace
......@@ -11,5 +11,4 @@
.. autosummary::
:toctree: gouy/
GouyWorkspace
Gouy
......@@ -14,3 +14,4 @@
:toctree: generated/
Gouy.needs_fields
Gouy.spaces
========================================
``finesse.detectors.gouy.GouyWorkspace``
========================================
.. currentmodule:: finesse.detectors.gouy
.. rubric:: Overview
.. autoclass:: GouyWorkspace
......@@ -14,4 +14,5 @@
:toctree: generated/
ElementWorkspace.__init__
ElementWorkspace.compile_cy_exprs
ElementWorkspace.update_parameter_values
=======================================
``finesse.exceptions.TracebackHandler``
=======================================
========================================
``finesse.environment.TracebackHandler``
========================================
.. currentmodule:: finesse.exceptions
.. currentmodule:: finesse.environment
.. rubric:: Overview
......
==================
``finesse.config``
==================
.. automodule:: finesse.config
.. currentmodule:: finesse.config
.. rubric:: Classes
.. autosummary::
:toctree: config/
FinesseConfig
ConfigNotFoundError
.. rubric:: Functions
.. autosummary::
:toctree: generated/
configure
==================
``finesse.cyexpr``
==================
.. automodule:: finesse.cyexpr
......@@ -11,24 +11,7 @@
.. autosummary::
:toctree: element/
Symbol
Constant
Operation
ParameterRef
Parameter
GeometricParameter
ModelElement
ElementValues
BaseCValues
ElementWorkspace
.. rubric:: Functions
.. autosummary::
:toctree: generated/
display
evaluate
as_symbol
model_parameter
info_parameter
=======================
``finesse.environment``
=======================
.. automodule:: finesse.environment
.. currentmodule:: finesse.environment
.. rubric:: Classes
.. autosummary::
:toctree: environment/
TracebackHandler
.. rubric:: Functions
.. autosummary::
:toctree: generated/
is_interactive
show_tracebacks
tb
......@@ -18,4 +18,3 @@
BeamTraceException
TotalReflectionError
KatParserError
TracebackHandler
=====================
``finesse.parameter``
=====================
.. automodule:: finesse.parameter
.. currentmodule:: finesse.parameter
.. rubric:: Classes
.. autosummary::
:toctree: parameter/
ParameterRef
Parameter
GeometricParameter
.. rubric:: Functions
.. autosummary::
:toctree: generated/
model_parameter
info_parameter
.. include:: /defs.hrst
===========
``finesse``
===========
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 :ref:`manual`.
For learning how to get started with using |Finesse|, see also :ref:`getting_started`.
.. automodule:: finesse
.. autosummary::
:toctree: .
......@@ -15,12 +10,15 @@ For learning how to get started with using |Finesse|, see also :ref:`getting_sta
finesse.analysis
finesse.cmatrix
finesse.components
finesse.config
finesse.constants
finesse.cyexpr
finesse.cymath
finesse.densematrix
finesse.detectors
finesse.element
finesse.enums
finesse.environment
finesse.exceptions
finesse.freeze
finesse.frequency
......@@ -28,11 +26,13 @@ For learning how to get started with using |Finesse|, see also :ref:`getting_sta
finesse.knm
finesse.locks
finesse.model
finesse.parameter
finesse.paths
finesse.plotting
finesse.script
finesse.simulations
finesse.solutions
finesse.symbols
finesse.tracing
finesse.tree
finesse.utilities
===================
``finesse.symbols``
===================
.. automodule:: finesse.symbols
.. currentmodule:: finesse.symbols
.. rubric:: Classes
.. autosummary::
:toctree: symbols/
Symbol
Constant
Operation
.. rubric:: Functions
.. autosummary::
:toctree: generated/
as_symbol
display
evaluate
.. include:: /defs.hrst
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 :ref:`manual`.
For learning how to get started with using |Finesse|, see also :ref:`getting_started`.
.. autosummary::
:toctree: .
finesse
......@@ -78,6 +78,7 @@
Model.chain
Model.link
Model.connect
Model.get_network
Model.plot_graph
Model.get_changing_edges_elements
Model.unbuild
......
======================================
``finesse.element.GeometricParameter``
======================================
========================================
``finesse.parameter.GeometricParameter``
========================================
.. currentmodule:: finesse.element
.. currentmodule:: finesse.parameter
.. rubric:: Overview
......
=============================
``finesse.element.Parameter``
=============================
===============================
``finesse.parameter.Parameter``
===============================
.. currentmodule:: finesse.element
.. currentmodule:: finesse.parameter
.. rubric:: Overview
......
================================
``finesse.element.ParameterRef``
================================
==================================
``finesse.parameter.ParameterRef``
==================================
.. currentmodule:: finesse.element
.. currentmodule:: finesse.parameter
.. rubric:: Overview
......
============================
``finesse.element.Constant``
``finesse.symbols.Constant``
============================
.. currentmodule:: finesse.element
.. currentmodule:: finesse.symbols
.. rubric:: Overview