..
    SPDX-FileCopyrightText: 2022 Tanguy Fardet
    SPDX-License-Identifier: CC-BY-SA-4.0
    docs/index.rst

===================================
Welcome to OrgMatt's documentation!
===================================

.. image:: https://builds.sr.ht/~tfardet/orgmatt/commits/main.svg
    :target: https://builds.sr.ht/~tfardet/orgmatt/commits/main
    :alt: CI status
.. image:: https://api.reuse.software/badge/git.sr.ht/~tfardet/OrgMatt
    :target: https://api.reuse.software/info/git.sr.ht/~tfardet/OrgMatt
    :alt: REUSE compliant
.. image:: _static/license-GPLv3+-yellow.svg
    :target: https://spdx.org/licenses/GPL-3.0-or-later.html
    :alt: GPLv3+ license

OrgMatt is an open-source library to help evaluate the generation, potential
use and impacts of organic matter by human populations:

* how much nutrients are consumed by a population depending on their age, diet, etc?
* how much urine, feces, and biowaste are generated?
* how much nutrients are contained in there?
* how much water use could be avoided?
* and much more!


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: User Documentation

   user/install
   user/tutorial

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Modules

   modules/agrifood
   modules/data
   modules/excreta
   modules/impacts
   modules/metabolism
   modules/nutrients
   modules/plot
   modules/units


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`