========
UK-MOSEM
========

This is the documentation of **UK-MOSEM**.

UK-MOSEM is the UK Multi-scale Open Source Energy Model. It is using the `fratoo <https://github.com/lhofbauer/fratoo>`_ framework – an open-source multi-scale modelling framework based on `OSeMOSYS <http://www.osemosys.org/>`_. 

This documentation currently mainly includes information about each of the data processing steps part of the UK-MOSEM workflow. Additional context is planned to be added once a related monograph has been published.

Contents
========

.. toctree::
   :maxdepth: 1

   Installation <installation>
   Workflow steps <workflow>
   Contributions & Help <contributing>
   License <license>
   Authors <authors>
   Changelog <changelog>

Acknowledgements
================

The initial development of UK-MOSEM was supported by the Engineering and Physical Sciences Research Council, UK, under grant EP/R513143/1.


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

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

.. _toctree: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _references: https://www.sphinx-doc.org/en/stable/markup/inline.html
.. _Python domain syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain
.. _Sphinx: https://www.sphinx-doc.org/
.. _Python: https://docs.python.org/
.. _Numpy: https://numpy.org/doc/stable
.. _SciPy: https://docs.scipy.org/doc/scipy/reference/
.. _matplotlib: https://matplotlib.org/contents.html#
.. _Pandas: https://pandas.pydata.org/pandas-docs/stable
.. _Scikit-Learn: https://scikit-learn.org/stable
.. _autodoc: https://www.sphinx-doc.org/en/master/ext/autodoc.html
.. _Google style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
.. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
.. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists