:orphan:

Example galery
==============

Below is a gallery of examples for using this package



.. raw:: html

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

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Output parsing and plotting
---------------------------

Examples using the output parsing and plotting functionality



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Print a full report of a roxie run">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_full_report_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_full_report.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot a Full run report</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the output of a roxie 2d Plot and plot it with matplotlib">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_2d_crosssection_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_2d_crosssection.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">2D Crosssection plots</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the output of a harmonic coil and show the Field quality">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_2d_forces_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_2d_forces.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">2D Forces plots</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the output of a harmonic coil and show the Field quality">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_field_quality_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_field_quality.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Field quality plots</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Plot the 3D geometry of wedges and end-spacers">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_wedges_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_wedges.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting of 3D wedges</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the Output parser to extract conductor coordinates and forces">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_extract_conductor_coordinates_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_extract_conductor_coordinates.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Extract Conductor Coordinates</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Plot the 3D geometry of wedges and end-spacers">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_objectives_dv_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_objectives_dv.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Show Objectives and Design variables</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Plot the 3D geometry and results">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_3d_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_3d.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">3D plots</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the output of roxie defined graphs and plot them using plotly">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_graphs_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_graphs.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Create a custom 3D plot from custom data sets (Plot not defined in Roxie)">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_3d_custom_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_3d_custom.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Custom 3D plots</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Create a new 2D plot based on output data.">

.. only:: html

  .. image:: /gen/examples/output_parsing/images/thumb/sphx_glr_plot_2d_plot_custom_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_output_parsing_plot_2d_plot_custom.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Custom plots in 2D</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /gen/examples/output_parsing/plot_full_report
   /gen/examples/output_parsing/plot_2d_crosssection
   /gen/examples/output_parsing/plot_2d_forces
   /gen/examples/output_parsing/plot_field_quality
   /gen/examples/output_parsing/plot_wedges
   /gen/examples/output_parsing/plot_extract_conductor_coordinates
   /gen/examples/output_parsing/plot_objectives_dv
   /gen/examples/output_parsing/plot_3d
   /gen/examples/output_parsing/plot_graphs
   /gen/examples/output_parsing/plot_3d_custom
   /gen/examples/output_parsing/plot_2d_plot_custom

Roxie execution
---------------

Examples running roxie, and modifying input files



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This snippet loads a datafile and modifies its contents">

.. only:: html

  .. image:: /gen/examples/running_roxie/images/thumb/sphx_glr_manipulate_datafiles_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_running_roxie_manipulate_datafiles.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This snippet runs roxie on the local computer via terminal adapter">

.. only:: html

  .. image:: /gen/examples/running_roxie/images/thumb/sphx_glr_run_roxie_terminal_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_running_roxie_run_roxie_terminal.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Run roxie from a terminal</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This snippet runs roxie from a running roxie-webservice. This requires roxie running from a docker-container with Rest Services activated (see [Roxie docker documentation](https://roxie.docs.cern.ch/run_roxie/roxie_docker.html)) or manually started using the roxie-rest-api package.">

.. only:: html

  .. image:: /gen/examples/running_roxie/images/thumb/sphx_glr_run_roxie_service_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_running_roxie_run_roxie_service.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Run Roxie as a service</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This snippet calls executes roxie, overwriting input files set in the datafile with local files">

.. only:: html

  .. image:: /gen/examples/running_roxie/images/thumb/sphx_glr_input_file_handling_thumb.png
    :alt:

  :ref:`sphx_glr_gen_examples_running_roxie_input_file_handling.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Update Input files before execution</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /gen/examples/running_roxie/manipulate_datafiles
   /gen/examples/running_roxie/run_roxie_terminal
   /gen/examples/running_roxie/run_roxie_service
   /gen/examples/running_roxie/input_file_handling



.. only:: html

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

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