.. ADCIRC documentation master file, created by
   sphinx-quickstart on Fri Apr 18 16:37:27 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ADCIRC Model Documentation
==========================

Welcome to the ADCIRC model documentation. This documentation aims to provide a comprehensive, up-to-date resource for the ADCIRC users and developers.


Quick Links
-----------

* :doc:`What is ADCIRC? <introduction/what_is_adcirc>` - Learn about ADCIRC's capabilities and features
* :doc:`Getting Started <getting_started/index>` - Installation and basic setup guide
* :doc:`Contributing <contributing/index>` - Guidelines for contributing to ADCIRC
* :doc:`Theory <theory/index>` - Mathematical and physical foundations
* :doc:`Compiling <user_guide/compiling>` - Build instructions for different platforms
* :doc:`Model Configuration <user_guide/model_configuration/index>` - Detailed setup and parameter guide
* :doc:`File Formats <technical_reference/all_files>` - Input/output file specifications
* :doc:`Questions & Support <questions_and_support/index>` - Get help from the ADCIRC community
* :doc:`Tools <tools/index>` - Pre/post-processing and visualization utilities
* :doc:`About <about/index>` - Documentation information and contributing guidelines


.. toctree::
   :maxdepth: 2
   :caption: Introduction:
   :hidden:

   introduction/what_is_adcirc

.. toctree::
   :maxdepth: 2
   :caption: Getting Started:
   :hidden:
   
   getting_started/index

.. toctree::
   :maxdepth: 2
   :caption: Contributing:   
   :hidden:
   
   contributing/index

.. toctree::
   :maxdepth: 1
   :caption: Theory:
   :hidden:

   theory/index

.. toctree::
   :maxdepth: 1
   :caption: User Guide:
   :hidden:
   
   user_guide/compiling
   user_guide/running_adcirc/index
   user_guide/model_configuration/index
   user_guide/special_features/index
   user_guide/tips_and_tricks/index
   user_guide/examples/index

.. toctree::
   :maxdepth: 1
   :caption: Technical Reference:
   :hidden:
   
   technical_reference/all_files
   technical_reference/input_files/index
   technical_reference/output_files/index
   technical_reference/parameter_definitions/index
   technical_reference/executables
   technical_reference/architecture/code_architecture

.. toctree::
   :maxdepth: 1
   :caption: Support:
   :hidden:
   
   questions_and_support/index   
   tools/index

.. toctree::
   :maxdepth: 2
   :caption: About:
   :hidden:
   
   about/index