Skip to content

Commit

Permalink
chore(docs): update docusaurus to v3
Browse files Browse the repository at this point in the history
  • Loading branch information
jsolaas committed Feb 2, 2024
1 parent a9cca9e commit 8065c52
Show file tree
Hide file tree
Showing 60 changed files with 11,317 additions and 15,831 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Get started

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.

In order to edit the docs you need either [NodeJS (recommended)](https://nodejs.org/en/download/) together with
the package manager [npm]. See [local development](#local-development) for details on how to get started with local development.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/about/modelling/setup/facility_inputs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ There are four categories of data that can be used here:
- Other energy consuming equipment modeled variable w.r.t. reservoir management
(tabulated relationship between variables and consumption)

eCalc™ supports making simple adjustments to a table by using the [ADJUSTMENT](/about/references/keywords/ADJUSTMENT.mdx)
eCalc™ supports making simple adjustments to a table by using the [ADJUSTMENT](/about/references/keywords/ADJUSTMENT.md)
keyword as well as modification of the [HEAD_MARGIN](/about/references/keywords/HEAD_MARGIN.md)
which can be used while calibrating pump charts.

Expand Down
5 changes: 2 additions & 3 deletions docs/docs/about/references/keywords/DIRECT_EMITTERS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# DIRECT_EMITTERS
<span className="major-change-deprecation"> Deprecated from eCalc v8.7 (changed name to <strong>VENTING_EMITTERS</strong>).
<span className="major-change-deprecation">
Deprecated from eCalc v8.7 (changed name to <strong>VENTING_EMITTERS</strong>).
</span>
&nbsp;



[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) /
Expand Down
5 changes: 3 additions & 2 deletions docs/docs/about/references/keywords/EMISSION.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# EMISSION
<span className="major-change-new-feature"> New keyword from eCalc v8.8!
<span className="major-change-new-feature">
New keyword from eCalc v8.8!
</span>
<br></br>
<br/>

[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) /
[VENTING_EMITTERS](/about/references/keywords/VENTING_EMITTERS.md)
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/about/references/keywords/EMISSION_NAME.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# EMISSION_NAME
<span className="major-change-deprecation"> Deprecated from eCalc v8.8 (is included in <strong>EMISSION</strong>).
<span className="major-change-deprecation">
Deprecated from eCalc v8.8 (is included in <strong>EMISSION</strong>).
</span>
<br></br>

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/about/references/keywords/EMISSION_RATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# EMISSION_RATE
<span className="major-change-deprecation"> Deprecated from eCalc v8.8 (is included in <strong>EMISSION</strong>).
<span className="major-change-deprecation">
Deprecated from eCalc v8.8 (is included in <strong>EMISSION</strong>).
</span>
<br></br>

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/about/references/keywords/EMITTER_MODEL.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# EMITTER_MODEL
<span className="major-change-deprecation"> Deprecated from eCalc v8.8 (replaced by <strong>EMISSION</strong>).
<span className="major-change-deprecation">
Deprecated from eCalc v8.8 (replaced by <strong>EMISSION</strong>).
</span>
<br></br>

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/about/references/keywords/VENTING_EMITTERS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# VENTING_EMITTERS

<span className="major-change-new-feature"> New definition of VENTING_EMITTERS from eCalc v8.8!
<span className="major-change-new-feature">
New definition of VENTING_EMITTERS from eCalc v8.8!
</span>
<br></br>

Expand Down
15 changes: 10 additions & 5 deletions docs/docs/changelog/v7-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ sidebar_position: 3

Alternatively you could merge the conditions to a single expression. This is what is done automatically when using the [CONDITIONS](../about/references/keywords/CONDITIONS) keyword.

.. code-block:: diff
```yaml
# This is new
CONDITION: expression1 {*} expression2
# This is old
CONDITION:
# This is old
- expression1
# This is old
- expression2
```
+ CONDITION: expression1 {*} expression2
- CONDITION:
- - expression1
- - expression2
## *Fixes*
Expand Down
26 changes: 14 additions & 12 deletions docs/docs/changelog/v7-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,20 @@ sidebar_position: 4

* Add new [CATEGORY](../about/references/keywords/CATEGORY) with name *OFFSHORE-WIND* to report power usage from offshore windfarms. Should be negative load to deduct from genset, if what is supplied externally. Also added to `LTP Reporting`. See excerpt example below:

.. code-block:: yaml

```yaml
- NAME: wind_turbine
CATEGORY: OFFSHORE-WIND
ENERGY_USAGE_MODEL:
TYPE: DIRECT
LOAD: -4.4 # MW
TYPE: DIRECT
LOAD: -4.4 # MW
```
* Add new [CATEGORY](../about/references/keywords/CATEGORY) with name *TURBINE-GENERATOR* and *POWER-FROM-SHORE* to report power consumption separately from installation and onshore (land) for generators. If not set,
defaults to *TURBINE-GENERATOR*. See excerpt example below:
.. code-block:: yaml

```yaml
GENERATORSETS:
- NAME: genset
CATEGORY: TURBINE-GENERATOR
Expand All @@ -36,17 +37,18 @@ sidebar_position: 4
CATEGORY: POWER-FROM-SHORE
ELECTRICITY2FUEL: onshore_power
...
```

where *electricity2fuel* for onshore power in general would have power map to 0 fuel usage

* Add new [CATEGORY](../about/references/keywords/CATEGORY) with name *GAS-DRIVEN-COMPRESSOR* to report power consumption for gas(-turbine)-driven compressors for LTP. Also added to `LTP Reporting`. See excerpt example below:

.. code-block:: yaml

```yaml
- NAME: gascompression_2
CATEGORY: GAS-DRIVEN-COMPRESSOR
ENERGY_USAGE_MODEL:
TYPE: COMPRESSOR
```

* Allow single speed and variable speed compressor train to run with zero pressure and non-zero rate. Will raise warning, and affected time steps will not be calculated, but eCalc will run.
* Add a *POWER* column data to the *COMPRESSOR_TABULAR* csv-file for a fuel-driven *SAMPLED_COMPRESSOR* in order to also get energy reported as power (MW). See `Header requirements for the sampled compressor csv file`
Expand All @@ -55,18 +57,18 @@ where *electricity2fuel* for onshore power in general would have power map to 0
* Bug in max rate calculation for simplified compressor train. Wrong convergence criterion leading to too early exit from iteration.
* VARIABLES can be specified in yaml and referred to in expressions.

.. code-block:: yaml

```yaml
VARIABLES:
salt_water_injection:
VALUE: SIM1:COL1 {*} 2
```

Use this variable by referencing it as `$var.salt_water_injection` in an
expression.

.. code-block:: yaml

```yaml
EXPRESSION: "$var.salt_water_injection {/} 2"
```

See [VARIABLES](../about/references/keywords/VARIABLES) for more information.

Expand Down
25 changes: 13 additions & 12 deletions docs/docs/changelog/v7-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,19 @@ sidebar_position: 5
has been introduced for Generator sets for users to be able to set this to generator sets that do not apply to other categories,
and to e.g. except for LTP output.

.. code-block:: yaml

GENERATORSETS:
- NAME: genset
CATEGORY: TURBINE-GENERATOR
ELECTRICITY2FUEL: A_genset
...
...
- NAME: power_from_shore
CATEGORY: POWER-FROM-SHORE
ELECTRICITY2FUEL: onshore_power
...
```yaml
GENERATORSETS:
- NAME: genset
CATEGORY: TURBINE-GENERATOR
ELECTRICITY2FUEL: A_genset
...
...
- NAME: power_from_shore
CATEGORY: POWER-FROM-SHORE
ELECTRICITY2FUEL: onshore_power
...
```


* EXPERIMENTAL: Add show results command to cli.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/changelog/v7-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ sidebar_position: 7

* **BREAKING CHANGE!**: When specifying a stage in a VariableSpeedCompressorTrainCommonShaftMultipleStreamsAndPRessures, the STREAM yaml keyword has been changed from a string to a list, to allow for multiple streams entering or leaving the compressor train at the same stage.

.. code-block:: yaml

```yaml
STAGES:
- INLET_TEMPERATURE: <inlet temperature in Celsius for stage>
COMPRESSOR_CHART: <reference to a compressor chart model defined in MODELS>
STREAM: <Optional>
- <reference stream from STREAMS for one in- or outgoing stream. Optional>
- <reference stream from STREAMS for another in- or outgoing stream. Optional>
```
* **BREAKING CHANGE!**: A CONSUMER with a CONSUMER_SYSTEM. Mixing between SYSTEM and non-system is no longer supported.
Expand Down
150 changes: 0 additions & 150 deletions docs/docusaurus.config.js

This file was deleted.

Loading

0 comments on commit 8065c52

Please sign in to comment.