.. toctree::
    :hidden:
    :maxdepth: 3

    gallery_examples/api/index.rst
    gallery_examples/evaluate_design/index.rst
    gallery_examples/osl_server/index.rst
    gallery_examples/parametric_design_study_manager/index.rst
    gallery_examples/run_python_script/index.rst
    gallery_examples/workflow_creation/index.rst

.. _ref_examples:

Examples
========
End-to-end examples show how you can use PyOptiSLang. If PyOptiSLang is installed
on your machine, you can download these examples as Python files or Jupyter
notebooks and run them locally.

.. grid:: 2 2 3 3
    :gutter: 1 2 3 3
    :padding: 1 2 3 3

    .. grid-item-card:: API usage examples
        :link: sphx_glr_examples_gallery_examples_api
        :link-type: ref

        .. image:: ../_static/banner_api.png
            :height: 150px
            :align: center

        These examples demonstrate how to use the explicit API to communicate with optiSLang.

    .. grid-item-card:: Evaluate designs
        :link: sphx_glr_examples_gallery_examples_evaluate_design
        :link-type: ref

        .. image:: ../_static/01_ten_bar_truss_evaluate_design.png
            :height: 150px
            :align: center

        These examples demonstrate how to evaluate designs.

    .. grid-item-card:: Raw optiSLang server communication
        :link: sphx_glr_examples_gallery_examples_osl_server
        :link-type: ref

        .. image:: ../_static/banner_osl_server.png
            :height: 150px
            :align: center

        These examples demonstrate how to use PyOptiSLang to perform raw communication with the optiSLang server.

    .. grid-item-card:: Parametric Design Study Manager
        :link: sphx_glr_examples_gallery_examples_parametric_design_study_manager
        :link-type: ref

        .. image:: ../_static/03_1_ProxySolverSensitivity.png
            :height: 150px
            :align: center

        These examples demonstrate how to create and execute design studies using templates.


    .. grid-item-card:: Run Python scripts
        :link: sphx_glr_examples_gallery_examples_run_python_script
        :link-type: ref

        .. image:: ../_static/banner_python_scripts.png
            :height: 150px
            :align: center

        These examples demonstrate how to run Python scripts.

    .. grid-item-card:: Create workflow
        :link: sphx_glr_examples_gallery_examples_workflow_creation
        :link-type: ref

        .. image:: ../_static/04_1_RDO_w_python.png
            :height: 150px
            :align: center

        These examples demonstrate how to create workflow using pyOptiSLang.