Skip to content

Commit f943878

Browse files
committed
Add #178 to doc/whatsnew
1 parent 5ec3701 commit f943878

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

doc/api/report/index.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ On this page:
99
Elsewhere:
1010

1111
- ``global.yaml``, the :doc:`default-config`.
12-
- Documentation for :mod:`genno` (:doc:`genno:index`), :mod:`ixmp.report`, and :mod:`message_ix.report`.
12+
- Documentation for :mod:`genno` (:doc:`genno:index`),
13+
:mod:`ixmp.report`, and
14+
:mod:`message_ix.report`.
1315
- Reporting for specific model variants:
1416

1517
- :mod:`.water.reporting`
@@ -87,6 +89,22 @@ the following functionality is provided.
8789

8890
.. note:: If any of this does not appear to work as advertised, file a bug!
8991

92+
Scope of :mod:`genno`-based vs. :mod:`.legacy` reporting
93+
--------------------------------------------------------
94+
95+
:func:`.prepare_reporter` currently handles only a subset
96+
of the IAMC-structured data produced by :mod:`.report.legacy`.
97+
The module globals :data:`.NOT_IMPLEMENTED_MEASURE` and :mod:`NOT_IMPLEMENTED_IAMC`
98+
express the measures and IAMC ‘variables’ that are either not implemented
99+
or not exactly matching the legacy reporting output.
100+
The test :func:`.test_report.test_compare` compares outputs
101+
from the two forms of reporting using :func:`.iamc.compare`,
102+
ensuring that data match for all entries *except* these exclusions.
103+
104+
See GitHub issues and pull requests with the
105+
`'report' label <https://github.com/iiasa/message-ix-models/issues?q=state%3Aopen%20label%3Areport>`_
106+
for ongoing work to expand the scope of :func:`prepare_reporter`.
107+
90108
Units
91109
-----
92110

doc/whatsnew.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
What's new
22
**********
33

4-
.. Next release
5-
.. ============
4+
Next release
5+
============
6+
7+
- Improvements to :class:`.report.Config` (:pull:`178`):
8+
9+
- New attribute :attr:`~.report.Config.modules`.
10+
- New method :meth:`~.report.Config.iter_callbacks`.
11+
12+
- New function :func:`.tools.iamc.compare` (:pull:`178`).
13+
- Expand :doc:`api/report/index` documentation (:pull:`178`)
14+
to cover features implemented/not implemented by :mod:`genno`-based reporting.
15+
Module globals :data:`.NOT_IMPLEMENTED_MEASURE` and :data:`.NOT_IMPLEMENTED_IAMC`
16+
record not-yet-implemented measures and IAMC ‘variables’.
617

718
v2025.10.31
819
===========

0 commit comments

Comments
 (0)