.. ACCERT documentation master file, created by
   sphinx-quickstart on Wed Sep 18 21:47:33 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:notoc:

Welcome to ACCERT's Documentation
=================================

.. grid:: 3
    :gutter: 3

    .. grid-item-card:: \ :octicon:`rocket;2em` Getting Started
        :text-align: center
        :link: user/getting_started
        :link-type: doc

        New to ACCERT? Click here to get a quick overview of how ACCERT works.

    .. grid-item-card:: \ :octicon:`book;2em` User's Guide
        :text-align: center
        :link: user/index
        :link-type: doc

        The user's guide contains instructions for installing and an overview of
        the basic concepts.

    .. grid-item-card:: \ :octicon:`terminal;2em` Reference
        :text-align: center
        :link: reference/index
        :link-type: doc

        The reference guide provides detailed information on classes, methods,
        arguments, return values, etc.

    .. grid-item-card:: \ :octicon:`git-pull-request;2em` Developer's Guide
        :text-align: center
        :link: dev/index
        :link-type: doc

        Interested in contributing to ACCERT? Our developer's guide provides
        instructions on how to make a contribution.

    .. grid-item-card:: \ :octicon:`list-unordered;2em` Examples
        :text-align: center
        :link: examples/index
        :link-type: doc

        Check out our examples that illustrate a variety of use cases.

    .. grid-item-card:: \ :octicon:`comment-discussion;2em` Getting Help
        :text-align: center
        :link: https://github.com/accert-dev/ACCERT/discussions

        Have questions? Click here for our discussions forum where you can ask
        questions and engage with our development team.

.. toctree::
    :maxdepth: 2
    :caption: Contents:
    :hidden:

    user/index
    reference/index
    examples/index
    dev/index


.. admonition:: Recommended publication for citing
   :class: tip

   Zhou, Jia, Stauff, Nicolas E., and Hoffman, Edward A. ACCERT. Computer Software. `https://github.com/accert-dev/ACCERT`. USDOE Office of Nuclear Energy (NE). 17 Mar. 2023. Web. `doi:10.11578/dc.20240601.1 <https://doi.org/10.11578/dc.20240601.1>`_.