Documentation for alamo
=======================


.. grid:: 1 2 1 2
    :gutter: 3
   
    .. grid-item-card::
        :link: getting-started
        :link-type: ref
        
        :fas:`forward;fa-fw` Getting Started
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        Initial step-by-step instructions for downloading, building, and running Alamo.
        Basic instructions on troubleshooting.

        ++++++++++++++++++++++++++++++++++++++++++++++++++
        :bdg-success-line:`Start here if you're brand new` 

    .. grid-item-card::  
        :link: tests
        :link-type: ref

        :fas:`flask;fa-fw` Running Tests
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        Explore the set of examples and regression tests that demonstrate Alamo functionality.

        ++++++++++++++++++++++++++++++++++++++++++++++++++++
        :bdg-success-line:`Next steps after compiling Alamo` 
        
    .. grid-item-card:: 
        :link: simba
        :link-type: ref

        :fas:`paw;fa-fw` SimBA
        ^^^^^^^^^^^^^^^^^^^^^^

        Use the Alamo **Sim**\ ulation **B**\ rowser **A**\ nalysis system to manage Alamo simulations for regression tests or your own projects.
        
        +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        :bdg-warning-line:`Optional but useful for regular users` 
        
        
    .. grid-item-card:: 
        :link: inputs
        :link-type: ref

        :fas:`cube;fa-fw` API and Inputs
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        Browse the auto-generated documentation for Alamo classes and input file input specifications.
        
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        :bdg-warning-line:`For those using existing code to run new siulations.` 
        

    .. grid-item-card:: 
        :link: developers
        :link-type: ref

        :fas:`code;fa-fw` Developer Instructions
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        Basics of Alamo design philosophy and practice.
        How to create branches, implement new models, run tests, and avoid breaking the repository.
        
        ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
        :bdg-danger-line:`Starting point for all new alamo developers`
        
        
    .. grid-item-card:: 
        :link: autodoc
        :link-type: ref

        :fas:`swatchbook;fa-fw` Alamo's autodoc system
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        Alamo's custom auto-documentation and test system designed to enforce documentation and 
        testing standards, while preventing stagnant/depricated content.
        
        +++++++++++++++++++++++++++++++++++
        :bdg-danger-line:`Required reading for all developers`
        


References
==========


.. bibliography:: 
   :list: bullet
   :all:




Sponsors
========

The development team gratefully acknowledges the funding sources that enable the development and extension of Alamo.

.. grid:: 1 2 1 2
    :gutter: 3
           
    .. grid-item-card::
        
        **Office of Naval Research**
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        .. image:: https://www.solids.group/wp-content/uploads/2021/12/onr.png
             :alt: onr

        ++++++++++++++++++++++++++++++++++++++++++++++
        *Mesoscale and continuum modeling of solid-phase propellant coupled to gas-phase to determine continuum burn rates in AP/HTPB*

    .. grid-item-card::
        
        **National Science Foundation**
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        .. image:: https://www.solids.group/wp-content/uploads/2022/01/nsfcareer.png
             :alt: national science foundation
             :width: 100%
             :align: center

        ++++++++++++++++++++++++++++++++++++++++++++++
        *CAREER: A multichannel convolutional neural network framework for prediction of damage nucleation sites in microstructure*

    .. grid-item-card::
        
        **National Science Foundation**
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        .. image:: https://www.solids.group/wp-content/uploads/2021/12/nsf.png
             :alt: national science foundation
             :width: 100%
             :align: center

        ++++++++++++++++++++++++++++++++++++++++++++++
        *MRI: Acquisition of a high performance computing cluster for next-generation computational science in Southern Colorado*

    .. grid-item-card::
        
        **Berkeley Lab**
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        .. image:: https://www.solids.group/wp-content/uploads/2021/12/lbl.png
             :alt: lawrence berkeley national lab
             :width: 100%
             :align: center

        ++++++++++++++++++++++++++++++++++++++++++++++
        *Extending the capability of the AMReX MLMG nodal solver*
    

.. dropdown:: Table of contents


    .. toctree::
        :maxdepth: 4
        :caption: Contents:

        GettingStarted
        Simba
        AutoDocAutoTest
        Tests
        Inputs
        InputsSearch
        InputIndex
        Developers
        Questions
        Builder