Skip to content
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

docs: explain how ecalc handles time #639

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

olelod
Copy link
Contributor

@olelod olelod commented Oct 4, 2024

Thought it would be a good idea to add some information about how eCalc interprets what is given as input.

Will add more text and probably some plots to give examples.

Have you remembered and considered?

  • I have remembered to update documentation
  • I have remembered to update manual changelog (docs/docs/changelog/next.md)
  • I have remembered to update migration guide (docs/docs/migration_guides/)
  • I have committed with BREAKING: in footer or ! in header, if breaking
  • I have added tests (if not, comment why)
  • I have used conventional commits syntax (if you squash, make sure that conventional commit is used)
  • I have included the Jira issue ID somewhere in the commit body (ECALC-XXXX)

Why is this pull request needed?

This pull request is needed because of....

What does this pull request change?

Write summary of what this pull request changes if needed.

Issues related to this change:

@olelod olelod force-pushed the docs-how-ecalc-handles-time branch from b9b7cd7 to d65fb04 Compare November 29, 2024 10:12
# Time periods in eCalc™
eCalc™ does calculations between a global start date and a global end date. This global time period will be split into
many smaller time periods, where each of them follow immediately after each other, based on other dates encountered in
the YAML file and in the various time series resource files.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Give/illustrate with some examples?

date, respectively.

:::note
Any dates defined in the YAML file (e.g. in [ENERGY_USAGE_MODEL](/about/references/ENERGY_USAGE_MODEL.md)) will not
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume we check this, do we give warning or error if this is the case?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants