Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add .model.magpie, .project.justmip #274

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/model/magpie.rst
Original file line number Diff line number Diff line change
@@ -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.
21 changes: 21 additions & 0 deletions doc/project/justmip.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
JustMIP (:mod:`.project.justmip`)
*********************************

Project information
===================

.. todo:: Complete the following list items:

- Website: …
- Project period: …

Data
====

Code reference
==============

.. currentmodule:: message_ix_models.project.justmip

.. automodule:: message_ix_models.project.justmip
:members:
3 changes: 3 additions & 0 deletions message_ix_models/model/magpie.py
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions message_ix_models/project/justmip/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""JustMIP project."""
Empty file.
Empty file.
Loading