.. meta::
   :description: Examples and Test Cases in ADCIRC
   :keywords: adcirc, examples and test cases

.. _examples:

Examples
========

Below is a list of convenient test cases covering a range of basic uses and
common ADCIRC capabilities. In addition to the test cases shown below, note the
ADCIRC test suite hosted on the GitHub repository,
https://github.com/adcirc/adcirc-testsuite, which has many of the tests below
and more.

-  `Quarter Annular Harbor with Tidal Forcing (2D and
   3D) <https://adcirc.org/home/documentation/example-problems/quarter-annular-harbor-with-tidal-forcing-example/>`__
-  `Shinnecock Inlet with Tidal Forcing
   (2D) <https://adcirc.org/home/documentation/example-problems/shinnecock-inlet-ny-with-tidal-forcing-example>`__
-  `Beaufort Inlet
   (2D) <https://adcirc.org/home/documentation/example-problems/beaufort-inlet-nc-example/>`__
-  `Idealized Inlet
   (2D) <https://adcirc.org/home/documentation/example-problems/idealized-inlet-test-cases/>`__
-  `Internal Overflow Boundary
   (2D) <https://adcirc.org/home/documentation/example-problems/internal-overflow-boundaries-example/>`__
-  `APES Wind Run (NWS = 3)
   (2D) <https://adcirc.org/home/documentation/example-problems/apes-wind-run-example/>`__
-  `Hurricane Isabel Wind Run (NWS = 4)
   (2D) <https://adcirc.org/home/documentation/example-problems/hurricane-isabel-example/>`__
-  `Large Grid (~300,000 nodes) Tides
   Only <https://adcirc.org/home/documentation/example-problems/large-grid-tides-example/>`__
-  `Hurricane Katrina
   (NWS=20) <https://adcirc.org/home/documentation/example-problems/katrina-run-2015-nws-20-example/>`__
-  :doc:`Global Astronomical M2 Tide (2D) <global_astronomical_m2_tide>`
-  :doc:`Global Storm Tide - Hurricane Katrina (NWS = -14) (2D) <global_storm_tide_katrina>`
-  :doc:`Alaskan Winter Storm with Ice (NWS = 14) (2D) <alaskan_winter_storm_with_ice>`
-  :doc:`Idealized Channel Problem (2D) <idealized_channel>`

.. toctree::
   :hidden:

   alaskan_winter_storm_with_ice
   global_astronomical_m2_tide
   global_storm_tide_katrina
   idealized_channel