:orphan:

.. _examples-index:

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

Below is a gallery of examples for different operations in diffsims.



.. raw:: html

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

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Creating a Simulation Library
=============================

These examples show specific workflows for creating a library of simulations.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to simulate diffraction patterns using the diffsims.generators.simulation_generator.SimulationGenerator class. A single diffraction pattern can be simulated for a single phase or multiple diffraction patterns can be simulated for a single/multiple phases given a rotation.">

.. only:: html

  .. image:: /examples/creating_a_simulation_library/images/thumb/sphx_glr_simulating_diffraction_patterns_thumb.png
    :alt:

  :ref:`sphx_glr_examples_creating_a_simulation_library_simulating_diffraction_patterns.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Simple Diffraction Pattern Simulation Examples</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Here you can see how to make an equivalent to a diffraction library">

.. only:: html

  .. image:: /examples/creating_a_simulation_library/images/thumb/sphx_glr_migration_guide_thumb.png
    :alt:

  :ref:`sphx_glr_examples_creating_a_simulation_library_migration_guide.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">0.5.x --> 0.6.x Migration Guide</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /examples/creating_a_simulation_library/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>`_