:orphan:



.. _sphx_glr_auto_examples:

.. _usage-examples:

Usage examples
==============

Exemplary propagation scenarios obtained using `py-fmas`.  Click on any image
to see more details and source code.

For more detailed tutorials, see our :ref:`extended-user-guide` page.


.. raw:: html

    <div class="sphx-glr-clear"></div>



.. _sphx_glr_auto_examples_gallery_01:

Exemplary propagation scenarios
-------------------------------

This gallery shows examples demonstrating the dynamical evolution of ultrashort
optical pulses in terms of :math:`z`-propagation models for the analytic
signal.



.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples demonstrates the z-propagation of a specialized propagation model for a specific ...">

.. only:: html

 .. figure:: /auto_examples/gallery_01/images/thumb/sphx_glr_g_specialized_model_PCF_thumb.png
     :alt: Supercontinuum generation in a PCF

     :ref:`sphx_glr_auto_examples_gallery_01_g_specialized_model_PCF.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_01/g_specialized_model_PCF

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples demonstrates breakdown of a high-order soliton in a NL-PM-750 photonic crystal fi...">

.. only:: html

 .. figure:: /auto_examples/gallery_01/images/thumb/sphx_glr_g_soliton_implosion_thumb.png
     :alt: Soliton implosion in a NLPM750 PCF

     :ref:`sphx_glr_auto_examples_gallery_01_g_soliton_implosion.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_01/g_soliton_implosion

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples shows how to use the py-fmas library code in conjunction with the optFrog spectro...">

.. only:: html

 .. figure:: /auto_examples/gallery_01/images/thumb/sphx_glr_g_optfrog_thumb.png
     :alt: Extending `py-fmas` by `optfrog` spectrograms

     :ref:`sphx_glr_auto_examples_gallery_01_g_optfrog.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_01/g_optfrog

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples demonstrates the interaction between a fundamental soliton and a dispersive wave ...">

.. only:: html

 .. figure:: /auto_examples/gallery_01/images/thumb/sphx_glr_g_specialized_model_NLPM_thumb.png
     :alt: Two pulse interaction in a NLPM750 PCF

     :ref:`sphx_glr_auto_examples_gallery_01_g_specialized_model_NLPM.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_01/g_specialized_model_NLPM

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples demonstrates the interaction between a fundamental soliton and a three dispersive...">

.. only:: html

 .. figure:: /auto_examples/gallery_01/images/thumb/sphx_glr_g_four_pulse_interaction_ESM_thumb.png
     :alt: Four pulse interaction in a ESM PCF

     :ref:`sphx_glr_auto_examples_gallery_01_g_four_pulse_interaction_ESM.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_01/g_four_pulse_interaction_ESM
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. _sphx_glr_auto_examples_gallery_02:

Two-frequency pulse compounds 
-----------------------------

This gallery shows specific examples demonstrating the generation and dynamical
evolution of two-frequency pulse compounds.




.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples demonstrates the generation of two-frequency soliton molecules, using the forward...">

.. only:: html

 .. figure:: /auto_examples/gallery_02/images/thumb/sphx_glr_g_molecules_01_thumb.png
     :alt: Superimposed fundamental solitons

     :ref:`sphx_glr_auto_examples_gallery_02_g_molecules_01.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_02/g_molecules_01

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples demonstrates the generation of two-frequency soliton molecules, using the forward...">

.. only:: html

 .. figure:: /auto_examples/gallery_02/images/thumb/sphx_glr_g_molecules_02_thumb.png
     :alt: Soliton-soliton collision

     :ref:`sphx_glr_auto_examples_gallery_02_g_molecules_02.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_02/g_molecules_02
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. _sphx_glr_auto_examples_gallery_03:

Simulation of other models 
--------------------------

This gallery shows how the functionality of the provided software can be
extended by implementing additional propagation models.




.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples demonstrates backscattered optical field components using the bidirectional model...">

.. only:: html

 .. figure:: /auto_examples/gallery_03/images/thumb/sphx_glr_g_BMCF_thumb.png
     :alt: BMCF -- Backscattered optical field components

     :ref:`sphx_glr_auto_examples_gallery_03_g_BMCF.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_03/g_BMCF

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example solves the standard nonlinear Schrödinger equation, given by">

.. only:: html

 .. figure:: /auto_examples/gallery_03/images/thumb/sphx_glr_g_model_NSE_thumb.png
     :alt: Nonlinear Schrödinger equation -- Third-order soliton

     :ref:`sphx_glr_auto_examples_gallery_03_g_model_NSE.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_03/g_model_NSE

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example solves the Korteweg-deVries (KdV) equation, given by">

.. only:: html

 .. figure:: /auto_examples/gallery_03/images/thumb/sphx_glr_g_model_KdV_thumb.png
     :alt: Korteweg-deVries equation -- Interaction of solitons

     :ref:`sphx_glr_auto_examples_gallery_03_g_model_KdV.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_03/g_model_KdV

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to perform simulations for the Lugiato-Lefever equation (LLE) [1], using...">

.. only:: html

 .. figure:: /auto_examples/gallery_03/images/thumb/sphx_glr_g_model_LLE_thumb.png
     :alt: Lugiato-Lefever equation -- Soliton molecules

     :ref:`sphx_glr_auto_examples_gallery_03_g_model_LLE.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gallery_03/g_model_LLE
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. only :: html

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


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

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



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

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


.. only:: html

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

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