.. MUIO Documentation documentation master file, created by
   sphinx-quickstart on Thu Jun 19 21:16:52 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MUIO: Modelling User Interface for OSeMOSYS
================================

.. image:: https://img.shields.io/github/license/OSeMOSYS/MUIO
    :target: LICENSE.txt
    :alt: License

OSeMOSYS stands for "Open Source Energy Modelling System." It is a linear programming model designed for long-term integrated assessment and energy planning. It is particularly useful for informing Nationally Determined Contributions (NDCs), Long-Term Strategies (LTS), and Decarbonization Plans.

MUIO is a user interface that facilitates data management, model creation, and scenario analysis using OSeMOSYS.

OSeMOSYS has been applied at various scales, from continental energy systems (such as African Power Pools, South America, and EU28+2) to national, regional, and even village-level models.

Designed to be cost-free, with a fast learning curve and minimal time commitment, it is accessible to a wide range of users, including developers, modellers, academics, and policymakers. Thanks to its transparency, it is widely used for training and dissemination.

📖 Explore our latest literature `review <https://www.sciencedirect.com/science/article/abs/pii/S0973082624002552>`_ on OSeMOSYS applications, enhancements, and future research directions.

🎓 Join our Open University `course <https://www.open.edu/openlearncreate/course/view.php?id=13558>`_ to learn how to build an energy system model from scratch using OSeMOSYS and MUIO.

This project is maintained by Climate Compatible Growth (CCG) and the United Nations Department of Economic and Social Affairs (UNDESA).


Documentation
=============

**Getting Started**

* :doc:`/getting-started/introduction`
* :doc:`/getting-started/installation`
* :doc:`/getting-started/quick-start`

.. toctree::
   :hidden:
   :maxdepth: 0
   :caption: Getting Started

   getting-started/introduction
   getting-started/installation
   getting-started/quick-start

**Structure of OSeMOSYS in MUIO**

* :doc:`/structure-osemosys/intro`
* :doc:`/structure-osemosys/sets`
* :doc:`/structure-osemosys/parameters`
* :doc:`/structure-osemosys/variables`
* :doc:`/structure-osemosys/equations`

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Structure of OSeMOSYS in MUIO
   
   structure-osemosys/intro
   structure-osemosys/sets
   structure-osemosys/parameters
   structure-osemosys/variables
   structure-osemosys/equations
	
**User Guide**

* :doc:`/user-guide/overview`
* :doc:`/user-guide/creating`


.. toctree::
   :hidden:
   :maxdepth: 0
   :caption: User Guide

   user-guide/overview
   user-guide/creating

**Examples**

* :doc:`/examples/demo`
* :doc:`/examples/others`


.. toctree::
   :hidden:
   :maxdepth: 0
   :caption: Examples

   examples/demo
   examples/others

**Contributing & Support**

* :doc:`/contributing/contributing`
* :doc:`/contributing/support`

.. toctree::
   :hidden:
   :maxdepth: 0
   :caption: Contributing & Support

   contributing/contributing
   contributing/support

**References**

* :doc:`/references/citing`
* :doc:`/references/users`

.. toctree::
   :hidden:
   :maxdepth: 0
   :caption: References

   references/citing
   references/users