Add new industry reporter

[macflo8]

This PR adds an improved industry reporter for MESSAGEix-Materials developed in the course of the ScenarioMIP project. It cherry-picks some initial commits from the #235 branch.

How to review

1. Read the diff and note that the CI checks all pass.
2. Look at the materials doc in the ReadTheDocs preview build of the documentation —in particular, the entry in “What's New” and linked entries.
3. 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.

PR checklist

• Continuous integration checks all ✅
• Add or expand tests; coverage checks both ✅
• Add, expand, or update documentation.
• Update doc/whatsnew.

[codecov]

Codecov Report

❌ Patch coverage is 75.12195% with 102 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.4%. Comparing base (e45db65) to head (780c8f4).
⚠️ Report is 48 commits behind head on main.

Files with missing lines	Patch %	Lines
...e_ix_models/model/material/report/run_reporting.py	53.3%	91 Missing ⚠️
...ssage_ix_models/model/material/report/reporting.py	64.2%	10 Missing ⚠️
...models/tests/model/material/test_reporter_utils.py	95.8%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #395     +/-   ##
=======================================
- Coverage   77.1%   73.4%   -3.8%     
=======================================
  Files        250     257      +7     
  Lines      20198   21451   +1253     
=======================================
+ Hits       15589   15754    +165     
- Misses      4609    5697   +1088     

Files with missing lines	Coverage Δ
message_ix_models/model/material/report/config.py	100.0% <100.0%> (ø)
..._ix_models/model/material/report/reporter_utils.py	100.0% <100.0%> (ø)
message_ix_models/testing/__init__.py	80.6% <100.0%> (-14.2%)	⬇️
...sage_ix_models/tests/model/material/test_report.py	100.0% <100.0%> (ø)
..._models/tests/model/material/test_run_reporting.py	100.0% <100.0%> (ø)
message_ix_models/tests/test_util.py	100.0% <100.0%> (ø)
...models/tests/model/material/test_reporter_utils.py	95.8% <95.8%> (ø)
...ssage_ix_models/model/material/report/reporting.py	3.5% <64.2%> (ø)
...e_ix_models/model/material/report/run_reporting.py	53.3% <53.3%> (ø)

... and 7 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[khaeru]

@macflo8 this class replaces the pydantic.BaseModel subclass. As well as doing that:

• I collected configuration-handling logic together with the class. This includes:
  • Logic formerly in load_config() for locating and handling the format of configuration files.
  • Two functions in different modules: reporter_utils.create_var_map_from_yaml_dict() and run_reporting.create_agg_var_map_from_yaml(). These are now closely located with the Config.mapping attribute they are meant to update.
• I added docstrings about the specific data structures that the code expects/can handle, with examples. These should help to maintain the YAML file collection.

test_load_config() still passes; I will monitor CI to see if anything broke. I will also watch for coverage gaps and push ~1 more commit if needed to address those.

[macflo8]

Thanks! The new test_run() integration tests marked with XFAIL still needs some adjustment. So that one is failing atm. Since the function errors out early, it does not cover all remaining lines of run_reporting yet. I need to see if it is possible to reach the codecov target with a few smalll changes.

[khaeru]

I removed the raises=… keyword from this mark; this way the mark matches regardless of the type of exception raised.

[khaeru]

Okay, with a few additional test stubs we are just shy of the Codecov thresholds. I don't see us getting much further without a push to build out more complete fixtures, and we've agreed that is out of scope for this PR.

From my POV then all 3 things from my last review are addressed and this is good to merge. Please let me know if you have anything further to push, otherwise I'll merge.

[macflo8]

Thanks for your contributions and help! I tried to address all other suggestions except for 2 who are not marked as resolved yet. In my view, they can also be tackled in a follow-up PR. I will push one more commit, updating the material docs, since pydantic is still mentioned there and then do the merge.

[khaeru]

The two failing CI jobs appear to be flaky (I have seen similar failures unrelated to the current PR/changes, and they occur only on one OS and not others), so I will merge the PR without waiting for them to complete.