From 70db1b2e0dc0113218edbfe8df40c0a4b97b16e3 Mon Sep 17 00:00:00 2001 From: Measrainsey Meng Date: Mon, 21 Oct 2024 12:10:00 +0200 Subject: [PATCH] Add note in docs about combinations of year vintage-year actual in output --- doc/api/tools-costs.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/tools-costs.rst b/doc/api/tools-costs.rst index 4ab2c6edc..be9de6ad1 100644 --- a/doc/api/tools-costs.rst +++ b/doc/api/tools-costs.rst @@ -148,6 +148,11 @@ These data can be further manipulated; for instance, added to a scenario using : See the file :file:`message_ix_models/tools/costs/demo.py` for multiple examples using various non-default settings to control the methods and data used by :func:`.create_cost_projections`. +.. note:: The data produced are for all valid combinations of :math:`(y^V, y^A)`—including those that are beyond the `technical_lifetime` of the |t| to which they apply. + This may produce large data frames, depending on the number of technologies, regions, and scenarios. + At the moment, :mod:`.tools.costs` does not filter out these combinations. + If this is problematic, the user may consider filtering the data for valid combinations of :math:`(y^V, y^A)`. + Code reference ==============