Add stub files for .model.magpie

iiasa · Jan 31, 2025 · 20f7faf · 20f7faf
1 parent 7f94f8a
commit 20f7faf
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/doc/model/magpie.rst b/doc/model/magpie.rst
@@ -0,0 +1,13 @@
+MESSAGEix-MAgPIE
+****************
+
+.. warning:: This documentation describes code that is **in development**.
+   The code may not be generally usable outside the exact case(s) described on this and linked pages.
+
+**MESSAGEix-MAgPIE** refers to a models that use `MAgPIE <https://www.pik-potsdam.de/en/institute/departments/activities/land-use-modelling/magpie>`__ to model land use in combination with MESSAGE.
+This arrangement is roughly analysis to the relationship between MESSAGE and GLOBIOM in the :doc:`/global/index`.
+
+Usage
+=====
+
+.. todo:: Describe how the MESSAGE-MAgPIE linked models are built, solved and reported.
diff --git a/message_ix_models/model/magpie.py b/message_ix_models/model/magpie.py
@@ -0,0 +1,3 @@
+"""MESSAGE-MAgPIE integration."""
+# NB If the code requires multiple sub-modules, this file will be moved to
+#    /model/magpie/__init__.py
diff --git a/message_ix_models/tests/model/test_magpie.py b/message_ix_models/tests/model/test_magpie.py