.. micm documentation HTML titles
..
.. # (over and under) for module headings
.. = for sections
.. - for subsections
.. ^ for subsubsections
.. ~ for subsubsubsections
.. " for paragraphs
================================
Welcome to MICM's documentation!
================================
.. grid:: 1 1 2 2
:gutter: 2
.. grid-item-card:: Getting started
:img-top: _static/index_getting_started.svg
:link: getting_started
:link-type: doc
Check out the getting started guide to build and install micm.
.. grid-item-card:: User guide
:img-top: _static/index_user_guide.svg
:link: user_guide/index
:link-type: doc
Learn how to configure micm for your mechanisms here!
.. grid-item-card:: API reference
:img-top: _static/index_api.svg
:link: api/index
:link-type: doc
The source code for micm is heavily documented. This reference will help you extend micm for your needs.
.. grid-item-card:: Contributors guide
:img-top: _static/index_contribute.svg
:link: contributing/index
:link-type: doc
If you'd like to contribute some new science code or update the docs,
checkout the contributors guide!
.. toctree::
:maxdepth: 2
:caption: Contents:
getting_started
user_guide/index
api/index
contributing/index
citing_and_bibliography/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`