Skip to content

Improved Documentation for Operational time structures #100

Closed

Description

@danareu

Issue: When using the Operational Time Structure, the output variables are not weighted by the probabilities assigned to each period. This behavior is expected and not a bug, but it is not documented anywhere. Users encountering this output for the first time could easily assume the values are probability-weighted, leading to misinterpretation of results.

Suggestion: Add a note to the documentation clarifying that Operational Time Structure output variables are the unweighted variables.

Activity

  1. JulStraus commented on Aug 26, 2026

    @JulStraus
    Member

    We do have to a certain degree a description within the documentation. However, this description is not entirely exhaustive with respect to the different potential time structures.

    My thought process would be to extend the second box with the information related to OperationalScenarios and to describe this more generic. Does that sound reasonable to you @danareu?

  2. self-assigned this
    on Aug 26, 2026
  3. danareu commented on Aug 26, 2026

    @danareu
    Author

    @JulStraus This sounds good to me.

  4. JulStraus commented on Sep 16, 2026

    @JulStraus
    Member

    @danareu: Could you please check #101 if it is sufficiently clear?

  5. danareu commented on Sep 28, 2026

    @danareu
    Author

    @JulStraus It looks good! The example is also great for understanding how it works in practice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions