Merge pull request #232 from iiasa/circeular/add

khaeru · web-flow · commit d90c11ce2b3b · 2024-09-25T16:22:53.000+02:00
Add CircEUlar
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -21,7 +21,7 @@ For example, one or more of:
 
 - Read the diff and note that the CI checks all pass.
 - Run a specific code snippet or command and check the output.
-- Build the documentation and look at a certain page.
+- Look at a certain page in the ReadTheDocs preview build of the documentation.
 - Ensure that changes/additions are self-documenting, i.e. that another
   developer (someone like the reviewer) will be able to understand what the code
   does in the future.
diff --git a/doc/api/tools.rst b/doc/api/tools.rst
@@ -1,5 +1,5 @@
-General purpose modeling tools
-******************************
+General purpose modeling tools (:mod:`.tools`)
+**********************************************
 
 “Tools” can include, *inter alia*:
 
diff --git a/doc/index.rst b/doc/index.rst
@@ -89,6 +89,7 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
    :caption: Research projects
 
    project/advance
+   project/circeular
    project/edits
    project/gea
    project/shape
diff --git a/doc/material/index.rst b/doc/material/index.rst
@@ -1,5 +1,5 @@
-MESSAGEix-Materials
-********************
+MESSAGEix-Materials (:mod:`.model.material`)
+********************************************
 
 Description
 ===========
diff --git a/doc/project/circeular.rst b/doc/project/circeular.rst
@@ -0,0 +1,28 @@
+CircEUlar (:mod:`.project.circeular`)
+*************************************
+“Developing Circular Pathways for an EU Low-Carbon Transition”
+
+Project information
+===================
+
+- Website: https://circeular.org
+- Duration: 2022-09–2026-08
+- Funder: Horizon Europe
+
+Modeling activities may include:
+
+- Improve :doc:`representation of material cycles </material/index>` (e.g., calibrate stocks and flows) (2022-09–2025-08).
+- Explore circular business models and consumption for buildings, household services and mobility (2023-03–2026-02).
+- Soft-link with service models, dynamic MFA (`MISO2 <https://github.com/socialecologyboku/MISO2>`_), MRIO (EXIOfutures), and waste (GAINS) models (2024-06–2025-08).
+- Develop integrated energy-material-emissions scenarios with focus on demand side transformation (2025-01–2026-08).
+
+Code reference
+==============
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: autosummary-module.rst
+   :recursive:
+
+   message_ix_models.project.circeular
+   message_ix_models.tests.project.circeular
diff --git a/doc/project/edits.rst b/doc/project/edits.rst
@@ -1,7 +1,7 @@
 .. currentmodule:: message_ix_models.project.edits
 
-EDITS
-*****
+EDITS (:mod:`.project.edits`)
+*****************************
 
 “Energy Demand changes Induced by Technological and Social innovations (EDITS)”
 
diff --git a/doc/project/shape.rst b/doc/project/shape.rst
@@ -2,8 +2,8 @@
 
 .. module:: message_ix_models.project.shape
 
-SHAPE
-*****
+SHAPE (:mod:`.project.shape`)
+*****************************
 
 .. image:: http://shape-project.org/@@site-logo/Logo_Shape_RGB_72dpi_small.png
    :alt: SHAPE Logo
diff --git a/doc/transport/index.rst b/doc/transport/index.rst
@@ -1,5 +1,5 @@
-MESSAGEix-Transport
-*******************
+MESSAGEix-Transport (:mod:`.model.transport`)
+*********************************************
 
 .. warning::
 
diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst
@@ -4,7 +4,8 @@ What's new
 Next release
 ============
 
-- Update water avaialbility data and major code editing to allow a new test suite for the water module (:pull:`106`).
+- Add :doc:`/project/circeular` project code and documentation (:pull:`232`).
+- Update water availability data and major code editing to allow a new test suite for the water module (:pull:`106`).
 - Expand :doc:`repro` with sections on :ref:`repro-doc` and :ref:`versioning`, including :ref:`a list of external model names and ‘versions’ <model-names>` like “MESSAGEix-GLOBIOM 2.0” (:issue:`224`, :pull:`226`).
 - Fix and update :doc:`/api/tools-costs` (:pull:`219`)
 
diff --git a/message_ix_models/cli.py b/message_ix_models/cli.py
@@ -162,6 +162,7 @@ def _log_threads(k: int, n: int):
     "message_ix_models.model.structure",
     "message_ix_models.model.transport.cli",
     "message_ix_models.model.water.cli",
+    "message_ix_models.project.circeular.cli",
     "message_ix_models.project.edits.cli",
     "message_ix_models.project.ssp",
     "message_ix_models.report.cli",
diff --git a/message_ix_models/project/circeular/__init__.py b/message_ix_models/project/circeular/__init__.py
diff --git a/message_ix_models/project/circeular/cli.py b/message_ix_models/project/circeular/cli.py
@@ -0,0 +1,9 @@
+import click
+
+
+@click.group("circeular")
+def cli():
+    """CircEUlar project.
+
+    https://docs.messageix.org/projects/models/en/latest/project/circeular.html
+    """
diff --git a/message_ix_models/tests/project/circeular/__init__.py b/message_ix_models/tests/project/circeular/__init__.py
