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.

Sign up for GitHub

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

Jump to bottom

docs: update docs and changelog for energy models #133

Merged
merged 1 commit into from
Aug 2, 2023
Merged

docs: update docs and changelog for energy models #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions docs/docs/about/references/keywords/ENERGY_USAGE_MODEL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,8 @@ on the calculated energy usage after the calculated energy usage from the model

## Temporal energy usage model

It is possible to change the energy model within a consumer over time. It is highly recommended that the
`ENERGY_USAGE_MODEL` stays within one type. TYPE evolution, while supported, may create challenges when interpreting
the results. In this case, if possible, we recommend that you split the model into two [CONSUMERS](CONSUMERS.md).
It is possible to update the energy model within a consumer over time, as long as the
`ENERGY_USAGE_MODEL` stays within one type. The `TYPE` cannot change over time. In case `TYPE` evolution is needed, we recommend that you split the model into two [CONSUMERS](CONSUMERS.md).

~~~~~~~~yaml
ENERGY_USAGE_MODEL:
Expand Down
8 changes: 7 additions & 1 deletion docs/docs/changelog/v8-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,10 @@ the migration guide for details on changes, where relevant.


## Fixes
- A bug in the mixing of fluid-streams in compressor trains were fixed. This bug caused the density at standard conditions not to be updated, leading to the standard rates being wrong. This is expected to change the results of some eCalc Models
- A bug in the mixing of fluid-streams in compressor trains were fixed. This bug caused the density at standard conditions not to be updated, leading to the standard rates being wrong. This is expected to change the results of some eCalc Models

## Breaking changes
Some breaking changes are needed to keep improving eCalc, remove ambiguity and prepare eCalc for the future:

### Input: YAML / Resource files
1. It is no longer accepted to change ENERGY_USAGE_MODEL TYPE over time, within one consumer. In case TYPE evolution is needed, the model can be split in two consumers.