docs: update changelog and migration guide (#509)

* docs: update changelog and migration guide

docs/docs/about/migration_guides/v8.15_to_v8.16.md

@@ -0,0 +1,36 @@
+---
+title: v8.15 to v8.16
+description: v8.15 to v8.16 migration
+sidebar_position: 10
+---
+
+# v8.15 to v8.16
+
+In this migration guide you will find:
+
+1. [YAML changes](#yaml-migration)
+
+## Yaml migration
+
+### 1. Changes in unit-format for venting emitters
+- New unit-format for venting emitters, aligned to what is used in other parts of yaml-file.
+
+The new yaml implementation is described below:
+
+Previously the format looked like this: 
+~~~~yaml
+RATE:
+  VALUE: 2
+  # This is old
+  UNIT: kg/d
+  TYPE: STREAM_DAY
+~~~~
+
+The new format is: 
+~~~~yaml
+RATE:
+  VALUE: 2
+  # This is new
+  UNIT: KG_PER_DAY
+  TYPE: STREAM_DAY
+~~~~

docs/docs/about/references/keywords/EMISSIONS.md

@@ -43,8 +43,9 @@ EMISSIONS:
     FACTOR: 2.5  # [kg/Sm3]
 ~~~~~~~~
 
-## For venting emitters (type: DIRECT_EMISSION)
+## For venting emitters (type: DIRECT_EMISSION, from eCalc v8.13)
 Note that the emission name is case-insensitive.
+The keywords [NAME](/about/references/keywords/NAME.md) and [RATE](/about/references/keywords/RATE.md) are required.
 
 ### Format
 ~~~~~~~~yaml
@@ -68,8 +69,9 @@ EMISSIONS:
       UNIT: kg/d
       TYPE: STREAM_DAY
 ~~~~~~~~
-## For venting emitters (type: OIL_VOLUME)
+## For venting emitters (type: OIL_VOLUME, from eCalc v8.13)
 Note that the emission name is case-insensitive.
+The keywords [NAME](/about/references/keywords/NAME.md) and `EMISSION_FACTOR` are required.
 
 ### Format
 ~~~~~~~~yaml

docs/docs/about/references/keywords/RATE.md

@@ -43,21 +43,28 @@ RATE: SIM1:GAS_PROD
         ...
 ~~~~~~~~
 
-## Use in EMISSION for VENTING_EMITTERS (from eCalc v8.8)
-The attribute `VALUE` is required, while `UNIT` and `TYPE` are optional. Allowed values for
-`UNIT` are kg/d and t/d, while STREAM_DAY and CALENDAR_DAY are valid for `TYPE`.
+## Use in EMISSIONS for VENTING_EMITTERS (from eCalc v8.8)
+The keywords `VALUE` and [CATEGORY](/about/references/keywords/CATEGORY.md) are required, while [UNIT](/about/references/keywords/UNIT.md) and [TYPE](/about/references/keywords/TYPE.md) are optional. 
 
+For venting emitters of `TYPE` `DIRECT_EMISSION` (from eCalc v8.13):
+Allowed values for `UNIT` are KG_PER_DAY and TONS_PER_DAY, while STREAM_DAY and CALENDAR_DAY are valid for `TYPE`.
+
+For venting emitters of `TYPE` `OIL_VOLUME` (from eCalc v8.13):
+Only allowed value for `UNIT` is SM3_PER_DAY
+
+Example with venting emitter of `TYPE` `DIRECT_EMISSION`:
 ### Format
 ~~~~~~~~yaml
 VENTING_EMITTERS:
   - NAME: <emitter name>
     CATEGORY: <category>
-    EMISSION:
-      NAME: <emission name>
-      RATE:
-        VALUE: <emission rate>
-        UNIT: <emission rate unit, default kg/d>
-        TYPE: <emission rate type, default STREAM_DAY>
+    TYPE: <emission type>
+    EMISSIONS:
+      - NAME: <emission name>
+        RATE:
+          VALUE: <emission rate>
+          UNIT: <emission rate unit, default KG_PER_DAY>
+          TYPE: <emission rate type, default STREAM_DAY>
 ~~~~~~~~
 
 
@@ -67,10 +74,11 @@ VENTING_EMITTERS:
 VENTING_EMITTERS:
   - NAME: SomeVentingEmitter
     CATEGORY: COLD-VENTING-FUGITIVE
-    EMISSION:
-      NAME: CH4
-      RATE:
-        VALUE: 4
-        UNIT: kg/d
-        TYPE: STREAM_DAY
+    TYPE: DIRECT_EMISSION
+    EMISSIONS:
+      - NAME: CH4
+        RATE:
+          VALUE: 4
+          UNIT: KG_PER_DAY
+          TYPE: STREAM_DAY
 ~~~~~~~~

docs/docs/about/references/keywords/UNIT.md

@@ -0,0 +1,33 @@
+# UNIT
+
+## Description
+
+`UNIT` is a keyword that can be specified for:
+- [VENTING_EMITTERS](/about/references/keywords/VENTING_EMITTERS.md) - [EMISSIONS](/about/references/keywords/EMISSIONS.md) - [RATE](/about/references/keywords/RATE.md) or
+- [VENTING_EMITTERS](/about/references/keywords/VENTING_EMITTERS.md) - [VOLUME](/about/references/keywords/VOLUME.md) - [RATE](/about/references/keywords/RATE.md)
+
+## Format
+Venting emitter of [TYPE](/about/references/keywords/TYPE.md) `DIRECT_EMISSION`:
+~~~~yaml
+RATE:
+  VALUE: <emission rate>
+  UNIT: <emission rate unit, KG_PER_DAY (default), TONS_PER_DAY are supported units>
+  TYPE: <emission rate type, default STREAM_DAY>
+~~~~
+
+Venting emitter of [TYPE](/about/references/keywords/TYPE.md) `OIL_VOLUME`: 
+~~~~yaml
+RATE:
+  VALUE: <emission rate>
+  UNIT: <emission rate unit, SM3_PER_DAY is only supported unit>
+  TYPE: <emission rate type, default STREAM_DAY>
+~~~~
+
+## Example 
+TYPE: DIRECT_EMISSION
+~~~~yaml
+RATE:
+  VALUE: 2
+  UNIT: KG_PER_DAY
+  TYPE: STREAM_DAY
+~~~~

docs/docs/changelog/v8-15.md

@@ -1,9 +1,9 @@
 ---
 slug: v8.15-release
-title: v8.15 (Latest)
+title: v8.15
 authors: ecalc-team
 tags: [release, eCalc]
-sidebar_position: -1001
+sidebar_position: -24
 ---
 
 # eCalc

docs/docs/changelog/v8-16.md

@@ -0,0 +1,31 @@
+---
+slug: v8.16-release
+title: v8.16 (Latest)
+authors: ecalc-team
+tags: [release, eCalc]
+sidebar_position: -1001
+---
+
+# eCalc
+
+## Breaking Changes
+- New unit-format for venting emitters, aligned to what is used in other parts of yaml-file. Example: Example: Unit should be now be written as KG_PER_DAY, and not kg/d.
+
+## New Features
+- Make electrical- and mechanical available at asset level. This is needed to make plots split by mechanical- and electrical power in web (will be implemented in future version).
+- Make venting emitters emission names case insensitive: Avoid splitting same emission-types into separate ones, due to different use of upper- and lower case.
+
+## Bug Fixes
+- Detect duplicate keys in yaml file and raise error, pointing to where in the yaml-file the error occurs.
+- Do not allow for negative recirculation if rate is above max flow rate for a compressor chart. If the compressor stage is out of capacity already, the available capacity is set to zero.
+- Ensure regularity is evaluated for all installations when only venting emitters. eCalc failed if only `VENTING_EMITTERS` were specified (without `FUELCONUMERS` and `GENERATORSETS`), because installation results were empty. This fix ensures to get results, and to evaluate regularity, even if the installation results are empty.
+- Max power from shore values: Output values did not correspond to input in LTP-report, when output frequency is set to e.g. `YEAR`. This is now fixed.
+- Use custom type pydantic class to wrap ndarray and avoid validation problem: This fix removes potentially confusing warning in the validation.
+- Wrong unit max power from shore: The unit for `Max Usage from Shore column` in LTP-report was GWh, but is now correctly reported as MW.
+
+## Documentation
+- Add `MAXIMUM_POWER` to eCalc yaml-keyword list.
+- Fix typos.
+- Modify changelog order.
+- Update description of `VENTING_EMITTERS`.
+