Modules ======= OSCARS consists of several modules. The functions of each are found below. The sr and th modules are responsible for the vast majority of the computations. The th module is largely a set of calculations from theory whereas the sr module handles arbitrary field and beam conditions. The other modules are for plotting and simulating parametric surfaces. The OSCARS modules are: * :ref:`oscars.sr` * :ref:`oscars.th` * :ref:`oscars.util` * :ref:`oscars.plots_mpl` * :ref:`oscars.plots3d_mpl` * :ref:`oscars.parametric_surfaces` .. _oscars.sr: oscars.sr --------- **Primer for the Examples** All examples here assume that you have the OSCARS SR and TH modules in your path and have an OSCARS SR (TH) object called osr (oth), perhaps as in the following example .. code-block:: py # Import the OSCARS SR module import oscars.sr # Creat an OSCARS SR object osr = oscars.sr.sr() .. automodule:: oscars.sr :members: :noindex: .. _oscars.th: oscars.th --------- .. automodule:: oscars.th :members: :noindex: .. _oscars.util: oscars.util ---------------- .. automodule:: oscars.util :members: .. _oscars.plots_mpl: oscars.plots_mpl ---------------- .. automodule:: oscars.plots_mpl :members: .. _oscars.plots3d_mpl: oscars.plots3d_mpl ------------------ .. automodule:: oscars.plots3d_mpl :members: .. _oscars.parametric_surfaces: oscars.parametric_surfaces -------------------------- .. automodule:: oscars.parametric_surfaces :members: