docs: migration guide ecalc 9.6 (#766)

migration guide from 8.20 to 9.6

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

@@ -1,24 +1,48 @@
 ---
-title: v8.26 to v9.0
-description: v8.26 to v9.0 migration
-sidebar_position: -12
+title: v8.20 to v9.6
+description: v8.20 to v9.6 migration
+sidebar_position: -11
 ---
 
-# v8.26 to v9.0
+# Migration guide v8.20 to v9.6
 
-In this migration guide you will find:
+This migration guide is intended to help you migrate your existing eCalc™ model from version v8.20 to v9.6. The guide
+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
+whole guide to make sure you have updated your model(s) correctly.
 
-1. [YAML changes](#yaml-migration)
+## v8.22 to v8.23
 
-## Yaml migration
+### 1. Changes to COMPOSITION
+- `H2O` is no longer allowed in a fluid composition, `water` should be used instead 
 
-### Migration overview
+```yaml 
+MODELS:
+- NAME: <name of fluid model, for reference>
+  TYPE: FLUID
+  FLUID_MODEL_TYPE: COMPOSITION
+  EOS_MODEL: <eos model>
+  COMPOSITION:
+    # This is old
+    H2O: <mole fraction>
+    # This is new
+    water: <mole fraction>
+    nitrogen: <mole fraction>
+    CO2: <mole fraction>
+    methane: <mole fraction, required>
+    ethane: <mole fraction>
+    propane: <mole fraction>
+    i_butane: <mole fraction>
+    n_butane: <mole fraction>
+    i_pentane: <mole fraction>
+    n_pentane: <mole fraction>
+    n_hexane: <mole fraction>
+```
 
-This doc guides you through migrating an existing eCalc™ model from version v8.26 to v9.0.
 
-We try to make this as easy as possible, and provide a step-by-step migration guide.
+## v8.26 to v9.0
+
+### Changes to compressor trains in MODELS
 
-### 1. Changes to compressor trains in MODELS
 - `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`.
 
 An example with new yaml implementation is shown below:
@@ -52,7 +76,8 @@ MODELS:
     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. >
 ```
 
-### 2. Changes to simplified compressor trains in MODELS
+### Changes to simplified compressor trains in MODELS
+
 - `CONTROL_MARGIN` and `CONTROL_MARGIN_UNIT` are not allowed for `SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN`.
 
 The new yaml implementation is described below, for simplified compressor train model with known compressor stages:
@@ -81,4 +106,17 @@ MODELS:
     MAXIMUM_POWER: <Optional constant MW maximum power the compressor train can require>
 ```
 - Simplified compressor trains have to use generic compressor charts
-  - `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.
+  - `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.
+
+## v9.0 to v9.6
+
+### Important Control Margin changes for compressors
+
+* `CONTROL_MARGIN` and `CONTROL_MARGIN_UNIT` are **REQUIRED** for compressors for single compressors and compressor systems.
+* `CONTROL_MARGIN` and `CONTROL_MARGIN_UNIT` are **NO LONGER ALLOWED** for simplified compressor trains.
+* Simplified trains **HAVE TO USE** generic charts - single speed- and variable speed charts are not allowed.
+
+### Enforcing more unique names
+
+* Fixed a bug where electrical consumers are required to have **UNIQUE** names.
+* The following elements **MUST** also have **UNIQUE** names: `MODELS`, `FACILITY_INPUT`, `TIME_SERIES`, `FUEL_TYPES` and `EMISSIONS` names.

docs/docs/changelog/v8-1.md

@@ -29,6 +29,3 @@ Some breaking changes are needed to keep improving eCalc, remove ambiguity and p
 
 1. A few columns in LTP export has changed names in order to be compatible with Centuries
 2. A new column in LTP export has been introduced: steamTurbineGeneratorConsumption (matching with the new category)
-
-
-Check out the [migration guide](../about/migration_guides/v8_to_v81)