.. toctree::
    :hidden:
    :maxdepth: 3

    gallery_examples/00-setup/index.rst
    gallery_examples/01-project-configuration/index.rst
    gallery_examples/02-importing/index.rst
    gallery_examples/03-exporting/index.rst
    gallery_examples/04-analyses/index.rst
    gallery_examples/99-teardown/index.rst


.. _ref_examples:

Examples
========

Here are examples using Sherlock with the ``ansys-sherlock-core`` library.

.. grid:: 2 2 3 3
   :gutter: 1 2 3 3
   :padding: 1 2 3 3


   .. grid-item-card:: Project Configuration
      :link: sphx_glr_examples_gallery_examples_01-project-configuration
      :link-type: ref

      Examples on how to configure a project using PySherlock.

   .. grid-item-card:: Importing Projects and Files
      :link: sphx_glr_examples_gallery_examples_02-importing
      :link-type: ref

      Examples on how to import projects and files using PySherlock.

   .. grid-item-card:: Exporting Projects and Files
      :link: sphx_glr_examples_gallery_examples_03-exporting
      :link-type: ref

      Examples on how to import projects and files using PySherlock.

   .. grid-item-card:: Running Analyses
      :link: sphx_glr_examples_gallery_examples_04-analyses
      :link-type: ref

      Examples on how to run analyses using PySherlock.


.. === DOWNLOAD EXAMPLES ===

.. _ref_download_files:

Download example files
======================

Each example should contain all the necessary resources to run the example.
However in some cases, external files are needed. A link to those files is
available at each example page.
These links refers to the following GitHub repository where you can find all of them:

`GitHub Example Data Repository <example_data_repo_>`_

If you find a missing or broken link, open an issue in
GitHub (`PySherlock Issues <pysherlock_issues_>`_).