.. MARBL documentation master file, created by
   sphinx-quickstart on Fri Feb  3 14:01:48 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

==============================
Marine Biogeochemistry Library
==============================

The Marine Biogeochemistry Library, or MARBL, is a Fortran software package to be used by ocean general circulation models.
It is `available via github <https://github.com/marbl-ecosys/MARBL>`_.
Licensing details are provided in the top-level ``LICENSE`` file.

----------------
About This Guide
----------------

This document has four major sections.

The :ref:`user's guide <usr-guide>` is designed to support configuring and running MARBL.

We also provide :ref:`some examples <implementations>` of how MARBL is implemented in GCMs.

The :ref:`developer's guide <dev-guide>` provides techincal documentation of the MARBL code.

The :ref:`scientific guide <sci-guide>` aims to communicate the scientific underpinnings of the formulations encoded in MARBL.

----------
Disclaimer
----------

This version of MARBL has been made public solely for use in CESM 2.0.
If you want to bring MARBL in to your GCM, please wait for the official MARBL 1.0.0 release.

-----------
Sponsorship
-----------

MARBL is supported by the DOE `Biological and Environmental Research <https://climatemodeling.science.energy.gov/projects/marbl-marine-biogeochemistry-library>`_ office
and the `National Center for Atmospheric Research <https://ncar.ucar.edu/home>`_, which is funded by the National Science Foundation.

-----------------
Table of contents
-----------------

.. toctree::
   :hidden:

   self

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   usr-guide/index.rst
   implementations/index.rst
   dev-guide/index.rst
   sci-guide/index.rst
   dev-guide/repo-access/index.rst

..
  Indices and tables
  ==================
  * :ref:`genindex`
  * :ref:`modindex`
  * :ref:`search`

