Skip to content

[FEATURE] Rename Effect domains #308

@FBumann

Description

@FBumann

Prerequisite Checks

  • I have searched the existing issues and confirmed this feature doesn't already exist.

  • I have checked the documentation to ensure this feature isn't already available.

Is your feature request related to a problem?

No response

Describe the solution you'd like

I would like to have the Effect domains named a bit more generic than they are right now.
Currently, each Effect has the following domains, with associated Variables (here with name "Effect"):
invest

  • Effect(invest)|total

operation

  • Effect(operation)|total
  • Effect(operation)|total_per_timestep

And as a sum of Effect(invest)|total + Effect(operation)|total
Effect|total

The split into operation and invest might be nice in many cases, but it feels restrictive in others.

I would prefer to emphazise the resolution instead of the origin of the effects (This should be done by the name instead)

I would propose the following:

Rename operation to temporal

  • Effects that vary across the time dimension
  • Effect(temporal) - cumulative total across all timesteps
  • Effect(temporal)|per_timestep - total from all sources per timestep

Rename invest to periodic

  • Effects that apply to periods (annual, monthly, quarterly costs) but don't have a time dimension
  • Effect(periodic) - total effects per period

Remove |total suffix

  • The base variable naturally represents the total/cumulative amount
  • Only use suffixes for variants like per_timestep

This would us leave with:
periodic

  • Effect(periodic)

temporal

  • Effect(temporal)
  • Effect(temporal)|per_timestep

total

  • Effect

Please leave your thoughts

This issue is in Progress

Energy System Use Case

This issue is in Progress

Desired Code Example (optional)

Component Category (if applicable)

None

Alternatives considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    changeChanging behavior, naming, ... without adding functionalitydiscussIdeas or bringing up confusing things.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions