Skip to content

Fix inconsistencies in docs of special time slice value Year #702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/time.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Time slices
The ``time`` set is used to index parameter dimensions with the names "time", "time_origin", "time_dest", etc.
These are variously referred to as “(sub-annual) time slices”, “time steps”, or other names.
Elements in this set are labels for **portions of a single year**.
The special value ``'year'`` represents the entire year.
The special value ``'Year'`` represents the entire year.

Since a ``year`` element refers to the representative, final year within a period, using ``year`` and ``time`` together denotes *a portion of that specific year*.

Expand All @@ -55,22 +55,22 @@ Example 4

Duration of sub-annual time slices
----------------------------------
The duration of each sub-annual time slice should be defined relative to the whole year, with a value between 0 and 1, using parameter ``duration_time``.
The duration of each sub-annual time slice should be defined relative to the whole year, with a value between 0 and 1, using the parameter ``duration_time``.
For example, in a model with four seasons with the same length, ``duration_time`` of each season will be 0.25.
Please note that the duration of time slices does not need to be equal to each other.
This information is needed to calculate capacity of a technology that is active in different time slices.
Time slices can be represented at different temporal levels, using sets ``lvl_temporal`` and ``map_temporal_hierarchy``.
This helps introducing a flexible temporal resolution, e.g., by representing some technologies at finer time resolution while others at ``year``.
Time slices can be represented at different temporal levels, using the sets ``lvl_temporal`` and ``map_temporal_hierarchy``.
This helps introducing a flexible temporal resolution, e.g., by representing some technologies at finer time resolution while others at ``Year``.
When there are more than one temporal levels, e.g., "year", "season", "month", "day", etc., ``duration_time`` is defined for time slices at each **temporal level** separately.
The sum of ``duration_time`` of time slices at each temporal level must be equal to 1.
For example, in a model with 4 time slices as "season" and 10 time slices as "day" under each "season", ``duration_time`` of each "season" and "day" can be specified as 0.25 and 0.025, respectively.

By default, the unit of ``ACT`` is treated per year in the GAMS formulation for different time slices.
This means values reported in time slice "year" and "month" both have the same unit (e.g., GWa).
This means values reported in time slice "Year" and "month" both have the same unit (e.g., GWa).
However, the user can report the values across parameters and variables with different units relative to the length of the full year.
For example, the user can report ``ACT`` in units of "GWa" and "GWh" for time slices of "year" and "hour", respectively, in the same model.
For example, the user can report ``ACT`` in units of "GWa" and "GWh" for time slices of "Year" and "hour", respectively, in the same model.
To activate this feature, the parent time slice for which the relative units are desired should be specified by set ``time_relative``.
This will ensure that parameter ``duration_time_rel`` is effective.
This will ensure that parameter ``duration_time_rel`` is effective.
Otherwise, this parameter is filled by value of 1, meaning that the units will be treated uniformly across different sub-annual time slices.

Discounting
Expand Down
2 changes: 1 addition & 1 deletion message_ix/model/MESSAGE/parameter_def.gms
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
* - ``year``
* - Discount factor of the last year in the period [#df_auto]_
*
* .. [#duration_time_year] The element 'year' in the set of subannual time slices ``time`` has the value of 1.
* .. [#duration_time_year] The element 'Year' in the set of subannual time slices ``time`` has the value of 1.
* This value is assigned by default when creating a new :class:`ixmp.Scenario` based on the ``MESSAGE`` scheme.
*
* .. [#short_dur] The short-hand notation :math:`|y|` is used for the parameters :math:`duration\_period_y`
Expand Down