=========
CORE-WESM
=========

This is the documentation of the COunty-REsolved Whole Energy System Model for Kenya (**CORE-WESM**). CORE-WESM is a whole energy system model of Kenya with a representation of each of Kenya's 47 counties.


Background
==========

CORE-WESM has been developed to support the integration of county and national energy planning in Kenya in line with the Integrated National Energy Plan (INEP) process. The model aims to support the integration of county energy plans (CEPs) and priorities into the county-national integrated energy planning process. It does not intend to replace modelling to inform CEP development.

More information on the context and background to the model can be found in this `scoping report`_ and `preprint`_.


Overarching approach and workflow
=================================
CORE-WESM is a county-disaggregated version of the open-source whole energy system model OSeMOSYS-Kenya. OSeMOSYS-Kenya is a linear optimization model built using the open-source modelling framework OSeMOSYS. The development and application of CORE-WESM is based on a workflow with two overarching steps:


#. The creation of a county-resolved model input data set based on the disaggregation of OSeMOSYS-Kenya and inclusion of different county-level data.
#. The flexible application of the county-resolved model faclitated by a compact multi-scale modelling framework wrapped around OSeMOSYS.

The steps are explained in more detail in :ref:`model` and :ref:`data` (also linked in the navigation panel on the left and below).


.. warning::
   The current CORE-WESM version – as any energy model – has limitations that are important to understand before using the model.


Scope of this documentation
===========================

The main aim of this documentation is to provide a practical guide to running the CORE-WESM model. The general structure of the model in terms of its sectors, technologies, fuels, and more, is equivalent to the structure of the OSeMOSYS-Kenya model and is described in the OSeMOSYS-Kenya documentation. A detailed description of the OSeMOSYS framework is provided in its documentation. Links to these and other material are provided below.




Related material
================

* Both OSeMOSYS-Kenya and CORE-WESM are based on the **OSeMOSYS framework**. More information on OSeMOSYS can be found on its  `GitHub repository <https://github.com/OSeMOSYS/OSeMOSYS>`_ and `documentation <https://osemosys.readthedocs.io/en/latest/index.html>`_. 
* CORE-WESM is a county-resolved version of the **OSeMOSYS-Kenya WESM**. More information on OSeMOSYS-Kenya can be found on its  `GitHub repository <https://github.com/ClimateCompatibleGrowth/osemosys_kenya_wesm>`_ and `documentation <https://osemosys-kenya-wesm.readthedocs.io/en/latest/>`_.  
* The multi-scale functionality of the CORE-WESM is based on the **fratoo** framework. More information on fratoo can be found on its  `GitHub repository <https://github.com/lhofbauer/fratoo>`_ and `documentation <https://fratoo.readthedocs.io/en/latest/>`_. 





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

This material has been produced with support from the UK Partnering for Accelerated Climate Transitions (UK PACT) programme and the Climate Compatible Growth (CCG) programme. UK PACT and CCG are funded by UK Aid from the UK Government. Views expressed herein do not necessarily reflect the UK government's official policies.


Contents
========

.. toctree::
   :maxdepth: 1

   Installation <installation>
   Model workflow <model>
   Model input data <data>
   Contributions & Help <contributing>
   License <license>
   Authors <authors>
   Changelog <changelog>
   Module Reference <api/modules>

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
.. _wesm docs : https://osemosys-kenya-wesm.readthedocs.io/en/latest/
.. _wesm github : https://github.com/ClimateCompatibleGrowth/osemosys_kenya_wesm
.. _preprint1 : https://doi.org/10.5281/zenodo.15115502
.. _preprint : https://zenodo.org/records/19360964
.. _scoping report : https://doi.org/10.5281/zenodo.15108308