Skip to content

Commit

Permalink
Add note in docs about combinations of year vintage-year actual in ou…
Browse files Browse the repository at this point in the history
…tput
  • Loading branch information
measrainsey committed Oct 21, 2024
1 parent ecb3497 commit 70db1b2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api/tools-costs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==============

Expand Down

0 comments on commit 70db1b2

Please sign in to comment.