diff --git a/doc/conf.py b/doc/conf.py index a0ec51b7fd..b011476fe4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -172,6 +172,12 @@ def setup(app: "sphinx.application.Sphinx") -> None: "pull": ("https://github.com/iiasa/message-ix-models/pull/%s", "PR #%s"), "gh-user": ("https://github.com/%s", "@%s"), "source": ("https://github.com/iiasa/message-ix-models/blob/main/%s", "%s"), + # Temporary, for #275. DO NOT use these except in doc/dev/275.rst + "md-to-migrate": ("https://github.com/iiasa/message_data/blob/ssp_dev/%s", None), + "msc-to-migrate": ( + "https://github.com/iiasa/message_single_country/blob/SSP_Dev_2023/%s", + None, + ), } # -- Options for sphinx.ext.intersphinx ------------------------------------------------ diff --git a/doc/dev/275.rst b/doc/dev/275.rst new file mode 100644 index 0000000000..c0b21fdc95 --- /dev/null +++ b/doc/dev/275.rst @@ -0,0 +1,238 @@ +Summary for :issue:`275` +************************ + +See below the table for a key. +The table currently includes: + +- All files in the message_single_country directory :file:`models/modules/`. + +.. todo:: Expand the table to include: + + - All (groups of) files modified by commits on the SSP_Dev_2023 branch of message_single_country. + - All (groups of) files modified by commits on the ssp_dev branch of message_data. + +.. list-table:: + :header-rows: 1 + + * - Name + - m_data + - …country + - …models + - Pick + - PR/issue + + * - ``add_UE_share_constraints`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``add_reliability_peak`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``adjust_cf_to_history`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``adjust_lifetime_to_history`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``apply_LED_setup`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``apply_ssp_vre`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``calibrate_UE_gr_to_demand`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``calibrate_UE_share_constraints`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``calibrate_demand`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``calibrate_extraction`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``calibrate_historical_capacity`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``calibrate_to_IEA_offline`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``calibrate_vre`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``change_technology_lifetime`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``compile_IEA_data_offline`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``compile_IEA_data_offline_extraction`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``compile_capacity_data`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``copy_parameter`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``get_codes`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``perform_vintage_check`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``project_vre`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``read_demand_downscaled`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``res_marg`` + - :md-to-migrate:`link ` + - :msc-to-migrate:`link ` + - None + - message_data + - :pull:`277` + + * - ``rescale_demands`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``update_gdp_pop`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``update_rc_demand`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + + * - ``update_trp_demand`` + - ? + - :msc-to-migrate:`link ` + - ? + - TODO + - ? + +How to use +========== + +- Keep the list in alphabetical order. +- In each row, enter: + + **Name** + A short name for the module, function, or collection of such. + **m_data** + Link to one code or data file on the ``ssp_dev`` branch of ``message_data``, if any. + If there are multiple files, choose one. + **…country** + Link to one code or data file on the ``SSP_Dev_2023`` branch of ``message_single_country``, if any. + If there are multiple files, choose one. + If the file is present in both message_data and message_single_country, these links should correspond in order to support diff of the two versions. + **…models** + Link to one code or data file on the ``main`` branch of ``message-ix-models``, for instance if the item has already been migrated as a dependency of other code. + If this migration has not happened yet, put "None". + **Pick** + Either "m_data", "m_single_country", or "m-ix-models", indicating which version of the code/data files will be preferred. + **PR/issue** + Link to, *at minimum*, a message-ix-models pull request that adds or updates the item, or an issue gathering more info than appears in the table. + Use the usual GitHub features to: + + - Track the assignees, review assignments, status, checklist items, etc. associated with the PR. + - Cross-reference additional PRs that remove the corresponding files or code from message_data and/or message_single_country.