:orphan:

.. _examples-index:





========
Examples
========




Typical examples of application of the package are presented here. 
You can run them live in your browser on `mybinder.org <https://mybinder.org/v2/gl/nannos%2Fnannos.gitlab.io/doc?filepath=notebooks>`_.


.. only:: html

  .. include:: ../_assets/binder_badge.rst
  
  

  .. raw:: html

   <p>
   </p>

An example on how to use various backends and GPU acceleration 
can be run on Google colab


.. only:: html

  .. image:: https://img.shields.io/badge/open%20in-colab-blue?color=d7a44c&logo=GoogleColab&logoColor=d7a44c&style=for-the-badge   
    :target: https://colab.research.google.com/gist/benvial/5d87e109a9a31904e67e62c77db79a03/nannos.ipynb
    :alt: colab


  .. raw:: html

   <p>
   </p>
   



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Basic examples
==============

Getting started.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Simulation of conversion efficiency of a geometric metasurface.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_conversion_eff_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_conversion_eff.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Polarization conversion</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tangent field">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_tangent_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_tangent.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tangent field</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Convergence.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_1d_grating_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_1d_grating.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">One dimensional grating</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Mechanically tunable photonic crystal structure consisting of coupled photonic crystal slabs.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_double_phc_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_double_phc.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Two photonic crystal slabs</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Convergence checks.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_ellipse_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_ellipse.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Elliptical holes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Metasurface with holes.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_hole_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_hole.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Photonic crystal slab</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Transmission spectrum.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_square_patch_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_square_patch.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Dielectric patch array</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Optical forces on bulk and thin layers of dielectric and metal.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_stress_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_stress.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Stress tensor</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Convergence of the various FMM formulations.">

.. only:: html

  .. image:: /examples/basic/images/thumb/sphx_glr_plot_convergence_thumb.png
    :alt:

  :ref:`sphx_glr_examples_basic_plot_convergence.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convergence</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Benchmarks
=============

Comparing the performances of computational backends using CPU and GPU.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Numerical backends performace comparison, with GPU acceleration, as run on Modal (https://modal.com)">

.. only:: html

  .. image:: /examples/benchmarks/images/thumb/sphx_glr_plot_modal_thumb.png
    :alt:

  :ref:`sphx_glr_examples_benchmarks_plot_modal.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Benchmark Modal</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Numerical backends performace comparison, with GPU acceleration, as run on Kaggle (https://www.kaggle.com/code/benjaminvial/nannos-cpu)">

.. only:: html

  .. image:: /examples/benchmarks/images/thumb/sphx_glr_plot_kaggle_thumb.png
    :alt:

  :ref:`sphx_glr_examples_benchmarks_plot_kaggle.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Benchmark</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Numerical backends performace comparison.">

.. only:: html

  .. image:: /examples/benchmarks/images/thumb/sphx_glr_plot_benchmarks_thumb.png
    :alt:

  :ref:`sphx_glr_examples_benchmarks_plot_benchmarks.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Backends comparison</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /examples/basic/index.rst
   /examples/benchmarks/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: examples_python.zip </examples/examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: examples_jupyter.zip </examples/examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_