Skip to content

Commit ebd27e7

Browse files
authored
docs: migration guide ecalc 9.6 (#766)
migration guide from 8.20 to 9.6
1 parent 05d079a commit ebd27e7

File tree

4 files changed

+51
-61
lines changed

4 files changed

+51
-61
lines changed

docs/docs/about/migration_guides/v8.26_to_v9.0.md renamed to docs/docs/about/migration_guides/v8.20_to_v9.6.md

Lines changed: 51 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,48 @@
11
---
2-
title: v8.26 to v9.0
3-
description: v8.26 to v9.0 migration
4-
sidebar_position: -12
2+
title: v8.20 to v9.6
3+
description: v8.20 to v9.6 migration
4+
sidebar_position: -11
55
---
66

7-
# v8.26 to v9.0
7+
# Migration guide v8.20 to v9.6
88

9-
In this migration guide you will find:
9+
This migration guide is intended to help you migrate your existing eCalc™ model from version v8.20 to v9.6. The guide
10+
is divided into 3 sections; **v8.22 to v8.23**, **v8.26 to v9.0** and **v9.0 to v9.6**. Make sure to go through the
11+
whole guide to make sure you have updated your model(s) correctly.
1012

11-
1. [YAML changes](#yaml-migration)
13+
## v8.22 to v8.23
1214

13-
## Yaml migration
15+
### 1. Changes to COMPOSITION
16+
- `H2O` is no longer allowed in a fluid composition, `water` should be used instead
1417

15-
### Migration overview
18+
```yaml
19+
MODELS:
20+
- NAME: <name of fluid model, for reference>
21+
TYPE: FLUID
22+
FLUID_MODEL_TYPE: COMPOSITION
23+
EOS_MODEL: <eos model>
24+
COMPOSITION:
25+
# This is old
26+
H2O: <mole fraction>
27+
# This is new
28+
water: <mole fraction>
29+
nitrogen: <mole fraction>
30+
CO2: <mole fraction>
31+
methane: <mole fraction, required>
32+
ethane: <mole fraction>
33+
propane: <mole fraction>
34+
i_butane: <mole fraction>
35+
n_butane: <mole fraction>
36+
i_pentane: <mole fraction>
37+
n_pentane: <mole fraction>
38+
n_hexane: <mole fraction>
39+
```
1640
17-
This doc guides you through migrating an existing eCalc™ model from version v8.26 to v9.0.
1841
19-
We try to make this as easy as possible, and provide a step-by-step migration guide.
42+
## v8.26 to v9.0
43+
44+
### Changes to compressor trains in MODELS
2045
21-
### 1. Changes to compressor trains in MODELS
2246
- `CONTROL_MARGIN` and `CONTROL_MARGIN_UNIT` are now required for `SINGLE_SPEED_COMPRESSOR_TRAIN`, `VARIABLE_SPEED_COMPRESSOR_TRAIN` and `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES`.
2347

2448
An example with new yaml implementation is shown below:
@@ -52,7 +76,8 @@ MODELS:
5276
CALCULATE_MAX_RATE: <Optional compressor train max standard rate [Sm3/day] in result if set to true. Default false. Use with caution. This will increase runtime significantly. >
5377
```
5478

55-
### 2. Changes to simplified compressor trains in MODELS
79+
### Changes to simplified compressor trains in MODELS
80+
5681
- `CONTROL_MARGIN` and `CONTROL_MARGIN_UNIT` are not allowed for `SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN`.
5782

5883
The new yaml implementation is described below, for simplified compressor train model with known compressor stages:
@@ -81,4 +106,17 @@ MODELS:
81106
MAXIMUM_POWER: <Optional constant MW maximum power the compressor train can require>
82107
```
83108
- Simplified compressor trains have to use generic compressor charts
84-
- `SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN` is restricted to generic compressor charts, i.e. the `COMPRESSOR_CHART` must be of type `GENERIC_FROM_INPUT` or `GENERIC_FROM_DESIGN_POINT`. The chart types `SINGLE_SPEED` and `VARIABLE_SPEED` are not allowed anymore.
109+
- `SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN` is restricted to generic compressor charts, i.e. the `COMPRESSOR_CHART` must be of type `GENERIC_FROM_INPUT` or `GENERIC_FROM_DESIGN_POINT`. The chart types `SINGLE_SPEED` and `VARIABLE_SPEED` are not allowed anymore.
110+
111+
## v9.0 to v9.6
112+
113+
### Important Control Margin changes for compressors
114+
115+
* `CONTROL_MARGIN` and `CONTROL_MARGIN_UNIT` are **REQUIRED** for compressors for single compressors and compressor systems.
116+
* `CONTROL_MARGIN` and `CONTROL_MARGIN_UNIT` are **NO LONGER ALLOWED** for simplified compressor trains.
117+
* Simplified trains **HAVE TO USE** generic charts - single speed- and variable speed charts are not allowed.
118+
119+
### Enforcing more unique names
120+
121+
* Fixed a bug where electrical consumers are required to have **UNIQUE** names.
122+
* The following elements **MUST** also have **UNIQUE** names: `MODELS`, `FACILITY_INPUT`, `TIME_SERIES`, `FUEL_TYPES` and `EMISSIONS` names.

docs/docs/about/migration_guides/v8.22_to_v8.23.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/docs/changelog/v8-1.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,3 @@ Some breaking changes are needed to keep improving eCalc, remove ambiguity and p
2929

3030
1. A few columns in LTP export has changed names in order to be compatible with Centuries
3131
2. A new column in LTP export has been introduced: steamTurbineGeneratorConsumption (matching with the new category)
32-
33-
34-
Check out the [migration guide](../about/migration_guides/v8_to_v81)

0 commit comments

Comments
 (0)