Examples
=========

You can use the examples below to get started with PyLumerical and learn its basic functionalities.

For in-depth discussion of PyLumerical concepts, see the :doc:`User guide <user_guide/index>`.

.. grid:: 2 2 3 3

   .. grid-item-card:: Session management

      This example demonstrates how to initialize a local Lumerical session using PyLumerical.

      Download the example :examples_url:`here <Sessions_and_Objects/basic_session_management.py>`.

   .. grid-item-card:: Basic FDTD simulation - Lumerical style commands

      This example demonstrates how to set up a basic FDTD simulation with a Gaussian source and frequency-domain monitor.
      The example uses PyLumerical with workflows and syntax similar to the Lumerical Scripting Language.

      Download the example :examples_url:`here <Sessions_and_Objects/fdtd_example1_lsf.py>`.

   .. grid-item-card:: Basic FDTD simulation - Python style commands

      This example demonstrates how to set up a basic FDTD simulation with a Gaussian source and frequency-domain monitor.
      This example uses PyLumerical with workflows and syntax that is more native to Python.

      Download the example :examples_url:`here <Sessions_and_Objects/fdtd_example1_pythonic.py>`.