Skip to content

Commit

Permalink
Update doc/reporting
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru committed Sep 1, 2023
1 parent e16b630 commit baa5383
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions doc/reporting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,23 +146,26 @@ Their documentation is repeated below for convenience.
configure


:meth:`ixmp.Reporter.from_scenario <ixmp.reporting.Reporter.from_scenario>` automatically adds keys based on the contents of the :class:`.Scenario` argument.
:meth:`ixmp.Reporter.from_scenario <ixmp.reporting.Reporter.from_scenario>` automatically adds keys based on the contents of the :class:`.Scenario` argument;
that is, every :mod:`ixmp` set, parameter, variable, and equation available in the Scenario.
:meth:`message_ix.Reporter.from_scenario <.Reporter.from_scenario>` extends this to add additional keys for derived quantities specific to the MESSAGEix model framework.
These include:

- ``out`` - ``output`` × ``ACT``; that is, the product of ``output`` (output efficiency) and ``ACT`` (activity)
.. tip:: Use :meth:`~.Computer.full_key` to retrieve the full-dimensionality :class:`Key` for any of these quantities.

- ``out`` = ``output`` × ``ACT``; that is, the product of ``output`` (output efficiency) and ``ACT`` (activity)
- ``out_hist`` = ``output`` × ``ref_activity`` (historical reference activity)
- ``in`` = ``input`` × ``ACT``
- ``in_hist`` = ``input`` × ``ref_activity``
- ``emi`` = ``emission_factor`` × ``ACT``
- ``emi_hist`` = ``emission_factor`` × ``ref_activity``
- ``inv`` = ``inv_cost`` × ``CAP_NEW``
- ``inv_hist`` = ``inv_cost`` × ``ref_new_capacity``
- ``fom`` = ``fix_cost`` × ``CAP``
- ``fom`` = ``fix_cost`` × ``CAP``; the name refers to "Fixed Operation and Maintenance costs"
- ``fom_hist`` = ``fix_cost`` × ``ref_capacity``
- ``vom`` = ``var_cost`` × ``ACT``
- ``vom`` = ``var_cost`` × ``ACT``; "Variable Operation and Maintenance costs"
- ``vom_hist`` = ``var_cost`` × ``ref_activity``
- ``tom`` = ``fom`` + ``vom``
- ``tom`` = ``fom`` + ``vom``; "Total Operation and Maintenance costs"
- ``land_out`` = ``land_output`` × ``LAND``
- ``land_use_qty`` = ``land_use`` × ``LAND``
- ``land_emi`` = ``land_emission`` × ``LAND``
Expand All @@ -174,8 +177,6 @@ These include:
- ``addon potential`` = ``addon up`` × ``addon ACT``, the maximum potential activity by add-on technology.
- ``price emission``, the model variable ``PRICE_EMISSION`` broadcast across emission species (`e`) *and* technologies (`t`) rather than types (`type_emission`, `type_tec`).

.. tip:: Use :meth:`~.Computer.full_key` to retrieve the full-dimensionality :class:`Key` for any of these quantities.

Other added keys include:

- :mod:`message_ix` adds the standard short symbols for |MESSAGEix| dimensions (sets) based on :data:`DIMS`.
Expand Down Expand Up @@ -216,17 +217,13 @@ These automatic contents are prepared using:

.. autosummary::
add
add_file
add_product
add_queue
add_single
aggregate
apply
check_keys
configure
convert_pyam
describe
disaggregate
eval
finalize
from_scenario
full_key
Expand All @@ -237,6 +234,13 @@ These automatic contents are prepared using:
visualize
write

.. autosummary::
add_file
add_product
aggregate
convert_pyam
disaggregate


.. autodata:: DERIVED
.. autodata:: DIMS
Expand Down Expand Up @@ -273,7 +277,7 @@ Computations
~ixmp.reporting.computations.store_ts
~ixmp.reporting.computations.update_scenario

…and by :mod:`genno.computation` and its compatibility modules. See the package documentation for details.
…and by :mod:`genno.computations` and its compatibility modules. See the package documentation for details.

.. autosummary::
~genno.compat.plotnine.Plot
Expand All @@ -284,21 +288,26 @@ Computations
~genno.computations.broadcast_map
~genno.computations.combine
~genno.computations.concat
~genno.computations.disaggregate_shares
~genno.computations.div
~genno.computations.drop_vars
~genno.computations.group_sum
~genno.computations.index_to
~genno.computations.interpolate
~genno.computations.load_file
~genno.computations.mul
~genno.computations.pow
~genno.computations.ratio
~genno.computations.relabel
~genno.computations.rename_dims
~genno.computations.round
~genno.computations.select
~genno.computations.sub
~genno.computations.sum
~genno.computations.write_report

.. autosummary::
~genno.computations.disaggregate_shares
~genno.computations.product
~genno.computations.ratio

Utilities
---------
Expand Down

0 comments on commit baa5383

Please sign in to comment.