.. _lbl-examples:

********
Examples
********

The examples in this section can be accessed from the application by selecting Examples in the Main Menu. They demonstrate the range of workflows that can be executed with the application and serve as ready-to-use **prototypes** that may be modified to create custom workflows. Each example is designed to run quickly, with the primary goal of demonstrating how workflows can be assembled. To achieve this, certain settings—such as the number of samples, the finite element model, and the number of assets—have been intentionally kept small and simplified.

.. only:: R2D_app

    The files for the examples are available on `GitHub <https://github.com/NHERI-SimCenter/R2DExamples>`_. The examples can also be downloaded and installed within the tool by going to the menu **Examples -> Manage Examples** and by checking the boxes of the examples that are desired. 

.. only:: quoFEM_app

   The files for the examples are available in the `quoFEM GitHub repository <https://github.com/NHERI-SimCenter/quoFEM/tree/master/Examples>`_.	  

.. only:: EEUQ_app

   The files for the examples are available in the `EE-UQ GitHub repository <https://github.com/NHERI-SimCenter/EE-UQ/tree/master/Examples>`_.


.. only:: WEUQ_app

   The files for the examples are available in the `WE-UQ GitHub repository <https://github.com/NHERI-SimCenter/WE-UQ/tree/master/Examples>`_.


 .. only:: HydroUQ_app

   The files for the examples are available in the `HydroUQ GitHub repository <https://github.com/NHERI-SimCenter/HydroUQ/tree/master/Examples>`_.
   
.. only:: PBE_app

   The following are a few examples showing the usage of PBE. The files for the examples are available on GitHub. The scope of these examples is limited to damage and loss assessment. The usage of the tool for response estimation is identical to that of the EE-UQ application. Examples of those features are available in the `EE-UQ Documentation <https://nheri-simcenter.github.io/EE-UQ-Documentation/common/user_manual/examples/desktop/examples.html>`_.

   All examples come with input files that are available in the `PBE GitHub repository <https://github.com/NHERI-SimCenter/PBE/tree/master/Examples>`_.	  

.. only:: PBE1_app

   The following examples demonstrate the usage of the PBE application. The scope of these examples is limited to damage and loss assessment. The usage of the tool for response estimation is identical to that of the EE-UQ application. Examples of those features are available in the `EE-UQ Documentation <https://nheri-simcenter.github.io/EE-UQ-Documentation/common/user_manual/examples/desktop/examples.html>`_.

   All examples come with input files that are available in the `PBE GitHub repository <https://github.com/NHERI-SimCenter/PBE/tree/master/Examples>`_.


.. rendre:: filtered-gallery
   :data-file: $SIMCENTER_DEV/SimCenterDocumentation/build/${SIMDOC_APP}_Examples.json	    
   :load-defaults: $SIMCENTER_DEV//SimCenterDocumentation//examples.yaml#/$SIMDOC_APP

   :link: ./%%:base/README


..
   :data-file: $SIMCENTER_DEV/$SIMDOC_APP/Examples/index.json