From 35c4f6853c9452d1963daf321cce3e2ebe087f9e Mon Sep 17 00:00:00 2001 From: Kristin Solbakken Date: Mon, 2 Oct 2023 13:09:30 +0200 Subject: [PATCH] fix: use file reference instead of urls in docs (#216) --- CONTRIBUTING.md | 2 +- README.md | 6 +-- docs/docs/about/getting_started/cli/index.md | 2 +- docs/docs/about/getting_started/index.md | 10 ++--- .../about/getting_started/library/index.md | 2 +- docs/docs/about/getting_started/yaml/index.md | 6 +-- docs/docs/about/index.md | 2 +- .../docs/about/modelling/examples/advanced.md | 36 ++++++++--------- docs/docs/about/modelling/examples/drogon.md | 4 +- docs/docs/about/modelling/examples/index.md | 6 +-- docs/docs/about/modelling/examples/simple.md | 22 +++++----- .../facility_inputs/generator_modelling.md | 2 +- .../modelling/setup/facility_inputs/index.md | 18 ++++----- .../facility_inputs/pump_modelling/index.md | 2 +- .../pump_modelling/pump_charts.md | 2 +- .../sampled_compressor_model.md | 2 +- .../setup/facility_inputs/tabular.md | 10 ++--- .../file_format_and_syntax/expressions.md | 4 +- .../setup/file_format_and_syntax/index.md | 24 +++++------ docs/docs/about/modelling/setup/fuel_types.md | 12 +++--- docs/docs/about/modelling/setup/index.md | 16 ++++---- .../compressor.md | 8 ++-- .../compressor_system.md | 12 +++--- .../index.md | 2 +- ...del_with_multiple_streams_and_pressures.md | 12 +++--- .../generator_sets_in_calculations.md | 40 +++++++++---------- .../modelling/setup/installations/index.md | 26 ++++++------ .../pump_models_in_calculations.md | 6 +-- .../tabular_models_in_calculations.md | 2 +- .../compressor_charts/index.md | 6 +-- .../compressor_models_types/index.md | 8 ++-- ...d_variable_speed_compressor_train_model.md | 4 +- .../single_speed_compressor_train_model.md | 6 +-- .../variable_speed_compressor_train_model.md | 4 +- ...del_with_multiple_streams_and_pressures.md | 12 +++--- .../fixed_speed_pressure_control/index.md | 8 ++-- .../models/compressor_modelling/index.md | 14 +++---- .../about/modelling/setup/models/index.md | 2 +- .../docs/about/modelling/setup/time_series.md | 18 ++++----- docs/docs/about/modelling/setup/variables.md | 4 +- .../modelling/theory/compressor_modelling.md | 2 +- .../modelling/workflow/generic_workflow.md | 2 +- .../about/references/keywords/CATEGORY.md | 28 ++++++------- .../references/keywords/COMPRESSOR_MODEL.md | 12 +++--- .../references/keywords/COMPRESSOR_SYSTEM.md | 12 +++--- .../keywords/COMPRESSOR_TRAIN_MODEL.md | 12 +++--- .../about/references/keywords/CONDITION.md | 12 +++--- .../about/references/keywords/CONDITIONS.md | 8 ++-- .../about/references/keywords/CONSUMERS.md | 10 ++--- .../keywords/CONSUMPTION_RATE_TYPE.md | 16 ++++---- .../about/references/keywords/CROSSOVER.md | 12 +++--- docs/docs/about/references/keywords/CURVE.md | 2 +- docs/docs/about/references/keywords/CURVES.md | 2 +- .../references/keywords/DIRECT_EMITTERS.md | 12 +++--- .../references/keywords/DISCHARGE_PRESSURE.md | 12 +++--- .../keywords/DOWNSTREAM_PRESSURE_CONTROL.md | 10 ++--- .../about/references/keywords/EFFICIENCY.md | 2 +- .../references/keywords/ELECTRICITY2FUEL.md | 14 +++---- .../about/references/keywords/EMISSIONS.md | 10 ++--- .../references/keywords/EMISSION_NAME.md | 4 +- .../references/keywords/EMISSION_RATE.md | 10 ++--- .../references/keywords/EMITTER_MODEL.md | 8 ++-- docs/docs/about/references/keywords/END.md | 4 +- .../references/keywords/ENERGYFUNCTION.md | 14 +++---- .../references/keywords/ENERGY_USAGE_MODEL.md | 24 +++++------ .../about/references/keywords/EXPRESSION.md | 4 +- .../references/keywords/EXTRAPOLATION.md | 8 ++-- .../references/keywords/FACILITY_INPUTS.md | 10 ++--- docs/docs/about/references/keywords/FILE.md | 4 +- .../references/keywords/FLUID_DENSITY.md | 6 +-- docs/docs/about/references/keywords/FUEL.md | 4 +- .../references/keywords/FUELCONSUMERS.md | 14 +++---- .../about/references/keywords/FUELRATE.md | 6 +-- .../about/references/keywords/FUEL_TYPES.md | 12 +++--- .../references/keywords/GENERATORSETS.md | 16 ++++---- .../about/references/keywords/HCEXPORT.md | 8 ++-- docs/docs/about/references/keywords/HEAD.md | 2 +- .../about/references/keywords/HEAD_MARGIN.md | 4 +- .../keywords/INFLUENCE_TIME_VECTOR.md | 6 +-- .../references/keywords/INLET_TEMPERATURE.md | 10 ++--- .../references/keywords/INSTALLATIONS.md | 6 +-- .../references/keywords/INTERPOLATION_TYPE.md | 18 ++++----- .../keywords/INTERSTAGE_CONTROL_PRESSURE.md | 18 ++++----- docs/docs/about/references/keywords/LOAD.md | 6 +-- .../keywords/LOWER_HEATING_VALUE.md | 2 +- .../keywords/MAXIMUM_DISCHARGE_PRESSURE.md | 6 +-- docs/docs/about/references/keywords/MODELS.md | 10 ++--- docs/docs/about/references/keywords/NAME.md | 8 ++-- .../keywords/OPERATIONAL_SETTINGS.md | 26 ++++++------ .../references/keywords/POWERLOSSFACTOR.md | 8 ++-- .../keywords/POWER_ADJUSTMENT_CONSTANT.md | 4 +- .../references/keywords/PRESSURE_CONTROL.md | 2 +- docs/docs/about/references/keywords/PRICE.md | 12 +++--- docs/docs/about/references/keywords/PUMPS.md | 6 +-- docs/docs/about/references/keywords/QUOTA.md | 4 +- docs/docs/about/references/keywords/RATE.md | 10 ++--- .../references/keywords/RATE_PER_STREAM.md | 8 ++-- .../about/references/keywords/REGULARITY.md | 20 +++++----- docs/docs/about/references/keywords/STAGES.md | 4 +- docs/docs/about/references/keywords/START.md | 6 +-- docs/docs/about/references/keywords/STREAM.md | 10 ++--- .../docs/about/references/keywords/STREAMS.md | 4 +- .../references/keywords/SUCTION_PRESSURE.md | 10 ++--- docs/docs/about/references/keywords/TAX.md | 12 +++--- .../about/references/keywords/TIME_SERIES.md | 6 +-- .../references/keywords/TOTAL_SYSTEM_RATE.md | 6 +-- .../keywords/TURBINE_EFFICIENCIES.md | 2 +- .../about/references/keywords/TURBINE_LOAD.md | 2 +- .../references/keywords/TURBINE_MODEL.md | 2 +- docs/docs/about/references/keywords/TYPE.md | 14 +++---- docs/docs/about/references/keywords/UNITS.md | 2 +- .../keywords/UPSTREAM_PRESSURE_CONTROL.md | 10 ++--- .../about/references/keywords/VARIABLES.md | 4 +- 113 files changed, 510 insertions(+), 510 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cfdc46061..05b5802f87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,4 +11,4 @@ behalf of external users. There are a few things you need to know. -We wrote a [Contribution Guide](https://equinor.github.io/ecalc/docs/contribute/get-started) to help you get started. +We wrote a [Contribution Guide](/contribute/get-started) to help you get started. diff --git a/README.md b/README.md index 2ac587a9c0..4afae3625c 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ eCalc™ is a software tool for calculation of energy demand and greenhouse gas --- ## Reference Links -* [**Documentation**](https://equinor.github.io/ecalc/docs/about/) +* [**Documentation**](/about/) * [**Contribution**](CONTRIBUTING.md) * [**Security**](SECURITY.md) * [**Code of Conduct**](CODE_OF_CONDUCT.md) @@ -49,7 +49,7 @@ eCalc™ uses a bottom-up approach to give high-quality installation and portfol eCalc™ is both a Python library and has a command line interface (CLI) to use with eCalc YAML Models. We currently recommend using eCalc™ from the command line with eCalc YAML Models, since the Python API is about to change soon, but the YAML will be more or less stable and backwards compatible. -To get started, please refer to the [eCalc™ Docs - Getting Started](https://equinor.github.io/ecalc/docs/about/getting_started/), +To get started, please refer to the [eCalc™ Docs - Getting Started](/about/getting_started/), or follow the quick guide below: ### Prerequisites @@ -99,7 +99,7 @@ and making a pull request. See [Contribution Document](CONTRIBUTING.md) on how to contribute. -See the [Developer Guide](https://equinor.github.io/ecalc/docs/contribute/get-started) for details. +See the [Developer Guide](/contribute/get-started) for details. ## Examples Jupyter Notebook examples can be found in /examples. In order to run these examples, you need to install the optional diff --git a/docs/docs/about/getting_started/cli/index.md b/docs/docs/about/getting_started/cli/index.md index a1dc650625..eb9c9d1368 100644 --- a/docs/docs/about/getting_started/cli/index.md +++ b/docs/docs/about/getting_started/cli/index.md @@ -12,7 +12,7 @@ It is currently **recommended** to use the CLI instead of the Python library dir The current recommended way to use eCalc is through the CLI (Command Line Interpreter). This is a part of the eCalc Python library, and should be accessible from the command line as `ecalc`. -See all commands and options in the [CLI reference](../../references/cli_reference.md) +See all commands and options in the [CLI reference](/about/references/cli_reference.md) ## Example Usage diff --git a/docs/docs/about/getting_started/index.md b/docs/docs/about/getting_started/index.md index 2a7ec92af5..50eaddc057 100644 --- a/docs/docs/about/getting_started/index.md +++ b/docs/docs/about/getting_started/index.md @@ -7,25 +7,25 @@ description: Getting started with eCalc # API Reference :::info -Currently the *only* officially supported method is the [eCalc CLI](cli/index.md) using eCalc YAML models. +Currently the *only* officially supported method is the [eCalc CLI](/about/getting_started/cli/index.md) using eCalc YAML models. ::: There are three options to run eCalc models: -- [eCalc CLI](cli/index.md) -- [eCalc Python library](library/index.md) +- [eCalc CLI](/about/getting_started/cli/index.md) +- [eCalc Python library](/about/getting_started/library/index.md) ## What method should I choose? ### eCalc CLI -Choose the [eCalc CLI](cli/index.md) option if you: +Choose the [eCalc CLI](/about/getting_started/cli/index.md) option if you: - Don't know much about programming - Have simple requirements - Can define the eCalc models statically ### Python Library -Choose the [Python Library](library/index.md) option if you: +Choose the [Python Library](/about/getting_started/library/index.md) option if you: - Are a developer or advanced user, and want to build eCalc models and get results programmatically - Use Python, and you need to use (parts of) eCalc as a dependency diff --git a/docs/docs/about/getting_started/library/index.md b/docs/docs/about/getting_started/library/index.md index f9c8ff4c2c..c46f86e6f0 100644 --- a/docs/docs/about/getting_started/library/index.md +++ b/docs/docs/about/getting_started/library/index.md @@ -11,4 +11,4 @@ It is currently **not recommended** to use the Python library due to upcoming br If you choose to use the Python library programmatically when creating eCalc models, there is a greater flexibility in dynamically changing the eCalc models. -See all commands and options in the [API reference](../../references/api) +See all commands and options in the [API reference](/about/references/api/index.md) diff --git a/docs/docs/about/getting_started/yaml/index.md b/docs/docs/about/getting_started/yaml/index.md index 3ddb31dc83..5f41943d9a 100644 --- a/docs/docs/about/getting_started/yaml/index.md +++ b/docs/docs/about/getting_started/yaml/index.md @@ -7,7 +7,7 @@ description: Getting started with YAML We have chosen the way to model eCalc models is in the YAML format. For a simple introduction to YAML, please see [here](https://learnxinyminutes.com/docs/yaml/) -The eCalc YAML model can either be run directly with the [eCalc CLI](../cli) or loaded using the [Python library](../library) +The eCalc YAML model can either be run directly with the [eCalc CLI](/about/getting_started/cli/index.md) or loaded using the [Python library](../library) -For getting started setting up your first eCalc YAML model, please see [Setup an eCalc Model](../../modelling/setup), -look at some example YAMLs [here](../../modelling/examples) and refer to the vocabulary that we use [here](../../references/keywords). +For getting started setting up your first eCalc YAML model, please see [Setup an eCalc Model](/about/modelling/setup/index.md), +look at some example YAMLs [here](/about/modelling/examples/index.md) and refer to the vocabulary that we use [here](/about/references/keywords/index.md). diff --git a/docs/docs/about/index.md b/docs/docs/about/index.md index 29216484d3..3d078ab81c 100644 --- a/docs/docs/about/index.md +++ b/docs/docs/about/index.md @@ -24,6 +24,6 @@ By using eCalc™ you will be able to forecast your energy consumption and emiss ### How to use eCalc™? To use eCalc™ you need to create a model setup of your asset. -This is described in the [Modelling](modelling/index.md) section. +This is described in the [Modelling](/about/modelling/index.md) section. Once the model is ready, you can run the eCalc™ calculator. Different user interfaces for the calculator are offered. These are described in detail in the [Getting started](getting_started/index.md) section. diff --git a/docs/docs/about/modelling/examples/advanced.md b/docs/docs/about/modelling/examples/advanced.md index 6990356c94..9b8bd9ee5a 100644 --- a/docs/docs/about/modelling/examples/advanced.md +++ b/docs/docs/about/modelling/examples/advanced.md @@ -4,7 +4,7 @@ title: Advanced model description: An advanced model using consumer systems and two installations --- # Advanced model example -This is a model very similar to [Simple example](simple.md). The main difference is the use of more advanced +This is a model very similar to [Simple example](/about/modelling/examples/simple.md). The main difference is the use of more advanced energy usage models and consumer systems, and the addition of a second installation. Both installations exports oil (`OIL_PROD`) and gas (`GAS_PROD`). @@ -54,12 +54,12 @@ The results of a performed characterization of the equipment are listed below: ## YAML model overview The YAML model consist of these main components: -- Time series inputs - [TIME_SERIES](../../references/keywords/TIME_SERIES.md) -- Facility characterization input - [FACILITY_INPUTS](../../references/keywords/FACILITY_INPUTS) -- Fuel input - [FUEL_TYPES](../../references/keywords/FUEL_TYPES) -- Model specifications - [MODELS](../../references/keywords/MODELS) -- Model variables - [VARIABLES](../../references/keywords/VARIABLES) -- Installation topology - [INSTALLATIONS](../../references/keywords/INSTALLATIONS) +- Time series inputs - [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) +- Facility characterization input - [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) +- Fuel input - [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) +- Model specifications - [MODELS](/about/references/keywords/MODELS.md) +- Model variables - [VARIABLES](/about/references/keywords/VARIABLES.md) +- Installation topology - [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) The YAML setup file looks like this: @@ -81,7 +81,7 @@ We will now replace the placeholders for each of the main keywords above. ## TIME_SERIES The reservoir variables, in this case, are found in a CSV (Comma separated file) `production_data.csv`. We give the time-series data a name that can be referenced as variables elsewhere in the form `:`. -See [TIME_SERIES](../../references/keywords/TIME_SERIES.md) for further details. +See [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) for further details. ~~~~~~~~yaml title="model.yaml" TIME_SERIES: @@ -92,10 +92,10 @@ TIME_SERIES: ## FACILITY_INPUTS We specify CSV input data for processing equipment using FACILITY_INPUTS. This is used for generatorsets, -tabulated/sampled models and pump charts. See [FACILITY_INPUTS](../../references/keywords/FACILITY_INPUTS.md) for further details. +tabulated/sampled models and pump charts. See [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) for further details. Here we define a tabulated genset, a sampled compressor, and a single speed pump chart. -Note that more complicated energy models are defined under the [MODELS](../../references/keywords/MODELS.md)-keyword. +Note that more complicated energy models are defined under the [MODELS](/about/references/keywords/MODELS.md)-keyword. ~~~~~~~~yaml title="model.yaml" FACILITY_INPUTS: @@ -115,7 +115,7 @@ FACILITY_INPUTS: ~~~~~~~~ ## FUEL_TYPES -In this example there are two [FUEL_TYPES](../../references/keywords/FUEL_TYPES) - `fuel_gas` and `bad_fuel_gas`. +In this example there are two [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) - `fuel_gas` and `bad_fuel_gas`. These are used for Installation A and Installation B respectively. Here we also define emissions in CO2 and CH4. Note that the two fuels have different prices, emissions factors and the same taxes and are defined: @@ -146,7 +146,7 @@ FUEL_TYPES: ## MODELS -This advanced example requires some energy usage models to be defined under the model section. See [MODELS](../../references/keywords/MODELS) for details. +This advanced example requires some energy usage models to be defined under the model section. See [MODELS](/about/references/keywords/MODELS.md) for details. Here we specify: - Compressor chart based on design points @@ -199,10 +199,10 @@ MODELS: COMPRESSOR_CHART: predefined_variable_speed_compressor_chart ~~~~~~~~ -See [MODELS](../../references/keywords/MODELS) for further details. +See [MODELS](/about/references/keywords/MODELS.md) for further details. ## VARIABLES -To run the model it is recommended to specify [VARIABLES](../../references/keywords/VARIABLES), +To run the model it is recommended to specify [VARIABLES](/about/references/keywords/VARIABLES.md), instead of hard coding values in difference places. This makes it easier to develop, maintain and understand the model by allowing descriptive variable names and avoid duplications. @@ -254,7 +254,7 @@ We specify: - `NAME`: the installation name - `HCEXPORT`: Hydrocarbon export in Sm3/day by referring to the variable $var.hydrocarbon_export_sm3_per_day specified under [VARIABLES](#variables) above. - `FUEl`: Default fuel specified in [FUEL_TYPES](#fuel_types) above. Note the different fuels used by the two installations. -- `CATEGORY`: FIXED (installation) category is used to group result data for reporting. See [CATEGORY](../../references/keywords/CATEGORY) for details. +- `CATEGORY`: FIXED (installation) category is used to group result data for reporting. See [CATEGORY](/about/references/keywords/CATEGORY.md) for details. ~~~~~~~~yaml INSTALLATIONS: @@ -346,7 +346,7 @@ The setup for `Installation B` thus becomes: ~~~~~~~~ ## ENERGY_USAGE_MODEL -We will now fill in the final placeholders with detailed [ENERGY_USAGE_MODEL](../../references/keywords/ENERGY_USAGE_MODEL.md)s. +We will now fill in the final placeholders with detailed [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md)s. `Base production loads A` has a load of 7.6 MW with additional 4.1 MW when the field gas injection rate is positive: @@ -364,7 +364,7 @@ rate distributions between these two compressor trains. It will first send all r and nothing to the second `RATE_FRACTIONS: [1.0, 0.0]` and then it will run the same input while distributing equal rates to the two compressor trains `RATE_FRACTIONS: [0.5, 0.5]`. The final result will be composed of the first setting that returns a valid result for the compressors. -See [COMPRESSOR_SYSTEM](../../references/keywords/ENERGY_USAGE_MODEL#compressor-system) for further details. +See [COMPRESSOR_SYSTEM](/about/references/keywords/ENERGY_USAGE_MODEL.md#compressor-system) for further details. The model compressor model is defined: ~~~~~~~~yaml @@ -394,7 +394,7 @@ This is when the water injection rate is positive. Fluid density, suction pressu is also defined. This PUMP_SYSTEM behaves much the same as the COMPRESSOR_SYSTEM above. -See [PUMP_SYSTEM](../../references/keywords/ENERGY_USAGE_MODEL#pump-system) for further details. +See [PUMP_SYSTEM](/about/references/keywords/ENERGY_USAGE_MODEL.md#pump-system) for further details. ~~~~~~~~yaml - NAME: Water injection pump system A diff --git a/docs/docs/about/modelling/examples/drogon.md b/docs/docs/about/modelling/examples/drogon.md index 6f8b69260b..be11c00ca6 100644 --- a/docs/docs/about/modelling/examples/drogon.md +++ b/docs/docs/about/modelling/examples/drogon.md @@ -74,7 +74,7 @@ TIME_SERIES: ## FACILITY_INPUTS -In this case, the compressors are not specified in this section as [GENERIC COMPRESSOR CHARTS](../setup/models/compressor_modelling/compressor_charts/index.md). Thus, the pump chart and generator set will be the only facility components specified within this section. +In this case, the compressors are not specified in this section as [GENERIC COMPRESSOR CHARTS](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md). Thus, the pump chart and generator set will be the only facility components specified within this section. The pump will be variable speed, meaning that the pump type will be `PUMP_CHART_VARIABLE_SPEED`. The generator set will be a tabulated, where power consumption will be linked to fuel gas utilised. @@ -99,7 +99,7 @@ Peng-Robinson (PR) will be the selected equation of state in this example. This example will use a generic compressor chart. In this case, a generic compressor chart from input will utilised. Here, the a "typical" chart will be shifted to match the input head and rate data. See [GENERIC COMPRESSOR CHARTS](../setup/models/compressor_modelling/compressor_charts/index.md) for more details. When a generic chart is used, a polytropic efficiency needs to be specified. This value will be constant throughout the use, in this case a value of 0.8 is used. -A [SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN](../setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model) model is used in this example, as this is necessary when a generic chart is used. Instead of manually specifying the number of compression stages, a `MAXIMUM_PRESSURE_RATIO_PER_STAGE` of 3.5 is defined. This will automatically distribute the pressure increase amongst the compression train so that no pressure ratio per compression stage will be above 3.5. +A [SIMPLIFIED_VARIABLE_SPEED_COMPRESSOR_TRAIN](/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md) model is used in this example, as this is necessary when a generic chart is used. Instead of manually specifying the number of compression stages, a `MAXIMUM_PRESSURE_RATIO_PER_STAGE` of 3.5 is defined. This will automatically distribute the pressure increase amongst the compression train so that no pressure ratio per compression stage will be above 3.5. ~~~~~~~~yaml MODELS: diff --git a/docs/docs/about/modelling/examples/index.md b/docs/docs/about/modelling/examples/index.md index 824dbe2594..24ec10a363 100644 --- a/docs/docs/about/modelling/examples/index.md +++ b/docs/docs/about/modelling/examples/index.md @@ -5,8 +5,8 @@ description: Examples of eCalc usage # Examples Here you find some examples. -- [Simple example](simple.md) -- [Advanced example](advanced.md) -- [Drogon example](drogon.md) +- [Simple example](/about/modelling/examples/simple.md) +- [Advanced example](/about/modelling/examples/advanced.md) +- [Drogon example](/about/modelling/examples/drogon.md) The models are also available in the Python library under the libecalc.examples module. diff --git a/docs/docs/about/modelling/examples/simple.md b/docs/docs/about/modelling/examples/simple.md index 3464e94aba..dff76f47a0 100644 --- a/docs/docs/about/modelling/examples/simple.md +++ b/docs/docs/about/modelling/examples/simple.md @@ -39,11 +39,11 @@ The results of a performed characterization of the equipment are listed below: ## YAML model overview The YAML model consist of these main components: -- Time series inputs - [TIME_SERIES](../../references/keywords/TIME_SERIES.md) -- Facility characterization input - [FACILITY_INPUTS](../../references/keywords/FACILITY_INPUTS) -- Fuel input - [FUEL_TYPES](../../references/keywords/FUEL_TYPES) -- Model variables - [VARIABLES](../../references/keywords/VARIABLES) -- Installation topology - [INSTALLATIONS](../../references/keywords/INSTALLATIONS) +- Time series inputs - [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) +- Facility characterization input - [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) +- Fuel input - [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) +- Model variables - [VARIABLES](/about/references/keywords/VARIABLES.md) +- Installation topology - [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) The YAML setup file looks like this: @@ -65,7 +65,7 @@ We will now replace the placeholders for each of the main keywords above. ## TIME_SERIES The reservoir variables, in this case, are found in a CSV (Comma separated file) `production_data.csv`. We give the time-series data a name that can be referenced as variables elsewhere in the form `:`. -See [TIME_SERIES](../../references/keywords/TIME_SERIES.md) for further details. +See [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) for further details. ~~~~~~~~yaml title="model.yaml" TIME_SERIES: @@ -77,11 +77,11 @@ TIME_SERIES: ## FACILITY_INPUTS We specify CSV input data for processing equipment using FACILITY_INPUTS. This is used for generatorsets, tabulated/sampled models and pump charts. -See [FACILITY_INPUTS](../../references/keywords/FACILITY_INPUTS.md) for further details. +See [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) for further details. Here we define a tabulated genset, a sampled compressor, a sampled compressor driven by a turbine, a sampled pump, and a single speed pump chart. These will be used in the final model for illustration. -Note that more complicated energy models are defined under the [MODELS-keyword](../../references/keywords/MODELS.md). +Note that more complicated energy models are defined under the [MODELS-keyword](/about/references/keywords/MODELS.md). See the input data further down to understand the input formats. @@ -109,7 +109,7 @@ FACILITY_INPUTS: ~~~~~~~~ ## FUEL_TYPES -In this example there is only one [FUEL_TYPES](../../references/keywords/FUEL_TYPES) - `fuel_gas`. This has a price/value +In this example there is only one [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) - `fuel_gas`. This has a price/value of 1.5 NOK/Sm3 and the emissions we model with the fuel is CO2. The CO2 factor is 2.19 kg CO2 per Sm3 fuel gas burned. The CO2 tax is set to 1.5 NOK/Sm3 fuel gas burned, and it has a quota price of 260 NOK/ton. @@ -126,7 +126,7 @@ FUEL_TYPES: ~~~~~~~~ ## VARIABLES -To run the model it is recommended to specify [VARIABLES](../../references/keywords/VARIABLES), +To run the model it is recommended to specify [VARIABLES](/about/references/keywords/VARIABLES.md), instead of hard coding values in difference places. This makes it easier to develop, maintain and understand the model by allowing descriptive variable names and avoid duplications. @@ -227,7 +227,7 @@ The direct fuel consumers are **Flare** and **Gas export compressor**. ~~~~~~~~ ## ENERGY_USAGE_MODEL -We will now fill in the final placeholders with detailed [ENERGY_USAGE_MODEL](../../references/keywords/ENERGY_USAGE_MODEL.md)s. +We will now fill in the final placeholders with detailed [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md)s. `Base production load` has a constant load of 11.8 MW: diff --git a/docs/docs/about/modelling/setup/facility_inputs/generator_modelling.md b/docs/docs/about/modelling/setup/facility_inputs/generator_modelling.md index 271119428b..fa38a8b0b5 100644 --- a/docs/docs/about/modelling/setup/facility_inputs/generator_modelling.md +++ b/docs/docs/about/modelling/setup/facility_inputs/generator_modelling.md @@ -19,7 +19,7 @@ and fuel consumption for an entire generator set. This means that if you have se this table needs to include a "jump" every time a new generator is started. An example of this is shown [below](#Table-example). -Under [FACILITY_INPUTS](../facility_inputs/index.md), this electricity to fuel table is specified using the keyword [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) +Under [FACILITY_INPUTS](/about/modelling/setup/facility_inputs/index.md), this electricity to fuel table is specified using the keyword [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) ### Facility input format diff --git a/docs/docs/about/modelling/setup/facility_inputs/index.md b/docs/docs/about/modelling/setup/facility_inputs/index.md index 74177f6591..4efc2c6400 100644 --- a/docs/docs/about/modelling/setup/facility_inputs/index.md +++ b/docs/docs/about/modelling/setup/facility_inputs/index.md @@ -5,30 +5,30 @@ description: Guide on how to use facility inputs --- :::note -The [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS.md) keyword is **mandatory** within the eCalc™ YAML file. +The [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) keyword is **mandatory** within the eCalc™ YAML file. ::: This part of the setup defines input files that characterize various facility elements. Each facility element is -specified in a list. These are later used as input in the [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) part of the setup by referencing their [NAME](../../../references/keywords/NAME). +specified in a list. These are later used as input in the [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) part of the setup by referencing their [NAME](/about/references/keywords/NAME.md). All facility inputs are in essence a `CSV` (Comma separated file) file that specifies input data to a model that calculates how much energy the equipment is using depending on the operating mode/throughput. There are multiple [supported types](#supported-types). There are four categories of data that can be used here: -- Files describing the performance of a [generator set](generator_modelling) -- Files describing the performance of pumps [(pump charts)](pump_modelling/pump_charts) -- Files describing the performance of **only** tabular compressors [(sampled compressor data)](sampled_compressor_model) +- Files describing the performance of a [generator set](/about/modelling/setup/facility_inputs/generator_modelling.md) +- Files describing the performance of pumps [(pump charts)](/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md) +- Files describing the performance of **only** tabular compressors [(sampled compressor data)](/about/modelling/setup/facility_inputs/sampled_compressor_model.md) - 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](../../../references/keywords/ADJUSTMENT) -keyword as well as modification of the [HEAD_MARGIN](../../../references/keywords/HEAD_MARGIN) +eCalc™ supports making simple adjustments to a table by using the [ADJUSTMENT](/about/references/keywords/ADJUSTMENT.mdx) +keyword as well as modification of the [HEAD_MARGIN](/about/references/keywords/HEAD_MARGIN.md) which can be used while calibrating pump charts. ## Format -Each facility input has the skeleton as seen below. However, some inputs require further information. For example, [pump models](pump_modelling/pump_charts) +Each facility input has the skeleton as seen below. However, some inputs require further information. For example, [pump models](/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md) ~~~~yaml FACILITY_INPUTS: @@ -38,7 +38,7 @@ FACILITY_INPUTS: ~~~~ ### Supported types -The facility input type is defined using the [TYPE](../../../references/keywords/TYPE) keyword and defines the type of model applied +The facility input type is defined using the [TYPE](/about/references/keywords/TYPE.md) keyword and defines the type of model applied to the data in this file. The input files are in `CSV` (Comma separated file) format. The paths to the input files may be either absolute or relative to the setup file. The supported types are: diff --git a/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/index.md b/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/index.md index 10bf691e54..8b3187e837 100644 --- a/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/index.md +++ b/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/index.md @@ -12,4 +12,4 @@ Thus, for usage in other types of pumps (e.g., where the fluid viscosity changes with the fluid mixture), the results might not be as intended. ::: -Core theory behind the modelling of pumps in eCalc™ can be found [here](../../../../modelling/theory/pump_modelling). \ No newline at end of file +Core theory behind the modelling of pumps in eCalc™ can be found [here](/about/modelling/theory/pump_modelling.md). \ No newline at end of file diff --git a/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md b/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md index 2d245c9dfd..5568727075 100644 --- a/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md +++ b/docs/docs/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md @@ -25,7 +25,7 @@ put in the cloud of data to be unbiased. However, eCalc will treat all head valu maximum defined in the chart as infeasible (outside pump capacity). To mitigate this when -running through historical data for power calibration, the keyword [HEAD_MARGIN](../../../../references/keywords/HEAD_MARGIN) may be used to move points outside capacity (but inside the margin) to the capacity limit. +running through historical data for power calibration, the keyword [HEAD_MARGIN](/about/references/keywords/HEAD_MARGIN.md) may be used to move points outside capacity (but inside the margin) to the capacity limit. ::: ## PUMP_CHART_SINGLE_SPEED diff --git a/docs/docs/about/modelling/setup/facility_inputs/sampled_compressor_model.md b/docs/docs/about/modelling/setup/facility_inputs/sampled_compressor_model.md index 8b678dbfd6..9984a2d599 100644 --- a/docs/docs/about/modelling/setup/facility_inputs/sampled_compressor_model.md +++ b/docs/docs/about/modelling/setup/facility_inputs/sampled_compressor_model.md @@ -27,7 +27,7 @@ inputted into eCalc™. Each line in the `.csv` defines a point (rate, suction p ## Format -The sampled compressor model is defined under the main keyword [`FACILITY_INPUTS`](../../../references/keywords/FACILITY_INPUTS) in the format +The sampled compressor model is defined under the main keyword [`FACILITY_INPUTS`](/about/references/keywords/FACILITY_INPUTS.md) in the format ~~~~~~~~yaml NAME: diff --git a/docs/docs/about/modelling/setup/facility_inputs/tabular.md b/docs/docs/about/modelling/setup/facility_inputs/tabular.md index 2684e1e13f..50b0ac275c 100644 --- a/docs/docs/about/modelling/setup/facility_inputs/tabular.md +++ b/docs/docs/about/modelling/setup/facility_inputs/tabular.md @@ -35,7 +35,7 @@ RATE, FUEL 5000000, 168644 ~~~~~~~~ -The entry in [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS): +The entry in [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md): ~~~~~~~~yaml FACILITY_INPUTS: @@ -44,7 +44,7 @@ FACILITY_INPUTS: TYPE: TABULAR ~~~~~~~~ -The entry in [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) under a fuel consumer: +The entry in [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) under a fuel consumer: ~~~~~~~~yaml INSTALLATIONS: @@ -60,7 +60,7 @@ INSTALLATIONS: ~~~~~~~~ :::note Note -Note that the name `RATE` in the input file (under [FACILITY_INPUT](../facility_inputs/index.md)) and the variable name `RATE` under [VARIABLES](../VARIABLES) +Note that the name `RATE` in the input file (under [FACILITY_INPUT](/about/modelling/setup/facility_inputs/index.md)) and the variable name `RATE` under [VARIABLES](/about/references/keywords/VARIABLES.md) must be equal! ::: @@ -94,7 +94,7 @@ Contents of file `energyfunc_3d_rate_ps_pd_power.csv`: 1.10E+07, 78, 231.6, 22.46 ~~~~~~~~ -The entry in [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS): +The entry in [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md): ~~~~~~~~yaml FACILITY_INPUTS: @@ -103,7 +103,7 @@ FACILITY_INPUTS: TYPE: TABULAR ~~~~~~~~ -The entry in [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) under a fuel consumer (for 3-d tabular): +The entry in [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) under a fuel consumer (for 3-d tabular): ~~~~~~~~yaml INSTALLATIONS: diff --git a/docs/docs/about/modelling/setup/file_format_and_syntax/expressions.md b/docs/docs/about/modelling/setup/file_format_and_syntax/expressions.md index 3f65303294..f64bc8da47 100644 --- a/docs/docs/about/modelling/setup/file_format_and_syntax/expressions.md +++ b/docs/docs/about/modelling/setup/file_format_and_syntax/expressions.md @@ -10,11 +10,11 @@ not equal to the pressure at the inlet/outlet of a compressor system and some de To avoid forcing the users to define new variables in the simulation files/CSV data and also keep the data in the consumer’s energy function consistent, the calculator supports expressions to define variables (and conditions in the -[CONDITIONS](../../../references/keywords/CONDITIONS). +[CONDITIONS](/about/references/keywords/CONDITIONS.md). :::warning When creating new variables from CSV files make sure to choose the right interpolation type! -See [INTERPOLATION_TYPE](../../../references/keywords/INTERPOLATION_TYPE.md) for more information. +See [INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md) for more information. ::: ## Available operators diff --git a/docs/docs/about/modelling/setup/file_format_and_syntax/index.md b/docs/docs/about/modelling/setup/file_format_and_syntax/index.md index a5366cca45..8c896a76e5 100644 --- a/docs/docs/about/modelling/setup/file_format_and_syntax/index.md +++ b/docs/docs/about/modelling/setup/file_format_and_syntax/index.md @@ -13,23 +13,23 @@ The setup file is written in YAML format and needs to follow a strict pattern wh The overall system in eCalc is that the user defines inputs from subsurface and facility and then establishes a model between these. -On the top level, the required keywords are [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS) which defines the input from facility characterization, [TIME_SERIES](../../../references/keywords/TIME_SERIES.md) which defines time-dependant input parameters (e.g. reservoir profiles), [FUEL_TYPES](../../../references/keywords/FUEL_TYPES) which defines the various fuel types used in the system, and [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) which is the top node defining the system of energy consumers. [MODELS](../../../references/keywords/MODELS) is optional and may be used for multi-level energy usage models. +On the top level, the required keywords are [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) which defines the input from facility characterization, [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) which defines time-dependant input parameters (e.g. reservoir profiles), [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) which defines the various fuel types used in the system, and [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) which is the top node defining the system of energy consumers. [MODELS](/about/references/keywords/MODELS.md) is optional and may be used for multi-level energy usage models. Documentation about how to set up each of these fields are found here, respectively: -- [TIME_SERIES](../../..//references/keywords/TIME_SERIES.md): List of input sources, CSV-files, containing all time series data including the +- [TIME_SERIES](/about/references/keywords/TIME_SERIES.md): List of input sources, CSV-files, containing all time series data including the reservoir variables. -- [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS): List of input files from facility characterization. Typically, this can be +- [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md): List of input files from facility characterization. Typically, this can be characteristics for an element in a consumer system or characteristics for a generator set. Also, if fuel price or/and CO2 tax is of type `VARIABLE_FUEL_PRICE` or `VARIABLE_EMISSION_TAX`, these files should also be put here. These are later used as input to the energy functions for each consumer. Some may also be used as energy functions directly. -- [FUEL_TYPES](../../../references/keywords/FUEL_TYPES): Defining the fuel types being used in the model and the corresponding +- [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md): Defining the fuel types being used in the model and the corresponding emissions. -- [MODELS](../../../references/keywords/MODELS): Used for multi-level models, one model may refer to other models from either - [MODELS](../../../references/keywords/MODELS) or [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS) -- [VARIABLES](../../../references/keywords/VARIABLES): Used for defining variables to be used in expressions throughout the YAML file -- [INSTALLATIONS](../../../references/keywords/INSTALLATIONS): Defining the system of energy consumers on each installation +- [MODELS](/about/references/keywords/MODELS.md): Used for multi-level models, one model may refer to other models from either + [MODELS](/about/references/keywords/MODELS.md) or [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) +- [VARIABLES](/about/references/keywords/VARIABLES.md): Used for defining variables to be used in expressions throughout the YAML file +- [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md): Defining the system of energy consumers on each installation (e.g. platform or mobile unit). @@ -42,12 +42,12 @@ are the fuel burners. As the figure below shows, there are three main types of f - Turbine-driven processes, - Flare/vent/other non reservoir dependent burners/emitters. -In eCalc under each installation, there is one keyword ([GENERATORSETS](../../../references/keywords/GENERATORSETS.md)) -specifying the generator sets and one keyword ([FUELCONSUMERS](../../../references/keywords/FUELCONSUMERS.md)) +In eCalc under each installation, there is one keyword ([GENERATORSETS](/about/references/keywords/GENERATORSETS.md)) +specifying the generator sets and one keyword ([FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md)) specifying processes that require fuel directly (turbine-driven processes and flare/vent). The processes with electrical motor drives and other electrical loads are modeled at the sublevel -under [GENERATORSETS](../../../references/keywords/GENERATORSETS.md). +under [GENERATORSETS](/about/references/keywords/GENERATORSETS.md). ![](ecalc_general_consumer_overview.png) @@ -99,4 +99,4 @@ INSTALLATIONS: ### Full examples -Examples are an excellent way to quickly get an overview of the syntax. Check them out [here](../../examples/index.md). +Examples are an excellent way to quickly get an overview of the syntax. Check them out [here](/about/modelling/examples/index.md). diff --git a/docs/docs/about/modelling/setup/fuel_types.md b/docs/docs/about/modelling/setup/fuel_types.md index 467175b3b3..ac4dcb8689 100644 --- a/docs/docs/about/modelling/setup/fuel_types.md +++ b/docs/docs/about/modelling/setup/fuel_types.md @@ -5,18 +5,18 @@ description: Guide on how to use fuel types --- :::note -The [FUEL_TYPES](../../references/keywords/FUEL_TYPES) keyword is **mandatory** within the eCalc™ YAML file. +The [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) keyword is **mandatory** within the eCalc™ YAML file. ::: This part of the setup specifies the various fuel types and associated emissions used in the model. Each fuel type is specified in a list and the defined fuels can later be referred to the -[INSTALLATIONS](installations/) part of the setup by its name. +[INSTALLATIONS](/about/modelling/setup/installations/index.md) part of the setup by its name. -A fuel type can have a fuel-cost [PRICE](../../references/keywords/PRICE) associated with -its use. The use of fuel can lead to one or more emission types, specified in [EMISSIONS](../../references/keywords/EMISSIONS.md), +A fuel type can have a fuel-cost [PRICE](/about/references/keywords/PRICE.md) associated with +its use. The use of fuel can lead to one or more emission types, specified in [EMISSIONS](/about/references/keywords/EMISSIONS.md), which in turn can have associated costs. -You can optionally specify a [CATEGORY](../../references/keywords/CATEGORY). +You can optionally specify a [CATEGORY](/about/references/keywords/CATEGORY.md). ## Format ~~~~~~~~yaml @@ -33,7 +33,7 @@ FUEL_TYPES: ## Example This is a full example where there are 3 fuel type definitions, i.e., there are 3 different -fuels defined that can be used in your [INSTALLATIONS](installations/index.md). +fuels defined that can be used in your [INSTALLATIONS](/about/modelling/setup/installations/index.md). ~~~~~~~~yaml FUEL_TYPES: diff --git a/docs/docs/about/modelling/setup/index.md b/docs/docs/about/modelling/setup/index.md index 87027c56a4..fa1dbe6d26 100644 --- a/docs/docs/about/modelling/setup/index.md +++ b/docs/docs/about/modelling/setup/index.md @@ -9,13 +9,13 @@ This section describes how to create your own eCalc™ model file. There are six separate sections which make up each model, these being: -| Input | Function | -| ----- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -|[TIME_SERIES](time_series)| Input of time dependent variables. For example, production profiles for an installation | -|[FACILITY_INPUTS](facility_inputs/index.md)| Input of generator sets, and facility equipment that consumers either power or fuel *(with the exception of compressors that are modelled with compressor charts)* | -|[MODELS](models/index.md)| Input of compressor models that use compressor charts. Gas turbines that are directly coupled to a compressor are also included here | -|[FUEL_TYPES](fuel_types)| Input of the various fuel types used in the specified installation(s) | -|[VARIABLES](variables) | Input of variables that can reference to in expressions within the YAML set-up file | -|[INSTALLATIONS](installations/index.md)| This is essentially the only *"output"* section in the YAML setup file. All the inputs are specified and related to specific platforms/rigs, and whether or not they consume either power or fuel | +| Input | Function | +|--------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [TIME_SERIES](/about/modelling/setup/time_series.md) | Input of time dependent variables. For example, production profiles for an installation | +| [FACILITY_INPUTS](/about/modelling/setup/facility_inputs/index.md) | Input of generator sets, and facility equipment that consumers either power or fuel *(with the exception of compressors that are modelled with compressor charts)* | +| [MODELS](/about/modelling/setup/models/index.md) | Input of compressor models that use compressor charts. Gas turbines that are directly coupled to a compressor are also included here | +| [FUEL_TYPES](/about/modelling/setup/fuel_types.md) | Input of the various fuel types used in the specified installation(s) | +| [VARIABLES](/about/modelling/setup/variables.md) | Input of variables that can reference to in expressions within the YAML set-up file | +| [INSTALLATIONS](/about/modelling/setup/installations/index.md) | This is essentially the only *"output"* section in the YAML setup file. All the inputs are specified and related to specific platforms/rigs, and whether or not they consume either power or fuel | All of the above are mandatory inputs for eCalc™ to run, with the exception of models (which is an optional, but still important input) and variables. \ No newline at end of file diff --git a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor.md b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor.md index 19cb64b0da..f205643807 100644 --- a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor.md +++ b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor.md @@ -6,11 +6,11 @@ description: COMPRESSOR Energy Usage Model # COMPRESSOR Energy Usage Model -When `COMPRESSOR` is specified under [ENERGY_USAGE_MODEL](../../../../references/keywords/ENERGY_USAGE_MODEL) the only keyword that is allowed is [ENERGYFUNCTION](../../../../references/keywords/ENERGYFUNCTION). -This model only supports a single compressor, which can either be a tabular compressor model defined in [FACILITY_INPUTS](../../facility_inputs/index.md) or a compressor model defined in [MODELS](../../models/index.md). +When `COMPRESSOR` is specified under [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) the only keyword that is allowed is [ENERGYFUNCTION](/about/references/keywords/ENERGYFUNCTION.md). +This model only supports a single compressor, which can either be a tabular compressor model defined in [FACILITY_INPUTS](/about/modelling/setup/facility_inputs/index.md) or a compressor model defined in [MODELS](/about/modelling/setup/models/index.md). -The attributes [RATE](../../../../references/keywords/RATE), [SUCTION_PRESSURE](../../../../references/keywords/SUCTION_PRESSURE) and -[DISCHARGE_PRESSURE](../../../../references/keywords/DISCHARGE_PRESSURE) are required to be specified in the energy usage model. Here, the specified rate will be for the entire train, the +The attributes [RATE](/about/references/keywords/RATE.md), [SUCTION_PRESSURE](/about/references/keywords/SUCTION_PRESSURE.md) and +[DISCHARGE_PRESSURE](/about/references/keywords/DISCHARGE_PRESSURE.md) are required to be specified in the energy usage model. Here, the specified rate will be for the entire train, the suction pressure will be at the inlet of the first stage, whilst the discharge pressure will be the outlet pressure of the last stage. ## Format diff --git a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor_system.md b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor_system.md index abc3cb07e4..e5f9208c64 100644 --- a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor_system.md +++ b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/compressor_system.md @@ -6,14 +6,14 @@ description: COMPRESSOR_SYSTEM Energy Usage Model # COMPRESSOR_SYSTEM energy usage model -When [COMPRESSOR_SYSTEM](../../../../references/keywords/COMPRESSOR_SYSTEM) is specified under [ENERGY_USAGE_MODEL](../../../../references/keywords/ENERGY_USAGE_MODEL) a fully defined compressor model (with charts) can be used. Here, the following are allowed under the -[COMPRESSOR_SYSTEM](../../../../references/keywords/COMPRESSOR_SYSTEM) keyword: +When [COMPRESSOR_SYSTEM](/about/references/keywords/COMPRESSOR_SYSTEM.md) is specified under [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) a fully defined compressor model (with charts) can be used. Here, the following are allowed under the +[COMPRESSOR_SYSTEM](/about/references/keywords/COMPRESSOR_SYSTEM.md) keyword: -- [Simplified variable speed compressor train model](../../models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model), -- [Variable speed compressor train model](../../models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model) -- [Sampled compressor model](../../facility_inputs/sampled_compressor_model) +- [Simplified variable speed compressor train model](/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md), +- [Variable speed compressor train model](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md) +- [Sampled compressor model](/about/modelling/setup/facility_inputs/sampled_compressor_model.md) -The key difference between this model and the [COMPRESSOR](compressor) keyword is that multiple compression trains can be specified. +The key difference between this model and the [COMPRESSOR](/about/modelling/setup/installations/compressor_models_in_calculations/compressor.md) keyword is that multiple compression trains can be specified. ## Format diff --git a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/index.md b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/index.md index 2c960af62f..fedc1f76d9 100644 --- a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/index.md +++ b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/index.md @@ -7,7 +7,7 @@ description: Using compressor models in calculations # Compressor models in calculations There are different options on how to utilise compressor models in the calculations within the -[ENERGY_USAGE_MODEL](../../../../references/keywords/ENERGY_USAGE_MODEL) section in [INSTALLATIONS](../../../../references/keywords/INSTALLATIONS). Three different options will be illustrated here: +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) section in [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md). Three different options will be illustrated here: No matter the compressor model type, it can either be placed in two sections, which can be: diff --git a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md index 225446047d..ac34c303ed 100644 --- a/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md +++ b/docs/docs/about/modelling/setup/installations/compressor_models_in_calculations/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md @@ -7,7 +7,7 @@ description: VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES Ener # VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES energy usage model This energy usage model allows the compressor train model type -[Variable speed compressor train model with multiple streams and pressures](../../models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures). +[Variable speed compressor train model with multiple streams and pressures](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md). ## Format @@ -29,9 +29,9 @@ ENERGY_USAGE_MODEL: POWER_ADJUSTMENT_CONSTANT: ~~~~~~~~ -The number of elements in [RATE_PER_STREAM](../../../../references/keywords/RATE_PER_STREAM) must correspond to the number of streams defined for the model referenced in -[COMPRESSOR_TRAIN_MODEL](../../../../references/keywords/COMPRESSOR_TRAIN_MODEL). +The number of elements in [RATE_PER_STREAM](/about/references/keywords/RATE_PER_STREAM.md) must correspond to the number of streams defined for the model referenced in +[COMPRESSOR_TRAIN_MODEL](/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md). -[INTERSTAGE_CONTROL_PRESSURE](../../../../references/keywords/INTERSTAGE_CONTROL_PRESSURE) is required if the model referenced in [COMPRESSOR_TRAIN_MODEL](../../../../references/keywords/COMPRESSOR_TRAIN_MODEL) has has an -interstage control pressure defined. If there is no interstage control pressure defined in [COMPRESSOR_TRAIN_MODEL](../../../../references/keywords/COMPRESSOR_TRAIN_MODEL), -[INTERSTAGE_CONTROL_PRESSURE](../../../../references/keywords/INTERSTAGE_CONTROL_PRESSURE) should not be defined. \ No newline at end of file +[INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) is required if the model referenced in [COMPRESSOR_TRAIN_MODEL](/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md) has has an +interstage control pressure defined. If there is no interstage control pressure defined in [COMPRESSOR_TRAIN_MODEL](/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md), +[INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) should not be defined. \ No newline at end of file diff --git a/docs/docs/about/modelling/setup/installations/generator_sets_in_calculations.md b/docs/docs/about/modelling/setup/installations/generator_sets_in_calculations.md index 16f3602cc8..47c9fa38c7 100644 --- a/docs/docs/about/modelling/setup/installations/generator_sets_in_calculations.md +++ b/docs/docs/about/modelling/setup/installations/generator_sets_in_calculations.md @@ -6,20 +6,20 @@ description: Using generator sets in calculations # Generator sets in calculations -The [GENERATORSETS](../../../references/keywords/GENERATORSETS.md) keyword is optional. However, the only requirement is that each -installation must have defined either [GENERATORSETS](../../../references/keywords/GENERATORSETS.md) or -[FUELCONSUMERS](../../../references/keywords/FUELCONSUMERS.md). +The [GENERATORSETS](/about/references/keywords/GENERATORSETS.md) keyword is optional. However, the only requirement is that each +installation must have defined either [GENERATORSETS](/about/references/keywords/GENERATORSETS.md) or +[FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md). -Under [GENERATORSETS](../../../references/keywords/GENERATORSETS.md) one or several `generator sets` +Under [GENERATORSETS](/about/references/keywords/GENERATORSETS.md) one or several `generator sets` (a 'set' of an engine of some sort and a generator) are specified in a list. -Each generator set requires three sub-keywords, [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) -and [CONSUMERS](../../../references/keywords/CONSUMERS) and [CATEGORY](../../../references/keywords/CATEGORY). -Optionally, [FUEL](../../../references/keywords/FUEL) may be used to override the default fuel type specification for +Each generator set requires three sub-keywords, [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) +and [CONSUMERS](/about/references/keywords/CONSUMERS.md) and [CATEGORY](/about/references/keywords/CATEGORY.md). +Optionally, [FUEL](/about/references/keywords/FUEL.md) may be used to override the default fuel type specification for the installation. If not specified, it will inherit that of the installation. :::tip What happens when fuel is specified? -When [FUEL](../../../references/keywords/FUEL) is defined for a generator set, there is no merging between the installation fuel +When [FUEL](/about/references/keywords/FUEL.md) is defined for a generator set, there is no merging between the installation fuel definition and the generator set fuel definition, but a complete override of the configuration. ::: @@ -38,11 +38,11 @@ GENERATORSETS: ## Electricity2fuel function ### Description -The behavior of a generator set is described by an [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) +The behavior of a generator set is described by an [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) table, which relates the burned fuel rate to delivered power, including the power generation efficiency at different loads. It also defines the operational envelope of the generator set. -[ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) may be modeled with a constant function through time or +[ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) may be modeled with a constant function through time or with different power vs. fuel relations for different time intervals. ### Format @@ -61,10 +61,10 @@ ELECTRICITY2FUEL: ## Power from shore ### Description :::note -Power from shore is currently handled in eCalc™ by defining a dummy [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) model with zero fuel usage, and applying the `POWER-FROM-SHORE` category. This is an intermediate solution and will be dealt with differently in the future. +Power from shore is currently handled in eCalc™ by defining a dummy [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) model with zero fuel usage, and applying the `POWER-FROM-SHORE` category. This is an intermediate solution and will be dealt with differently in the future. ::: ### Example -Make an [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) input file with zero fuel usage. +Make an [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) input file with zero fuel usage. ~~~~~~~~text POWER, FUEL @@ -73,8 +73,8 @@ POWER, FUEL 50, 0 ~~~~~~~~ -Specify [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) under -[FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS). +Specify [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) under +[FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md). ~~~~~~~~yaml FACILITY_INPUTS: @@ -83,8 +83,8 @@ FACILITY_INPUTS: FILE: genset_pfs.csv ~~~~~~~~ -Use the `POWER-FROM-SHORE` category and the [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) -specified under [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS). +Use the `POWER-FROM-SHORE` category and the [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) +specified under [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md). ~~~~~~~~yaml GENERATORSETS: @@ -114,12 +114,12 @@ GENERATORSETS: ### Description :::note Heaters and boilers should be modeled in eCalc™ as -[GENERATORSETS](../../../references/keywords/GENERATORSETS), applying the [HEATER](../../../references/keywords/CATEGORY) and [BOILER](../../../references/keywords/CATEGORY) categories. This is an intermediate solution and may be dealt with differently in the future. +[GENERATORSETS](/about/references/keywords/GENERATORSETS.md), applying the [HEATER](/about/references/keywords/CATEGORY.md) and [BOILER](/about/references/keywords/CATEGORY.md) categories. This is an intermediate solution and may be dealt with differently in the future. ::: ### Example: Boiler as generator set Specify the correlation between energy delivered and fuel consumed under -[FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS): +[FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md): ~~~~~~~~yaml FACILITY_INPUTS: - NAME: boiler_energy_fuel @@ -127,8 +127,8 @@ FACILITY_INPUTS: FILE: boiler_energy_fuel.csv ~~~~~~~~ -Use the `BOILER` category and the [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) -specified under [FACILITY_INPUTS](../../../references/keywords/FACILITY_INPUTS): +Use the `BOILER` category and the [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) +specified under [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md): ~~~~~~~~yaml GENERATORSETS: diff --git a/docs/docs/about/modelling/setup/installations/index.md b/docs/docs/about/modelling/setup/installations/index.md index 80933b97f8..bb8f5968b7 100644 --- a/docs/docs/about/modelling/setup/installations/index.md +++ b/docs/docs/about/modelling/setup/installations/index.md @@ -5,20 +5,20 @@ description: Guide on how to use installations --- :::note -The [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) keyword is **mandatory** within the eCalc™ YAML file. +The [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) keyword is **mandatory** within the eCalc™ YAML file. ::: -In [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) the system of energy consumers is described. Installations, in this setting, are typically the different platforms and production units for a field, group of fields, or area. Mobile units (such as drilling rigs) are also modelled as an installation. +In [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) the system of energy consumers is described. Installations, in this setting, are typically the different platforms and production units for a field, group of fields, or area. Mobile units (such as drilling rigs) are also modelled as an installation. * Essentially installations on which fuel is burned to generate energy for the consumers. -The structure of the keywords under [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) +The structure of the keywords under [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) is linked to the structure in the general consumer overview for an installation. -[CATEGORY](../../../references/keywords/CATEGORY) is optional, and generally reserved for use with LTP. +[CATEGORY](/about/references/keywords/CATEGORY.md) is optional, and generally reserved for use with LTP. ### Referring to time series -In the installations set up, one may refer to variables from [TIME_SERIES](../../../references/keywords/TIME_SERIES.md) +In the installations set up, one may refer to variables from [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) in many places by using `expressions` to build up custom, or changing, configurations. Referring to variables is done on the format: @@ -27,13 +27,13 @@ Referring to variables is done on the format: ; ~~~~~~~~ -where `` must be defined in [TIME_SERIES](../time_series), defining the time series input source +where `` must be defined in [TIME_SERIES](/about/modelling/setup/time_series.md), defining the time series input source (e.g., CSV file), and `` is the name of the variable. -See [TIME SERIES](../time_series) for more examples +See [TIME SERIES](/about/modelling/setup/time_series.md) for more examples ### Time intervals for variables/expressions and models -For various reasons, the data in the [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) section may vary in time. +For various reasons, the data in the [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) section may vary in time. The consumers may need to be modeled differently due to rebuilds or degeneration. It could be that the user wants to make a simple model for some periods and a more detailed model for others (e.g., a rate only model early time periods and a pressure dependent model in the field's late life). @@ -46,9 +46,9 @@ this date and the next entered date. See `Time intervals` for an example. When time dependency is used, the values before the first time default to 0 (zero) ::: -* [HCEXPORT](../../../references/keywords/HCEXPORT) is zero before the first time given. -* [ELECTRICITY2FUEL](../../../references/keywords/ELECTRICITY2FUEL) will have 0 fuel usage before the first time defined, despite a non-zero power load. -* [FUEL](../../../references/keywords/FUEL): The fuel rate will be 0 before the first entered date. +* [HCEXPORT](/about/references/keywords/HCEXPORT.md) is zero before the first time given. +* [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) will have 0 fuel usage before the first time defined, despite a non-zero power load. +* [FUEL](/about/references/keywords/FUEL.md): The fuel rate will be 0 before the first entered date. * Consumer energy consumption will be 0 before the first defined time. ## Format @@ -90,7 +90,7 @@ INSTALLATIONS SIM;OIL_PROD ~~~~~~~~ -`SIM` is the key defined in [TIME_SERIES](../../../references/keywords/TIME_SERIES.md). +`SIM` is the key defined in [TIME_SERIES](/about/references/keywords/TIME_SERIES.md). The user can define expressions of variables, see `expressions` for details. The following is an example of using expressions: @@ -103,7 +103,7 @@ SIM1;WATER_PROD:FIELD_A {+} SIM2;WATER_PROD:FIELD_B This is not a problem and handled by eCalc automatically. ### Time intervals -This example uses the [HCEXPORT](../../../references/keywords/HCEXPORT) keyword. +This example uses the [HCEXPORT](/about/references/keywords/HCEXPORT.md) keyword. **Example: same expression for the entire time frame** diff --git a/docs/docs/about/modelling/setup/installations/pump_models_in_calculations.md b/docs/docs/about/modelling/setup/installations/pump_models_in_calculations.md index 1604be717d..230bff2cca 100644 --- a/docs/docs/about/modelling/setup/installations/pump_models_in_calculations.md +++ b/docs/docs/about/modelling/setup/installations/pump_models_in_calculations.md @@ -5,12 +5,12 @@ description: Using pumps in calculations --- # Pump models in calculations -Pump charts are defined in the [FACILITY_INPUTS](../facility_inputs/index.md) section, and is then referred to from an -[ENERGY_USAGE_MODEL](../../../references/keywords/ENERGY_USAGE_MODEL). +Pump charts are defined in the [FACILITY_INPUTS](/about/modelling/setup/facility_inputs/index.md) section, and is then referred to from an +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md). ## PUMP energy usage model To configure a single pump, the pump rate, suction- and discharge pressures and fluid density must be given as inputs. In addition, a reference to a pump chart defined in the -[FACILITY_INPUTS](../facility_inputs/pump_modelling/pump_charts) section has to be included. +[FACILITY_INPUTS](/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md) section has to be included. ### Format ~~~~~~~~yaml diff --git a/docs/docs/about/modelling/setup/installations/tabular_models_in_calculations.md b/docs/docs/about/modelling/setup/installations/tabular_models_in_calculations.md index 95e290e848..b6d646bc31 100644 --- a/docs/docs/about/modelling/setup/installations/tabular_models_in_calculations.md +++ b/docs/docs/about/modelling/setup/installations/tabular_models_in_calculations.md @@ -40,7 +40,7 @@ ENERGY_USAGE_MODEL: Consumer energy function for the compressor (or compressor train) is in a tabulated format, where each line is a point defining the energy consumption for the given variables. -See [Sampled compressor model](../facility_inputs/sampled_compressor_model) for details. +See [Sampled compressor model](/about/modelling/setup/facility_inputs/sampled_compressor_model.md) for details. As a single compressor/compressor train (no system), it can be set up in the following way: diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md index fdc45dbb83..72e3c7766a 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md @@ -15,7 +15,7 @@ compressor chart ## User defined single speed compressor chart -The single speed chart type allows a single compressor curve for one speed, using the keyword [CURVE](../../../../../references/keywords/CURVE.md) +The single speed chart type allows a single compressor curve for one speed, using the keyword [CURVE](/about/references/keywords/CURVE.md) ### Format ~~~~~~~~yaml @@ -69,7 +69,7 @@ CURVE: ~~~~~~~~ ::: ## User defined variable speed compressor chart -The variable speed chart type allows a fully defined compressor chart with data for two or more speeds, using the keyword [CURVES](../../../../../references/keywords/CURVES.md). The upper and +The variable speed chart type allows a fully defined compressor chart with data for two or more speeds, using the keyword [CURVES](/about/references/keywords/CURVES.md). The upper and lower speed curves will be interpreted as the speed capacity limits for the chart. Whilst the lowest rate points on each of the upper and lower speed curves will define the minimum flow line for the compressor. @@ -261,7 +261,7 @@ speed curves in the compressor chart, to find how much the minimum flow should b flow will be the same for all speed curves. The corresponding head and efficiency values for the new minimum flow rate is found by interpolation along the speed curves. The same compressor chart can be used for multiple compressor stages, but with different surge control margins. Hence, the surge control margin is defined when setting up the stages in a -[`Variable speed compressor train model`](../compressor_models_types/variable_speed_compressor_train_model.md) or [`Variable speed compressor train model with multiple streams and pressures`](../compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md). +[`Variable speed compressor train model`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md) or [`Variable speed compressor train model with multiple streams and pressures`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md). ### Format ~~~~~~~~yaml diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md index feaf91f84a..2818c4d065 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md @@ -6,7 +6,7 @@ sidebar_position: 2 This section outlines the various compressor train types that are available in eCalc™. These are as follows: -- [`Single speed compressor train model`](single_speed_compressor_train_model.md) -- [`Variable speed compressor train model`](variable_speed_compressor_train_model.md) -- [`Simplified variable speed compressor train model`](simplified_variable_speed_compressor_train_model.md) -- [`Variable speed compressor train model with multiple streams and pressures`](variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) \ No newline at end of file +- [`Single speed compressor train model`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md) +- [`Variable speed compressor train model`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md) +- [`Simplified variable speed compressor train model`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md) +- [`Variable speed compressor train model with multiple streams and pressures`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) \ No newline at end of file diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md index 446d418e82..bce40be0dc 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md @@ -9,9 +9,9 @@ calculated independently for each compressor as if it was a standalone compresso the same shaft and thus have a common speed. This model supports both `user defined compressor charts` and -`generic compressor charts`. See [compressor charts](../compressor_charts/index.md) for more information. +`generic compressor charts`. See [compressor charts](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md) for more information. -In addition, a [FLUID MODEL](../../fluid_model) must be specified. +In addition, a [FLUID MODEL](/about/modelling/setup/models/fluid_model.md) must be specified. The model comes in two versions, one where the compressor stages are known (pre defined), and one where the compressor stages are calculated at run-time based on input data. diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md index 98fa364b60..02d25c0cab 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md @@ -13,12 +13,12 @@ This means that a single speed compressor model needs the following to be define - A polytropic compressor chart for every compressor stage in the compressor train. For single speed trains, eCalc only supports user defined single speed compressor charts. -- A [FLUID MODEL](../../fluid_model). -- A [PRESSURE_CONTROL](../fixed_speed_pressure_control/index.md). +- A [FLUID MODEL](/about/modelling/setup/models/fluid_model.md). +- A [PRESSURE_CONTROL](/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md). -The model is defined under the main keyword [MODELS](../../../../../references/keywords/MODELS) in the format +The model is defined under the main keyword [MODELS](/about/references/keywords/MODELS.md) in the format ## Format diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md index 3068f9c1a3..73af1677e3 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md @@ -9,7 +9,7 @@ outlet is equal to the requested discharge pressure. This model only supports `User defined variable speed compressor chart`. -In addition, a [FLUID MODEL](../../fluid_model) must be specified. +In addition, a [FLUID MODEL](/about/modelling/setup/models/fluid_model.md) must be specified. **Control mechanisms** @@ -22,7 +22,7 @@ The variable speed comporessor train model has the following automatic control m ![](control_mech_variable_speed.PNG) **Format** -The model is defined under the main keyword [MODELS](../../../../../references/keywords/MODELS) in the format +The model is defined under the main keyword [MODELS](/about/references/keywords/MODELS.md) in the format ~~~~~~~~yaml MODELS: diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md index 2317e3d500..6b13751916 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md @@ -9,7 +9,7 @@ This compressor type is a more advanced model which covers compressor trains whi ## Format -The model is defined under the main keyword [MODELS](../../../../../references/keywords/MODELS) in the format: +The model is defined under the main keyword [MODELS](/about/references/keywords/MODELS.md) in the format: ~~~~~~~~yaml MODELS: @@ -58,7 +58,7 @@ MODELS: ## Keyword usage -- [STREAMS](../../../../../references/keywords/STREAMS.md) is a list of all in- and out-going streams for the compressor train. +- [STREAMS](/about/references/keywords/STREAMS.md) is a list of all in- and out-going streams for the compressor train. - The same equation of state (EOS) must be used for each INGOING stream fluid models - OUTGOING fluid models **cannot** be specified. @@ -76,14 +76,14 @@ be subtracted the rate of the outgoing stream. - `PRESSURE_DROP_AHEAD_OF_STAGE` is optional, but if defined it will reduce the inlet pressure of that particular stage by a fixed value. As of now, only a single value is supported - i.e. a time series cannot be used here. -- `CONTROL_MARGIN` is a surge control margin, see [Surge control margin for variable speed compressor chart](../compressor_charts/index.md). +- `CONTROL_MARGIN` is a surge control margin, see [Surge control margin for variable speed compressor chart](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md). - `CONTROL_MARGIN_UNIT` is the unit of the surge control margin. ### INTERSTAGE_PRESSURE_CONTROL :::note -`INTERSTAGE_CONTROL_PRESSURE` may be specified for one (only one!) of the stages 2, ..., N. It may **not** be specified for the first stage. See [INTERSTAGE_CONTROL_PRESSURE](../../../../../references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) for more usage details +`INTERSTAGE_CONTROL_PRESSURE` may be specified for one (only one!) of the stages 2, ..., N. It may **not** be specified for the first stage. See [INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) for more usage details ::: This is optional but essentially when this is specified the compression train is split into two parts - before and after the `INTERSTAGE_CONTROL_PRESSURE`. As all rates and pressures (suction, discharge and interstage) are known, each side of the compression train can be solved independently. @@ -92,7 +92,7 @@ Thus, given this, the rotational speed needed to match the suction and interstag The highest speed between the first and second parts of the train is then taken as the rotational speed of the compression train. This speed will essentially be needed to meet the most demanding pressure interval. -The section with the lower rotational speed must then be run with a form of pressure control (see [UPSTREAM_PRESSURE_CONTROL](../../../../../references/keywords/UPSTREAM_PRESSURE_CONTROL.md)/[DOWNSTREAM_PRESSURE_CONTROL](../../../../../references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md)). +The section with the lower rotational speed must then be run with a form of pressure control (see [UPSTREAM_PRESSURE_CONTROL](/about/references/keywords/UPSTREAM_PRESSURE_CONTROL.md)/[DOWNSTREAM_PRESSURE_CONTROL](/about/references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md)). In a given simulation, the section of the compression train that requires either upstream or downstream pressure control is not fixed. This means that for different time steps, the part of the train with the highest rotational speed is not set to either the first or second section. Thus, both pressure control methods must be specified but only one of them will be used for each time step. @@ -116,7 +116,7 @@ determined from the other sub-train. The inlet and outlet pressures for a sub-tr and the interstage control pressure or interstage control pressure and the discharge pressure, depending on which sub part governs the speed of the full train. -See [FIXED PRESSURE CONTROL](../fixed_speed_pressure_control/index.md) for more details. +See [FIXED PRESSURE CONTROL](/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md) for more details. ## Example diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md b/docs/docs/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md index e48f0cdb43..4a697b4daa 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/fixed_speed_pressure_control/index.md @@ -9,7 +9,7 @@ description: Introduction to fixed speed pressure control ## Theory Compressors are typically controlled by changing the rotational speed of the compressor train shaft, which can either increase or decrease the work performed. -In the case where this is not possible ([single speed compressors](../compressor_models_types/single_speed_compressor_train_model.md)), or this is not sufficient to control the compressor, other methods of control need to be used. +In the case where this is not possible ([single speed compressors](/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md)), or this is not sufficient to control the compressor, other methods of control need to be used. In eCalc™, there are three main compressor control methods considered (aside from rotational speed control), these are: - Upstream choking/throttling @@ -43,11 +43,11 @@ This will further be elaborated upon in the [recirculation options](index.md#pre Some scenarios where additional pressure control is required can be when: -- The compressor train only operates at one speed ([SINGLE_SPEED_COMPRESSOR_TRAIN](../compressor_models_types/single_speed_compressor_train_model.md)), +- The compressor train only operates at one speed ([SINGLE_SPEED_COMPRESSOR_TRAIN](/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md)), and the given rate and suction pressure gives a too high discharge pressure. -- The compressor train is a [VARIABLE_SPEED_COMPRESSOR_TRAIN](../compressor_models_types/variable_speed_compressor_train_model.md), +- The compressor train is a [VARIABLE_SPEED_COMPRESSOR_TRAIN](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md), but it already operates at the minimum speed, and still the discharge pressure is too high. -- The compressor train is a [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](../compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) +- The compressor train is a [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) required to meet an export pressure, before compressing gas further for injection. Here the rotational speed required to bring the gas from inlet pressure to export pressure may be higher than the speed required to bring the gas from export pressure to discharge pressure. Hence, the rotational speed giving diff --git a/docs/docs/about/modelling/setup/models/compressor_modelling/index.md b/docs/docs/about/modelling/setup/models/compressor_modelling/index.md index cb9e7fdcdb..10c69ba17e 100644 --- a/docs/docs/about/modelling/setup/models/compressor_modelling/index.md +++ b/docs/docs/about/modelling/setup/models/compressor_modelling/index.md @@ -13,19 +13,19 @@ manifold from which the gas is distributed between these in different operationa In eCalc™, single compressors and compressor trains are modeled the same way, a single compressor is just a train with just one stage. There are multiple modeling options for compressor trains: -- [`Sampled compressor model`](../../facility_inputs/sampled_compressor_model): The compressor model is setup in an external tool, and this model is sampled by +- [`Sampled compressor model`](/about/modelling/setup/facility_inputs/sampled_compressor_model.md): The compressor model is setup in an external tool, and this model is sampled by running a point set of rates and pressures which span the operational area of the compressor train. The sampled data (rates, inlet pressures, outlet pressures and total energy usage for all stages) are specified in a csv file and input to eCalc™. Note, this is **not** inputted in the `MODELS` section, rather in the [FACILITY_INPUTS](../../facility_inputs/index.md) section -- [`Single speed compressor train model`](compressor_models_types/single_speed_compressor_train_model.md): The compressor train modeling is done in eCalc™. This model requires a fluid to be specified and a polytropic compressor chart for each compressor stage. In addition, since the speed is fixed, defining a pressure control method is required. This pressure control is used to meet the required discharge pressure. -- [`Variable speed compressor train model`](compressor_models_types/variable_speed_compressor_train_model.md): The compressor train modelling is done in eCalc™. This model requires a fluid to be specified and a polytropic compressor chart for each compressor stage. -- [`Simplified variable speed compressor train model`](compressor_models_types/simplified_variable_speed_compressor_train_model.md): Model the same compressor train as the above, but is more +- [`Single speed compressor train model`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md): The compressor train modeling is done in eCalc™. This model requires a fluid to be specified and a polytropic compressor chart for each compressor stage. In addition, since the speed is fixed, defining a pressure control method is required. This pressure control is used to meet the required discharge pressure. +- [`Variable speed compressor train model`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model.md): The compressor train modelling is done in eCalc™. This model requires a fluid to be specified and a polytropic compressor chart for each compressor stage. +- [`Simplified variable speed compressor train model`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/simplified_variable_speed_compressor_train_model.md): Model the same compressor train as the above, but is more lightweight in that instead of iterating to meet the requested discharge pressure, it assumes all stages has equal pressure fractions and solves for each stage independently. As the shaft speed is not used in the calculations, this - model supports using generic compressor charts, see the [`Compressor charts`](compressor_charts/index.md) section. -- [`Variable speed compressor train model with multiple streams and pressures`](compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md): This is a more complex model, where it is + model supports using generic compressor charts, see the [`Compressor charts`](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md) section. +- [`Variable speed compressor train model with multiple streams and pressures`](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md): This is a more complex model, where it is possible to define fluid streams going in and out at different stages in the compressor train. Also, an additional pressure requirement may be specified between two stages. This model is suitable in cases where for example a part of the fluid stream is taken out after one stage at a specified pressure for export, and the rest is further compressed for injection at a higher pressure. -Core theory behind the modelling of compressors in eCalc™ can be found [here](../../../theory/compressor_modelling). +Core theory behind the modelling of compressors in eCalc™ can be found [here](/about/modelling/theory/compressor_modelling.md). diff --git a/docs/docs/about/modelling/setup/models/index.md b/docs/docs/about/modelling/setup/models/index.md index 28bc2347e4..ee2ec27e48 100644 --- a/docs/docs/about/modelling/setup/models/index.md +++ b/docs/docs/about/modelling/setup/models/index.md @@ -5,7 +5,7 @@ description: Guide on how to use models in eCalc™ --- :::note -The [MODELS](../../../references/keywords/MODELS) keyword is **optional** for an eCalc™ model to run. However, it is critical for compressor and turbine modelling. +The [MODELS](/about/references/keywords/MODELS.md) keyword is **optional** for an eCalc™ model to run. However, it is critical for compressor and turbine modelling. ::: This part of the setup defines input files that characterize various fluid, compressor and turbine models. These are later used as input in the [INSTALLATIONS](../../../references/keywords/INSTALLATIONS) part of the setup by referencing their [NAME](../../../references/keywords/NAME). diff --git a/docs/docs/about/modelling/setup/time_series.md b/docs/docs/about/modelling/setup/time_series.md index 4cebbe915f..bad2dd7fdb 100644 --- a/docs/docs/about/modelling/setup/time_series.md +++ b/docs/docs/about/modelling/setup/time_series.md @@ -5,7 +5,7 @@ description: Time series guide and description --- :::note -The [TIME_SERIES](../../references/keywords/TIME_SERIES.md) keyword is **mandatory** within the eCalc™ YAML file. +The [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) keyword is **mandatory** within the eCalc™ YAML file. ::: This part of the setup file defines the inputs for time dependent variables, or "reservoir @@ -16,7 +16,7 @@ For example, a field may have a reservoir simulation model for some areas and de the reservoir. There may also be tie-ins which are affecting the energy/emissions on the field installations. Also, there may be time profiles for fuel prices, emission tax, etc. Therefore, a set of sources may be specified with a name, path to data and type. The name is -later referred to in the system of energy consumers defined under [INSTALLATIONS](../../references/keywords/INSTALLATIONS). +later referred to in the system of energy consumers defined under [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md). Reservoir variables and other time varying data not coming from a reservoir simulation model can be specified in a [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) file. @@ -33,7 +33,7 @@ The supported time series types are: | MISCELLANEOUS | .csv | Mandatory input:
`LEFT`/`RIGHT`/`LINEAR` | | ## Format -Each line under [TIME_SERIES](../../references/keywords/TIME_SERIES.md) has the format: +Each line under [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) has the format: ~~~~~~~~yaml TIME_SERIES: @@ -45,14 +45,14 @@ TIME_SERIES: INTERPOLATION_TYPE: ~~~~~~~~ -The input data is expected to be in metric units. The [NAME](../../references/keywords/NAME) is later referred -to in the [INSTALLATIONS](../../references/keywords/INSTALLATIONS) part of the setup file. -[INFLUENCE_TIME_VECTOR](../../references/keywords/INFLUENCE_TIME_VECTOR), [EXTRAPOLATION](../../references/keywords/EXTRAPOLATION) -and [INTERPOLATION_TYPE](../../references/keywords/INTERPOLATION_TYPE) may have default values set depending -on the choice of [TYPE](../../references/keywords/TYPE). See the documentation for each keyword for details. +The input data is expected to be in metric units. The [NAME](/about/references/keywords/NAME.md) is later referred +to in the [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) part of the setup file. +[INFLUENCE_TIME_VECTOR](/about/references/keywords/INFLUENCE_TIME_VECTOR.md), [EXTRAPOLATION](/about/references/keywords/EXTRAPOLATION.md) +and [INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md) may have default values set depending +on the choice of [TYPE](/about/references/keywords/TYPE.md). See the documentation for each keyword for details. ### Requirements -- At least one input source with [INFLUENCE_TIME_VECTOR](../../references/keywords/INFLUENCE_TIME_VECTOR) set to True. +- At least one input source with [INFLUENCE_TIME_VECTOR](/about/references/keywords/INFLUENCE_TIME_VECTOR.md) set to True. - Must include sources referred to in the variables for each consumer. ## Example diff --git a/docs/docs/about/modelling/setup/variables.md b/docs/docs/about/modelling/setup/variables.md index e1a83e9667..1d3ee7e18a 100644 --- a/docs/docs/about/modelling/setup/variables.md +++ b/docs/docs/about/modelling/setup/variables.md @@ -5,7 +5,7 @@ description: Variables guide and description --- :::note -The [VARIABLES](../../references/keywords/VARIABLES) keyword is **optional** for an eCalc™ model to run. +The [VARIABLES](/about/references/keywords/VARIABLES.md) keyword is **optional** for an eCalc™ model to run. ::: ## Defining variables @@ -52,7 +52,7 @@ Variables can be used in any expression throughout the YAML file and can even be ### Example -Using variables in the [INSTALLATION](installations/index.md) section: +Using variables in the [INSTALLATION](/about/modelling/setup/installations/index.md) section: ~~~~yaml VARIABLES: diff --git a/docs/docs/about/modelling/theory/compressor_modelling.md b/docs/docs/about/modelling/theory/compressor_modelling.md index eb4776b874..36dc0b0ee7 100644 --- a/docs/docs/about/modelling/theory/compressor_modelling.md +++ b/docs/docs/about/modelling/theory/compressor_modelling.md @@ -11,7 +11,7 @@ At the suction side, one need information about the fluid (natural gas) which ha composition, a specified rate, a temperature and a pressure. As the fluid is going through the compressor in a fluid dynamic process, the enthalpy changes, resulting in a new state and both the pressure and the temperature of the fluid is increased, while the volume is decreased. This change is calculated using an -equation-of-state (EOS) model. See [`Fluid model`](../setup/models/fluid_model) +equation-of-state (EOS) model. See [`Fluid model`](/about/modelling/setup/models/fluid_model.md) ![](process_compressor.png) diff --git a/docs/docs/about/modelling/workflow/generic_workflow.md b/docs/docs/about/modelling/workflow/generic_workflow.md index 303a9515b4..8cd4271b9c 100644 --- a/docs/docs/about/modelling/workflow/generic_workflow.md +++ b/docs/docs/about/modelling/workflow/generic_workflow.md @@ -157,4 +157,4 @@ Validity can be checked by consumer, and there are often specific reasons why ce The term calibration in eCalc™ often refers to the history matching of the facility. Essentially, real operational data is compared against the eCalc™ model results. If they do not correlate various changes are made to the model. The main workflow with this would be to match every individual consumer, e.g. each pump and compressor. After that, it is the recommended to compare on the facility level (e.g. total power consumed or total fuel used), then various adjustments can be made. -These adjustments can mean changes to the base load, shifting the compressor curves, or simply by using a [POWERLOSSFACTOR](../../references/keywords/POWERLOSSFACTOR.md). \ No newline at end of file +These adjustments can mean changes to the base load, shifting the compressor curves, or simply by using a [POWERLOSSFACTOR](/about/references/keywords/POWERLOSSFACTOR.md). \ No newline at end of file diff --git a/docs/docs/about/references/keywords/CATEGORY.md b/docs/docs/about/references/keywords/CATEGORY.md index de1be86610..5f2d00bce6 100644 --- a/docs/docs/about/references/keywords/CATEGORY.md +++ b/docs/docs/about/references/keywords/CATEGORY.md @@ -1,24 +1,24 @@ # CATEGORY -[eCalc Model](../index.md) -/ [INSTALLATIONS](INSTALLATIONS) -/ [...] / [CATEGORY](CATEGORY) +[eCalc Model](/about/references/index.md) +/ [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) +/ [...] / [CATEGORY](/about/references/keywords/CATEGORY.md) -| Required | Child of | Children/Options | -|----------|---------------|------------------| -| Yes | [CONSUMERS](CONSUMERS)
[FUELCONSUMERS](FUELCONSUMERS)
[INSTALLATIONS](INSTALLATIONS)
[FUEL_TYPES](FUEL_TYPES)
| None | +| Required | Child of | Children/Options | +|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| Yes | [CONSUMERS](/about/references/keywords/CONSUMERS.md)
[FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md)
[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md)
[FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md)
| None | ## Description -The [CATEGORY](CATEGORY) keyword is used to specify which category certain data types belong to - these data types are: +The [CATEGORY](/about/references/keywords/CATEGORY.md) keyword is used to specify which category certain data types belong to - these data types are: -* [CONSUMERS](CONSUMERS) and [FUELCONSUMERS](FUELCONSUMERS): Required -* [INSTALLATIONS](INSTALLATIONS.md): Optional -* [FUEL_TYPE](FUEL_TYPES.md): Optional +* [CONSUMERS](/about/references/keywords/CONSUMERS.md) and [FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md): Required +* [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md): Optional +* [FUEL_TYPE](/about/references/keywords/FUEL_TYPES.md): Optional Only a limited pre-defined set of categories is valid input to the -[CATEGORY](CATEGORY) keyword. The complete list of possible categories is given below. +[CATEGORY](/about/references/keywords/CATEGORY.md) keyword. The complete list of possible categories is given below. Please note that the input is case-sensitive. The names should be in upper-case and the spelling/dash must match the names in the list exactly. -Allowed categories for [CONSUMERS](CONSUMERS) and [FUELCONSUMERS](FUELCONSUMERS): +Allowed categories for [CONSUMERS](/about/references/keywords/CONSUMERS.md) and [FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md): | Category | Description/Examples | |-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -39,14 +39,14 @@ Allowed categories for [CONSUMERS](CONSUMERS) and [FUELCONSUMERS](FUELCONSUMERS) | ``BOILER`` | Genset only. Indicate steam generated. New in **v8.2** | | ``HEATER`` | Genset only. Indicate hot medium generated. New in **v8.2** | -Allowed categories for [INSTALLATIONS](INSTALLATIONS): +Allowed categories for [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md): | Category | Description/Examples | |----------------------------|--------------------------------| | ``FIXED`` | Fixed installation | | ``MOBILE`` | Mobile/satellite installation. | -Allowed categories for [FUEL_TYPES](FUEL_TYPES): +Allowed categories for [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md): | Category | Description/Examples | |----------------------------|--------------------------------------------------------------| diff --git a/docs/docs/about/references/keywords/COMPRESSOR_MODEL.md b/docs/docs/about/references/keywords/COMPRESSOR_MODEL.md index ff1279ebcb..2803f25257 100644 --- a/docs/docs/about/references/keywords/COMPRESSOR_MODEL.md +++ b/docs/docs/about/references/keywords/COMPRESSOR_MODEL.md @@ -1,16 +1,16 @@ # COMPRESSOR_MODEL -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL.md) / [COMPRESSOR_MODEL](COMPRESSOR_MODEL.md) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / [COMPRESSOR_MODEL](/about/references/keywords/COMPRESSOR_MODEL.md) -| Required | Child of | Children/Options | -|----------|---------------|------------------| -| Yes | [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL.md) | None | +| Required | Child of | Children/Options | +|----------|------------------------------------------------------------------------|------------------| +| Yes | [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) | None | ## Description -This keyword links the predefined [COMPRESSOR MODEL](../../modelling/setup/models/compressor_modelling/compressor_models_types/index.md) to the [COMPRESSOR ENERGY USAGE MODEL](ENERGY_USAGE_MODEL.md). +This keyword links the predefined [COMPRESSOR MODEL](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md) to the [COMPRESSOR ENERGY USAGE MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md). -Note that this can **only** be used when a [COMPRESSOR SYSTEM](COMPRESSOR_SYSTEM.md) is used. It is possible to use the same compressor model twice in the same system - this is a common feature when there are identical compressor trains in parallel. +Note that this can **only** be used when a [COMPRESSOR SYSTEM](/about/references/keywords/COMPRESSOR_SYSTEM.md) is used. It is possible to use the same compressor model twice in the same system - this is a common feature when there are identical compressor trains in parallel. ## Format diff --git a/docs/docs/about/references/keywords/COMPRESSOR_SYSTEM.md b/docs/docs/about/references/keywords/COMPRESSOR_SYSTEM.md index 21da595f57..b19859d8a2 100644 --- a/docs/docs/about/references/keywords/COMPRESSOR_SYSTEM.md +++ b/docs/docs/about/references/keywords/COMPRESSOR_SYSTEM.md @@ -1,9 +1,9 @@ # COMPRESSORS -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[COMPRESSOR_SYSTEM](COMPRESSOR_SYSTEM) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[COMPRESSOR_SYSTEM](/about/references/keywords/COMPRESSOR_SYSTEM.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -12,9 +12,9 @@ ## Description Used to define a list of compressors in a compressor system model ( -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) of type `COMPRESSOR_SYSTEM`). +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) of type `COMPRESSOR_SYSTEM`). Each compressor is defined with a name and a reference to a compressor energy function defined in either -[FACILITY_INPUTS](FACILITY_INPUTS) or [MODELS](MODELS) +[FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) or [MODELS](/about/references/keywords/MODELS.md) ## Format ~~~~~~~~yaml @@ -27,7 +27,7 @@ ENERGY_USAGE_MODEL: OPERATIONAL_SETTINGS: ~~~~~~~~ -See [OPERATIONAL_SETTINGS](OPERATIONAL_SETTINGS) for details. +See [OPERATIONAL_SETTINGS](/about/references/keywords/OPERATIONAL_SETTINGS.md) for details. ## Example 1 ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md b/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md index b4433c2d21..433fc50d8b 100644 --- a/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md +++ b/docs/docs/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md @@ -1,18 +1,18 @@ # COMPRESSOR_TRAIN_MODEL -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[COMPRESSOR_TRAIN_MODEL](COMPRESSOR_TRAIN_MODEL) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[COMPRESSOR_TRAIN_MODEL](/about/references/keywords/COMPRESSOR_TRAIN_MODEL.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| | Yes | `ENERGY_USAGE_MODEL` | None | ## Description -Reference to an compressor train model defined in [FACILITY_INPUTS](FACILITY_INPUTS) or -[MODELS](MODELS) used for [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) -TYPE [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](ENERGY_USAGE_MODEL#variable_speed_compressor_train_multiple_streams_and_pressures-energy-usage-model). +Reference to an compressor train model defined in [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) or +[MODELS](/about/references/keywords/MODELS.md) used for [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) +TYPE [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](/about/references/keywords/ENERGY_USAGE_MODEL.md#variable_speed_compressor_train_multiple_streams_and_pressures-energy-usage-model). ## Format ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/CONDITION.md b/docs/docs/about/references/keywords/CONDITION.md index 3036f3efc1..66fdda33a3 100644 --- a/docs/docs/about/references/keywords/CONDITION.md +++ b/docs/docs/about/references/keywords/CONDITION.md @@ -1,23 +1,23 @@ # CONDITION -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[CONDITION](CONDITION) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[CONDITION](/about/references/keywords/CONDITION.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| | No | `ENERGY_USAGE_MODEL` | None | ## Description -All energy usage models may have a keyword [CONDITION](CONDITION) +All energy usage models may have a keyword [CONDITION](/about/references/keywords/CONDITION.md) which specifies conditions for the consumer to be used. At points in the time series where the condition evaluates to `0` (or `False`), the energy consumption will be `0`. This is practical for some otherwise constant consumers. For example, if you use the category `FIXED-PRODUCTION-LOAD` and you want it to depend on whether or not there is production, the `CONDITION` keyword can be specified. -`CONDITION` supports the functionality described in [Expressions](EXPRESSION), but is **required** to evaluate to `True/False` or `1/0`. +`CONDITION` supports the functionality described in [Expressions](/about/references/keywords/EXPRESSION.md), but is **required** to evaluate to `True/False` or `1/0`. ## Format ~~~~~~~~yaml @@ -35,4 +35,4 @@ A simple example is shown below where the load is only present whenever the oil CONDITION: SIM1;OIL_PROD:PLA > 0 ~~~~~~~~ -This condition is an expression. See [Expressions](EXPRESSION). +This condition is an expression. See [Expressions](/about/references/keywords/EXPRESSION.md). diff --git a/docs/docs/about/references/keywords/CONDITIONS.md b/docs/docs/about/references/keywords/CONDITIONS.md index 6320452576..62a0e035b7 100644 --- a/docs/docs/about/references/keywords/CONDITIONS.md +++ b/docs/docs/about/references/keywords/CONDITIONS.md @@ -1,16 +1,16 @@ # CONDITIONS -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[CONDITIONS](CONDITIONS) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[CONDITIONS](/about/references/keywords/CONDITIONS.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| | No | `ENERGY_USAGE_MODEL` | None | ## Description -See [CONDITION](CONDITION). +See [CONDITION](/about/references/keywords/CONDITION.md). ## Format ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/CONSUMERS.md b/docs/docs/about/references/keywords/CONSUMERS.md index 6fb1eca1fc..b74f128f30 100644 --- a/docs/docs/about/references/keywords/CONSUMERS.md +++ b/docs/docs/about/references/keywords/CONSUMERS.md @@ -1,16 +1,16 @@ # CONSUMERS -[INSTALLATIONS](INSTALLATIONS) / -[GENERATORSETS](GENERATORSETS.md) / -[CONSUMERS](CONSUMERS) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[GENERATORSETS](/about/references/keywords/GENERATORSETS.md) / +[CONSUMERS](/about/references/keywords/CONSUMERS.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| | Yes | `GENERATORSETS` | `CATEGORY`
`NAME`
`ENERGY_USAGE_MODEL` | ## Description -Consumers getting electrical power from the generator set. The attributes [NAME](NAME), -[CATEGORY](CATEGORY) and [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) +Consumers getting electrical power from the generator set. The attributes [NAME](/about/references/keywords/NAME.md), +[CATEGORY](/about/references/keywords/CATEGORY.md) and [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) are all required ## Format diff --git a/docs/docs/about/references/keywords/CONSUMPTION_RATE_TYPE.md b/docs/docs/about/references/keywords/CONSUMPTION_RATE_TYPE.md index 1fa7ac516a..ed377d2ff6 100644 --- a/docs/docs/about/references/keywords/CONSUMPTION_RATE_TYPE.md +++ b/docs/docs/about/references/keywords/CONSUMPTION_RATE_TYPE.md @@ -1,9 +1,9 @@ # CONSUMPTION_RATE_TYPE -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[CONSUMPTION_RATE_TYPE](CONSUMPTION_RATE_TYPE) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[CONSUMPTION_RATE_TYPE](/about/references/keywords/CONSUMPTION_RATE_TYPE.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -15,9 +15,9 @@ You must have good control of the input rates - which are stream day rates and w specify `CALENDAR_DAY` as input if necessary. ::: -When [REGULARITY](REGULARITY) is used,the consumption rate type may be specified for -`DIRECT ENERGY USAGE MODEL`([LOAD](LOAD) or [FUELRATE](FUELRATE)) -by setting [CONSUMPTION_RATE_TYPE](CONSUMPTION_RATE_TYPE) to either `CALENDAR_DAY` or +When [REGULARITY](/about/references/keywords/REGULARITY.md) is used,the consumption rate type may be specified for +`DIRECT ENERGY USAGE MODEL`([LOAD](/about/references/keywords/LOAD.md) or [FUELRATE](/about/references/keywords/FUELRATE.md)) +by setting [CONSUMPTION_RATE_TYPE](/about/references/keywords/CONSUMPTION_RATE_TYPE.md) to either `CALENDAR_DAY` or `STREAM_DAY`. The default behaviour, is that these will be interpreted as `STREAM_DAY` if not set explicitly. This will result in @@ -28,7 +28,7 @@ stream day when passed to the generator set calculation. `CALENDAR_DAY`: The average rate over a period after adjusting for operating conditions that keeps the average throughput below the maximum achievable throughput for a single day, known as stream day. -`STREAM_DAY`: The actual rate at a given moment. When multiplied with a [REGULARITY](REGULARITY) +`STREAM_DAY`: The actual rate at a given moment. When multiplied with a [REGULARITY](/about/references/keywords/REGULARITY.md) factor you get the calendar day rate which needs to be used when evaluating the economics of a process unit. $$ @@ -56,6 +56,6 @@ CONSUMPTION_RATE_TYPE: STREAM_DAY Given `CALENDAR_DAY` input the rate will be converted to `STREAM_DAY` when evaluating, and any fuel rate in output will be converted back again to `CALENDAR_DAY` rate equivalent in the results. -Given `STREAM_DAY` input, and a [REGULARITY](REGULARITY) factor of 0.5 (50%), the +Given `STREAM_DAY` input, and a [REGULARITY](/about/references/keywords/REGULARITY.md) factor of 0.5 (50%), the interpretation is that the process unit will run at full capacity half of the time. The resulting fuel rate reported for a fuel consumer will be halved compared to 1 (100%) regularity. diff --git a/docs/docs/about/references/keywords/CROSSOVER.md b/docs/docs/about/references/keywords/CROSSOVER.md index f8345ae5df..4698808ca6 100644 --- a/docs/docs/about/references/keywords/CROSSOVER.md +++ b/docs/docs/about/references/keywords/CROSSOVER.md @@ -1,12 +1,12 @@ # CROSSOVER -[INSTALLATIONS](INSTALLATIONS) / -[...] / [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL.md) / -[OPERATIONAL_SETTINGS](OPERATIONAL_SETTINGS.md) / [CROSSOVER](COMPRESSOR_MODEL.md) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[...] / [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[OPERATIONAL_SETTINGS](/about/references/keywords/OPERATIONAL_SETTINGS.md) / [CROSSOVER](/about/references/keywords/COMPRESSOR_MODEL.md) -| Required | Child of | Children/Options | -|----------|---------------|------------------| -| Yes | [OPERATIONAL_SETTINGS](OPERATIONAL_SETTINGS.md) | None | +| Required | Child of | Children/Options | +|----------|----------------------------------------------------------------------------|------------------| +| Yes | [OPERATIONAL_SETTINGS](/about/references/keywords/OPERATIONAL_SETTINGS.md) | None | ## Description diff --git a/docs/docs/about/references/keywords/CURVE.md b/docs/docs/about/references/keywords/CURVE.md index a9912f68c6..151fee4051 100644 --- a/docs/docs/about/references/keywords/CURVE.md +++ b/docs/docs/about/references/keywords/CURVE.md @@ -2,7 +2,7 @@ ## Description -When using a detailed single speed compressor model, it is necessary to specify the single speed [COMPRESSOR CHART](../../modelling/setup/models/compressor_modelling/compressor_charts/index.md#user-defined-single-speed-compressor-chart). This can be defined from a .csv file, or it can be defined directly in the YAML file. +When using a detailed single speed compressor model, it is necessary to specify the single speed [COMPRESSOR CHART](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md#user-defined-single-speed-compressor-chart). This can be defined from a .csv file, or it can be defined directly in the YAML file. In either case, the keyword `CURVE` needs to be used. If a .csv file is being used, under the `CURVE` keyword, `FILE` must be used. If specified directly in the YAML file, `SPEED`, `RATE`, `HEAD` and `EFFICIENCY` must be defined. ## Format diff --git a/docs/docs/about/references/keywords/CURVES.md b/docs/docs/about/references/keywords/CURVES.md index d1eb8a6ffe..2c44bacd28 100644 --- a/docs/docs/about/references/keywords/CURVES.md +++ b/docs/docs/about/references/keywords/CURVES.md @@ -2,7 +2,7 @@ ## Description -When using a detailed variable speed compressor model, it is necessary to specify the variable speed [COMPRESSOR CHART](../../modelling/setup/models/compressor_modelling/compressor_charts/index.md#user-defined-variable-speed-compressor-chart). This can be defined from a .csv file, or it can be defined directly in the YAML file. +When using a detailed variable speed compressor model, it is necessary to specify the variable speed [COMPRESSOR CHART](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md#user-defined-variable-speed-compressor-chart). This can be defined from a .csv file, or it can be defined directly in the YAML file. In either case, the keyword `CURVES` needs to be used, and curves for at least two different speeds must be defined. If a .csv file is being used, under the `CURVES` keyword, `FILE` must be used. If specified directly in the YAML file, `SPEED`, `RATE`, `HEAD` and `EFFICIENCY` must be defined for each speed. ## Format diff --git a/docs/docs/about/references/keywords/DIRECT_EMITTERS.md b/docs/docs/about/references/keywords/DIRECT_EMITTERS.md index fc5079ac0c..42df011e62 100644 --- a/docs/docs/about/references/keywords/DIRECT_EMITTERS.md +++ b/docs/docs/about/references/keywords/DIRECT_EMITTERS.md @@ -1,7 +1,7 @@ # DIRECT_EMITTERS -[INSTALLATIONS](INSTALLATIONS) / -[DIRECT_EMITTERS](DIRECT_EMITTERS) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[DIRECT_EMITTERS](/about/references/keywords/DIRECT_EMITTERS.md) | Required | Child of | Children/Options | @@ -10,10 +10,10 @@ ## Description -The [DIRECT_EMITTERS](DIRECT_EMITTERS) keyword covers the direct emissions on the installation -that are not consuming energy. The attributes [NAME](NAME), -[EMISSION_NAME](EMISSION_NAME), [CATEGORY](CATEGORY) and -[EMITTER_MODEL](EMITTER_MODEL) are required. +The [DIRECT_EMITTERS](/about/references/keywords/DIRECT_EMITTERS.md) keyword covers the direct emissions on the installation +that are not consuming energy. The attributes [NAME](/about/references/keywords/NAME.md), +[EMISSION_NAME](/about/references/keywords/EMISSION_NAME.md), [CATEGORY](/about/references/keywords/CATEGORY.md) and +[EMITTER_MODEL](/about/references/keywords/EMITTER_MODEL.md) are required. ## Format ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/DISCHARGE_PRESSURE.md b/docs/docs/about/references/keywords/DISCHARGE_PRESSURE.md index 6995c011b3..f55ed789c1 100644 --- a/docs/docs/about/references/keywords/DISCHARGE_PRESSURE.md +++ b/docs/docs/about/references/keywords/DISCHARGE_PRESSURE.md @@ -1,9 +1,9 @@ # DISCHARGE_PRESSURE -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[...] / [DISCHARGE_PRESSURE](DISCHARGE_PRESSURE) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[...] / [DISCHARGE_PRESSURE](/about/references/keywords/DISCHARGE_PRESSURE.md) | Required | Child of | Children/Options | |------------|----------------------------|------------------------------------| @@ -11,9 +11,9 @@ ## Description -Used to define the discharge pressure for some [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) - types and in [OPERATIONAL_SETTINGS](OPERATIONAL_SETTINGS) using an -[Expressions](EXPRESSION). +Used to define the discharge pressure for some [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) + types and in [OPERATIONAL_SETTINGS](/about/references/keywords/OPERATIONAL_SETTINGS.md) using an +[Expressions](/about/references/keywords/EXPRESSION.md). ## Format ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md b/docs/docs/about/references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md index d0c62e2444..ee2a61c25d 100644 --- a/docs/docs/about/references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md +++ b/docs/docs/about/references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md @@ -1,15 +1,15 @@ # DOWNSTREAM_PRESSURE_CONTROL -[MODELS](MODELS) / +[MODELS](/about/references/keywords/MODELS.md) / [...] / -[INTERSTAGE_CONTROL_PRESSURE](INTERSTAGE_CONTROL_PRESSURE) -/ [DOWNSTREAM_PRESSURE_CONTROL](DOWNSTREAM_PRESSURE_CONTROL) +[INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) +/ [DOWNSTREAM_PRESSURE_CONTROL](/about/references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md) ## Description -This keyword is used only for `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` type. It is used within the [INTERSTAGE_CONTROL_PRESSURE](INTERSTAGE_CONTROL_PRESSURE) keyword. +This keyword is used only for `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` type. It is used within the [INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) keyword. The pressure control method downstream (after) the interstage pressure is specified in this keyword. -For more explanation see [Variable speed compressor train model with multiple streams and pressures](../../modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures). +For more explanation see [Variable speed compressor train model with multiple streams and pressures](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md). ## Format diff --git a/docs/docs/about/references/keywords/EFFICIENCY.md b/docs/docs/about/references/keywords/EFFICIENCY.md index 46c25f05bf..59971ba47d 100644 --- a/docs/docs/about/references/keywords/EFFICIENCY.md +++ b/docs/docs/about/references/keywords/EFFICIENCY.md @@ -2,7 +2,7 @@ ## Description -`EFFICIENCY` is a keyword that is used defining [PUMP](../../modelling/setup/facility_inputs/pump_modelling/pump_charts) and [COMPRESSOR CHARTS](../../modelling/setup/models/compressor_modelling/compressor_charts/). +`EFFICIENCY` is a keyword that is used defining [PUMP](/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md) and [COMPRESSOR CHARTS](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md). Efficiency can either be given as a fraction or percentage. For compressors, it is used in two separate ways under the `MODELS` or section: diff --git a/docs/docs/about/references/keywords/ELECTRICITY2FUEL.md b/docs/docs/about/references/keywords/ELECTRICITY2FUEL.md index b0aedb68b0..6991b04bd1 100644 --- a/docs/docs/about/references/keywords/ELECTRICITY2FUEL.md +++ b/docs/docs/about/references/keywords/ELECTRICITY2FUEL.md @@ -1,15 +1,15 @@ # ELECTRICITY2FUEL -[INSTALLATIONS](INSTALLATIONS) / -[GENERATORSETS](GENERATORSETS.md) / -[ELECTRICITY2FUEL](ELECTRICITY2FUEL) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[GENERATORSETS](/about/references/keywords/GENERATORSETS.md) / +[ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| | Yes | `GENERATORSETS` | None | ## Description -[ELECTRICITY2FUEL](ELECTRICITY2FUEL) specifies the correlation between the electric power +[ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) specifies the correlation between the electric power delivered and the fuel consumed by a generator set. @@ -19,7 +19,7 @@ generator, the power vs. fuel usually makes a "jump" when the capacity of the ge exceeded and an additional generator is started. ::: -[ELECTRICITY2FUEL](ELECTRICITY2FUEL) may be modelled with a constant function through time or +[ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) may be modelled with a constant function through time or with different power vs. fuel relations for different time intervals. ## Format @@ -48,5 +48,5 @@ ELECTRICITY2FUEL: 2005-01-01: generatorset_electricity_to_fuel_reference2 ~~~~~~~~ -Where `generatorset_electricity_to_fuel_reference` is a [FACILITY_INPUTS](FACILITY_INPUTS) - of [TYPE](TYPE) `ELECTRICITY2FUEL`. +Where `generatorset_electricity_to_fuel_reference` is a [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) + of [TYPE](/about/references/keywords/TYPE.md) `ELECTRICITY2FUEL`. diff --git a/docs/docs/about/references/keywords/EMISSIONS.md b/docs/docs/about/references/keywords/EMISSIONS.md index cb1b817937..145b64138f 100644 --- a/docs/docs/about/references/keywords/EMISSIONS.md +++ b/docs/docs/about/references/keywords/EMISSIONS.md @@ -1,7 +1,7 @@ # EMISSIONS -[FUEL_TYPES](FUEL_TYPES) / -[EMISSIONS](EMISSIONS.md) +[FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) / +[EMISSIONS](/about/references/keywords/EMISSIONS.md) @@ -11,8 +11,8 @@ ## Description -In [EMISSIONS](EMISSIONS.md) one or more emissions related to the use of fuel is specified as -a list. Each emission entry is **required** to have a [NAME](NAME) and a [FACTOR](FACTOR). +In [EMISSIONS](/about/references/keywords/EMISSIONS.md) one or more emissions related to the use of fuel is specified as +a list. Each emission entry is **required** to have a [NAME](/about/references/keywords/NAME.md) and a [FACTOR](/about/references/keywords/FACTOR.mdx). The costs associated with emitting typically have two cost elements: @@ -37,7 +37,7 @@ EMISSIONS: ~~~~~~~~ ## Example -For example, if you want to add CO2 emissions associated to the usage of a [FUEL_TYPES](FUEL_TYPES) +For example, if you want to add CO2 emissions associated to the usage of a [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) you write the following: ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/EMISSION_NAME.md b/docs/docs/about/references/keywords/EMISSION_NAME.md index aad49137b5..16dd2f3ed7 100644 --- a/docs/docs/about/references/keywords/EMISSION_NAME.md +++ b/docs/docs/about/references/keywords/EMISSION_NAME.md @@ -1,7 +1,7 @@ # EMISSION_NAME [...] / -[EMISSION_NAME](EMISSION_NAME) +[EMISSION_NAME](/about/references/keywords/EMISSION_NAME.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -16,7 +16,7 @@ EMISSION_NAME: ~~~~~~~~ ## Example -Usage in [DIRECT_EMITTERS](DIRECT_EMITTERS): +Usage in [DIRECT_EMITTERS](/about/references/keywords/DIRECT_EMITTERS.md): ~~~~~~~~yaml DIRECT_EMITTERS: diff --git a/docs/docs/about/references/keywords/EMISSION_RATE.md b/docs/docs/about/references/keywords/EMISSION_RATE.md index e94ddaf626..a967fd6ae6 100644 --- a/docs/docs/about/references/keywords/EMISSION_RATE.md +++ b/docs/docs/about/references/keywords/EMISSION_RATE.md @@ -1,17 +1,17 @@ # EMISSION_RATE -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[EMITTER_MODEL](EMITTER_MODEL) / -[EMISSION_RATE](EMISSION_RATE) +[EMITTER_MODEL](/about/references/keywords/EMITTER_MODEL.md) / +[EMISSION_RATE](/about/references/keywords/EMISSION_RATE.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| | Yes | `EMITTER_MODEL` | None | ## Description -Used to define the emission rate for some [EMITTER_MODEL](EMITTER_MODEL) types -using an [Expressions](EXPRESSION) +Used to define the emission rate for some [EMITTER_MODEL](/about/references/keywords/EMITTER_MODEL.md) types +using an [Expressions](/about/references/keywords/EXPRESSION.md) ## Format ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/EMITTER_MODEL.md b/docs/docs/about/references/keywords/EMITTER_MODEL.md index 85db9c8f43..14864de3a1 100644 --- a/docs/docs/about/references/keywords/EMITTER_MODEL.md +++ b/docs/docs/about/references/keywords/EMITTER_MODEL.md @@ -1,8 +1,8 @@ # EMITTER_MODEL -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[EMITTER_MODEL](EMITTER_MODEL) +[EMITTER_MODEL](/about/references/keywords/EMITTER_MODEL.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -13,8 +13,8 @@ The emitter model specifies the data to calculate the direct emissions on an ins a function that may be evaluated for a set of time series and return a result including the emissions emitted and the related cost of the emissions. -The [EMISSION_RATE](EMISSION_RATE) describes the rate [kg/day] of emissions and -[QUOTA](QUOTA) specifies the cost of emission per rate of +The [EMISSION_RATE](/about/references/keywords/EMISSION_RATE.md) describes the rate [kg/day] of emissions and +[QUOTA](/about/references/keywords/QUOTA.md) specifies the cost of emission per rate of emission [NOK/kg]. Both are required. ## Format diff --git a/docs/docs/about/references/keywords/END.md b/docs/docs/about/references/keywords/END.md index b9c4687fc4..a4fa706ba5 100644 --- a/docs/docs/about/references/keywords/END.md +++ b/docs/docs/about/references/keywords/END.md @@ -1,6 +1,6 @@ # END -[END](END) +[END](/about/references/keywords/END.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -14,7 +14,7 @@ If you specify the end date as 2080-01-01, the last period to be calculated is 2 You can provide a date that is after the global time vector, but it is recommended to set it to the end of your timeseries data. Normally the timeseries do not provide this information directly. The last timestep provided in a timeseries is e.g. 2079-01-01, which would often mean that the data changed at that point, and will e.g. be valid 1 year from then (if we work with YEARLY output frequency). To make sure that eCalc stops at the correct place, you should therefore specify the exclusive date of the data. -The [START](START) keyword have similar behaviour. +The [START](/about/references/keywords/START.md) keyword have similar behaviour. If END is not specified, eCalc will make an educated (but possibly incorrect) *guess* on when the output data should end. diff --git a/docs/docs/about/references/keywords/ENERGYFUNCTION.md b/docs/docs/about/references/keywords/ENERGYFUNCTION.md index d945a86aa6..0a0de95243 100644 --- a/docs/docs/about/references/keywords/ENERGYFUNCTION.md +++ b/docs/docs/about/references/keywords/ENERGYFUNCTION.md @@ -1,9 +1,9 @@ # ENERGYFUNCTION -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[ENERGYFUNCTION](ENERGYFUNCTION) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[ENERGYFUNCTION](/about/references/keywords/ENERGYFUNCTION.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -11,12 +11,12 @@ ## Description -This refers to an energy function model defined in either [FACILITY INPUTS](FACILITY_INPUTS.md) or in [MODELS](MODELS.md) used for [ENERGY USAGE MODEL](ENERGY_USAGE_MODEL.md). +This refers to an energy function model defined in either [FACILITY INPUTS](/about/references/keywords/FACILITY_INPUTS.md) or in [MODELS](/about/references/keywords/MODELS.md) used for [ENERGY USAGE MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md). The following attributes can be utilised: -* [COMPRESSOR MODEL](../../modelling/setup/installations/compressor_models_in_calculations/index.md) -* [PUMP ENERGY USAGE MODEL](../../modelling/setup/installations/pump_models_in_calculations) -* [TABULATED ENERGY USAGE MODEL](ENERGY_USAGE_MODEL.md) +* [COMPRESSOR MODEL](/about/modelling/setup/installations/compressor_models_in_calculations/index.md) +* [PUMP ENERGY USAGE MODEL](/about/modelling/setup/installations/pump_models_in_calculations.md) +* [TABULATED ENERGY USAGE MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) ## Format diff --git a/docs/docs/about/references/keywords/ENERGY_USAGE_MODEL.md b/docs/docs/about/references/keywords/ENERGY_USAGE_MODEL.md index 8d86169d50..aea948bb42 100644 --- a/docs/docs/about/references/keywords/ENERGY_USAGE_MODEL.md +++ b/docs/docs/about/references/keywords/ENERGY_USAGE_MODEL.md @@ -1,8 +1,8 @@ # ENERGY_USAGE_MODEL -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) | Required | Child of | Children/Options | @@ -20,21 +20,21 @@ for each type. The available types are: Energy usage model types: -* [DIRECT](../../modelling/setup/installations/direct_consumers) -* [TABULATED](../../modelling/setup/installations/tabular_models_in_calculations) -* [PUMP](../../modelling/setup/installations/pump_models_in_calculations#pump-energy-usage-model) -* [PUMP_SYSTEM](../../modelling/setup/installations/pump_models_in_calculations#pump_system-energy-usage-model) -* [COMPRESSOR](../../modelling/setup/installations/compressor_models_in_calculations/compressor) -* [COMPRESSOR_SYSTEM](../../modelling/setup/installations/compressor_models_in_calculations/compressor_system) -* [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](../../modelling/setup/installations/compressor_models_in_calculations/variable_speed_compressor_train_model_with_multiple_streams_and_pressures) +* [DIRECT](/about/modelling/setup/installations/direct_consumers.md) +* [TABULATED](/about/modelling/setup/installations/tabular_models_in_calculations.md) +* [PUMP](/about/modelling/setup/installations/pump_models_in_calculations.md#pump-energy-usage-model) +* [PUMP_SYSTEM](/about/modelling/setup/installations/pump_models_in_calculations.md#pump_system-energy-usage-model) +* [COMPRESSOR](/about/modelling/setup/installations/compressor_models_in_calculations/compressor.md) +* [COMPRESSOR_SYSTEM](/about/modelling/setup/installations/compressor_models_in_calculations/compressor_system.md) +* [VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES](/about/modelling/setup/installations/compressor_models_in_calculations/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) -For all types, the keywords [CONDITION](CONDITION.md), [CONDITIONS](CONDITIONS.md) and [POWERLOSSFACTOR](POWERLOSSFACTOR.md) are optional and supported, and these will act -on the calculated energy usage after the calculated energy usage from the model defined by [TYPE](TYPE.md). +For all types, the keywords [CONDITION](/about/references/keywords/CONDITION.md), [CONDITIONS](/about/references/keywords/CONDITIONS.md) and [POWERLOSSFACTOR](/about/references/keywords/POWERLOSSFACTOR.md) are optional and supported, and these will act +on the calculated energy usage after the calculated energy usage from the model defined by [TYPE](/about/references/keywords/TYPE.md). ## Temporal energy usage model 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). +`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](/about/references/keywords/CONSUMERS.md). ~~~~~~~~yaml ENERGY_USAGE_MODEL: diff --git a/docs/docs/about/references/keywords/EXPRESSION.md b/docs/docs/about/references/keywords/EXPRESSION.md index 6aa161cd50..0acf314752 100644 --- a/docs/docs/about/references/keywords/EXPRESSION.md +++ b/docs/docs/about/references/keywords/EXPRESSION.md @@ -1,7 +1,7 @@ # EXPRESSION -[VARIABLES](VARIABLES) / -[EXPRESSION](EXPRESSION) +[VARIABLES](/about/references/keywords/VARIABLES.md) / +[EXPRESSION](/about/references/keywords/EXPRESSION.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| diff --git a/docs/docs/about/references/keywords/EXTRAPOLATION.md b/docs/docs/about/references/keywords/EXTRAPOLATION.md index a71812f8b9..c1e3e885c4 100644 --- a/docs/docs/about/references/keywords/EXTRAPOLATION.md +++ b/docs/docs/about/references/keywords/EXTRAPOLATION.md @@ -1,7 +1,7 @@ # EXTRAPOLATION -[TIME_SERIES](TIME_SERIES.md) / -[EXTRAPOLATION](EXTRAPOLATION) +[TIME_SERIES](/about/references/keywords/TIME_SERIES.md) / +[EXTRAPOLATION](/about/references/keywords/EXTRAPOLATION.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -9,7 +9,7 @@ ## Description :::caution -Only valid for `TIME_SERIES` of [TYPE](TYPE) `MISCELLANEOUS`. For type +Only valid for `TIME_SERIES` of [TYPE](/about/references/keywords/TYPE.md) `MISCELLANEOUS`. For type `DEFAULT` the keyword is not supported as input, and the functionality is defaulted to `False`. ::: @@ -30,6 +30,6 @@ EXTRAPOLATION: | `MISCELLANEOUS` | `False` | ## Example -See the [TIME_SERIES](TIME_SERIES.md) `time_series_format`. +See the [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) `time_series_format`. diff --git a/docs/docs/about/references/keywords/FACILITY_INPUTS.md b/docs/docs/about/references/keywords/FACILITY_INPUTS.md index c2b03a8b53..1b8a613a4d 100644 --- a/docs/docs/about/references/keywords/FACILITY_INPUTS.md +++ b/docs/docs/about/references/keywords/FACILITY_INPUTS.md @@ -1,6 +1,6 @@ # FACILITY_INPUTS -[FACILITY_INPUTS](FACILITY_INPUTS) +[FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) | Required | Child of | Children/Options | |------------|---------------------------|------------------------------------| @@ -8,15 +8,15 @@ ## Description This part of the setup defines input files that characterize various facility elements. Each facility element is -specified in a list. These are later used as input in the [INSTALLATIONS](INSTALLATIONS) part of the setup by referencing their -[NAME](NAME). +specified in a list. These are later used as input in the [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) part of the setup by referencing their +[NAME](/about/references/keywords/NAME.md). All facility inputs are in essence a `CSV` (Comma separated file) file that specifies input data to a model that calculates how much energy the equipment is using depending on the operating mode/throughput. There are multiple [supported types](#supported-types). ## Supported types -The facility input type is defined using the [TYPE](TYPE.md) keyword and defines the type of model applied +The facility input type is defined using the [TYPE](/about/references/keywords/TYPE.md) keyword and defines the type of model applied to the data in this file. The input files are in `CSV` (Comma separated file) format. The paths to the input files may be either absolute or relative to the setup file. The supported types are: @@ -27,4 +27,4 @@ The supported types are: - `PUMP_CHART_SINGLE_SPEED` - `PUMP_CHART_VARIABLE_SPEED` -See [FACILITY INPUTS](../../modelling/setup/facility_inputs/) for details about each of the above supported types and their usage. \ No newline at end of file +See [FACILITY INPUTS](/about/modelling/setup/facility_inputs/index.md) for details about each of the above supported types and their usage. \ No newline at end of file diff --git a/docs/docs/about/references/keywords/FILE.md b/docs/docs/about/references/keywords/FILE.md index 8103cf4d0f..731975eea5 100644 --- a/docs/docs/about/references/keywords/FILE.md +++ b/docs/docs/about/references/keywords/FILE.md @@ -1,7 +1,7 @@ # FILE ... / -[FILE](FILE) +[FILE](/about/references/keywords/FILE.md) ## Description Specifies the path (relative or absolute) to the input file. @@ -14,4 +14,4 @@ FILE: ~~~~~~~~ ## Example -See the [TIME_SERIES](TIME_SERIES.md) `time_series_format`. +See the [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) `time_series_format`. diff --git a/docs/docs/about/references/keywords/FLUID_DENSITY.md b/docs/docs/about/references/keywords/FLUID_DENSITY.md index 18d31dba20..92f4cf9359 100644 --- a/docs/docs/about/references/keywords/FLUID_DENSITY.md +++ b/docs/docs/about/references/keywords/FLUID_DENSITY.md @@ -1,9 +1,9 @@ # FLUID_DENSITY -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[FLUID_DENSITY](FLUID_DENSITY) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[FLUID_DENSITY](/about/references/keywords/FLUID_DENSITY.md) ## Description Used to define the fluid density for diff --git a/docs/docs/about/references/keywords/FUEL.md b/docs/docs/about/references/keywords/FUEL.md index c74f5983a2..cf56c78c32 100644 --- a/docs/docs/about/references/keywords/FUEL.md +++ b/docs/docs/about/references/keywords/FUEL.md @@ -1,11 +1,11 @@ # FUEL ... / -[FUEL](FUEL.md) +[FUEL](/about/references/keywords/FUEL.md) ## Description -The [FUEL](FUEL.md) keyword defines the fuel type that can be used in +The [FUEL](/about/references/keywords/FUEL.md) keyword defines the fuel type that can be used in `INSTALLATIONS`, `GENERATORSETS`, or `FUELCONSUMERS`. It can be set directly and used for the entire time interval, or it can be set differently for different time intervals. diff --git a/docs/docs/about/references/keywords/FUELCONSUMERS.md b/docs/docs/about/references/keywords/FUELCONSUMERS.md index 4763926cbc..06f5bc0b7c 100644 --- a/docs/docs/about/references/keywords/FUELCONSUMERS.md +++ b/docs/docs/about/references/keywords/FUELCONSUMERS.md @@ -1,14 +1,14 @@ # FUELCONSUMERS -[INSTALLATIONS](INSTALLATIONS) / -[FUELCONSUMERS](FUELCONSUMERS.md) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md) ## Description -The [FUELCONSUMERS](FUELCONSUMERS.md) keyword covers the fuel consumers on the installation -that are not generators. The attributes [NAME](NAME), -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) and -[CATEGORY](CATEGORY) are required, while -[FUEL](FUEL) is optional and may be used to +The [FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md) keyword covers the fuel consumers on the installation +that are not generators. The attributes [NAME](/about/references/keywords/NAME.md), +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) and +[CATEGORY](/about/references/keywords/CATEGORY.md) are required, while +[FUEL](/about/references/keywords/FUEL.md) is optional and may be used to override the installation's default fuel type. ## Format diff --git a/docs/docs/about/references/keywords/FUELRATE.md b/docs/docs/about/references/keywords/FUELRATE.md index 1daf2152e9..d2382e7500 100644 --- a/docs/docs/about/references/keywords/FUELRATE.md +++ b/docs/docs/about/references/keywords/FUELRATE.md @@ -1,10 +1,10 @@ # FUELRATE -[INSTALLATIONS](INSTALLATIONS) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[FUELRATE](FUELRATE) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[FUELRATE](/about/references/keywords/FUELRATE.md) ## Description Used for direct fuel `energy usage models` to define fuel consumption directly with an diff --git a/docs/docs/about/references/keywords/FUEL_TYPES.md b/docs/docs/about/references/keywords/FUEL_TYPES.md index c04355a2be..d3f629a81f 100644 --- a/docs/docs/about/references/keywords/FUEL_TYPES.md +++ b/docs/docs/about/references/keywords/FUEL_TYPES.md @@ -1,15 +1,15 @@ # FUEL_TYPES -[FUEL_TYPES](FUEL_TYPES) +[FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) ## Description This part of the setup specifies the various fuel types and associated emissions used in the model. Each fuel type is specified in a list and the defined fuels can later be referred to the -[INSTALLATIONS](INSTALLATIONS) part of the setup by its name. +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) part of the setup by its name. -A fuel type can have a fuel-cost [PRICE](PRICE) associated with -its use. The use of fuel can lead to one or more emission types, specified in [EMISSIONS](EMISSIONS.md), +A fuel type can have a fuel-cost [PRICE](/about/references/keywords/PRICE.md) associated with +its use. The use of fuel can lead to one or more emission types, specified in [EMISSIONS](/about/references/keywords/EMISSIONS.md), which in turn can have associated costs. -You can optionally specify a [CATEGORY](CATEGORY). +You can optionally specify a [CATEGORY](/about/references/keywords/CATEGORY.md). -See [FUEL TYPES](docs/about/modelling/setup/fuel_types) for more details about usage. \ No newline at end of file +See [FUEL TYPES](/about/modelling/setup/fuel_types.md) for more details about usage. \ No newline at end of file diff --git a/docs/docs/about/references/keywords/GENERATORSETS.md b/docs/docs/about/references/keywords/GENERATORSETS.md index 3f3c60dc2b..f473e77bcb 100644 --- a/docs/docs/about/references/keywords/GENERATORSETS.md +++ b/docs/docs/about/references/keywords/GENERATORSETS.md @@ -1,16 +1,16 @@ # GENERATORSETS -[INSTALLATIONS](INSTALLATIONS) / -[GENERATORSETS](GENERATORSETS.md) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[GENERATORSETS](/about/references/keywords/GENERATORSETS.md) ## Description -Under [GENERATORSETS](GENERATORSETS.md) one or +Under [GENERATORSETS](/about/references/keywords/GENERATORSETS.md) one or several `generator sets` (a 'set' of an engine of some sort and a generator) are specified in a list. -Each generator set requires three sub-keywords, [ELECTRICITY2FUEL](ELECTRICITY2FUEL) and -[CONSUMERS](CONSUMERS) and [CATEGORY](CATEGORY). +Each generator set requires three sub-keywords, [ELECTRICITY2FUEL](/about/references/keywords/ELECTRICITY2FUEL.md) and +[CONSUMERS](/about/references/keywords/CONSUMERS.md) and [CATEGORY](/about/references/keywords/CATEGORY.md). This keyword is optional. However, the only requirement is that each -installation must have at least one of [GENERATORSETS](GENERATORSETS.md) -and [FUELCONSUMERS](FUELCONSUMERS.md). +installation must have at least one of [GENERATORSETS](/about/references/keywords/GENERATORSETS.md) +and [FUELCONSUMERS](/about/references/keywords/FUELCONSUMERS.md). -See [GENERATOR SETS](../../../about/modelling/setup/installations/generator_sets_in_calculations) for more details about usage. \ No newline at end of file +See [GENERATOR SETS](/about/modelling/setup/installations/generator_sets_in_calculations.md) for more details about usage. \ No newline at end of file diff --git a/docs/docs/about/references/keywords/HCEXPORT.md b/docs/docs/about/references/keywords/HCEXPORT.md index 35c8e274d5..b14e2d72a6 100644 --- a/docs/docs/about/references/keywords/HCEXPORT.md +++ b/docs/docs/about/references/keywords/HCEXPORT.md @@ -1,10 +1,10 @@ # HCEXPORT -[INSTALLATIONS](INSTALLATIONS) / -[HCEXPORT](HCEXPORT) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[HCEXPORT](/about/references/keywords/HCEXPORT.md) ## Description -[HCEXPORT](HCEXPORT) defines the export of hydrocarbons as a number of oil equivalents in Sm3. +[HCEXPORT](/about/references/keywords/HCEXPORT.md) defines the export of hydrocarbons as a number of oil equivalents in Sm3. This keyword is required for the output of emission intensity (i.e., kg CO2/boe). This could be a single time series variable or an `expression ` containing multiple time series variables. Typically it would be the sum of exported oil and gas in units of oil equivalents. @@ -43,7 +43,7 @@ HCEXPORT: ~~~~~~~~ ### Full example -Example showing [HCEXPORT](HCEXPORT) the modelling hierarchy: +Example showing [HCEXPORT](/about/references/keywords/HCEXPORT.md) the modelling hierarchy: ~~~~~~~~yaml INSTALLATIONS: diff --git a/docs/docs/about/references/keywords/HEAD.md b/docs/docs/about/references/keywords/HEAD.md index 8bee9ae762..c131b34ecf 100644 --- a/docs/docs/about/references/keywords/HEAD.md +++ b/docs/docs/about/references/keywords/HEAD.md @@ -2,7 +2,7 @@ ## Description -`HEAD` is a keyword that is used defining [PUMP](../../modelling/setup/facility_inputs/pump_modelling/pump_charts) and [COMPRESSOR CHARTS](../../modelling/setup/models/compressor_modelling/compressor_charts/index.md). +`HEAD` is a keyword that is used defining [PUMP](/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md) and [COMPRESSOR CHARTS](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md). Head can either be given as a M, KJ_PER_KG, JOULE_PER_KG. For compressors, it is used in two separate ways under the `MODELS` or section: diff --git a/docs/docs/about/references/keywords/HEAD_MARGIN.md b/docs/docs/about/references/keywords/HEAD_MARGIN.md index 9fe644a983..e7f9638762 100644 --- a/docs/docs/about/references/keywords/HEAD_MARGIN.md +++ b/docs/docs/about/references/keywords/HEAD_MARGIN.md @@ -1,7 +1,7 @@ # HEAD_MARGIN -[FACILITY_INPUTS](FACILITY_INPUTS) / -[HEAD_MARGIN](HEAD_MARGIN) +[FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) / +[HEAD_MARGIN](/about/references/keywords/HEAD_MARGIN.md) ## Description When calibrating pump charts to historical data, the head values at maximum speed diff --git a/docs/docs/about/references/keywords/INFLUENCE_TIME_VECTOR.md b/docs/docs/about/references/keywords/INFLUENCE_TIME_VECTOR.md index f9455b4eb6..81a5d8083f 100644 --- a/docs/docs/about/references/keywords/INFLUENCE_TIME_VECTOR.md +++ b/docs/docs/about/references/keywords/INFLUENCE_TIME_VECTOR.md @@ -1,7 +1,7 @@ # INFLUENCE_TIME_VECTOR -[TIME_SERIES](TIME_SERIES.md) / -[INFLUENCE_TIME_VECTOR](INFLUENCE_TIME_VECTOR.md) +[TIME_SERIES](/about/references/keywords/TIME_SERIES.md) / +[INFLUENCE_TIME_VECTOR](/about/references/keywords/INFLUENCE_TIME_VECTOR.md) ## Description @@ -19,4 +19,4 @@ INFLUENCE_TIME_VECTOR: ## Example -See the [TIME_SERIES](TIME_SERIES.md) `time_series_format`. +See the [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) `time_series_format`. diff --git a/docs/docs/about/references/keywords/INLET_TEMPERATURE.md b/docs/docs/about/references/keywords/INLET_TEMPERATURE.md index de896dabde..a16eb9762b 100644 --- a/docs/docs/about/references/keywords/INLET_TEMPERATURE.md +++ b/docs/docs/about/references/keywords/INLET_TEMPERATURE.md @@ -1,13 +1,13 @@ # INLET_TEMPERATURE -[MODELS](MODELS) / [INLET_TEMPERATURE](INLET_TEMPERATURE.md) +[MODELS](/about/references/keywords/MODELS.md) / [INLET_TEMPERATURE](/about/references/keywords/INLET_TEMPERATURE.md) -| Required | Child of | Children/Options | -|----------|---------------|------------------| -| Yes | [MODELS](MODELS.md) | None | +| Required | Child of | Children/Options | +|----------|------------------------------------------------|------------------| +| Yes | [MODELS](/about/references/keywords/MODELS.md) | None | ## Description -This is a keyword used in [COMPRESSOR MODELLING](../../modelling/setup/models/compressor_modelling/compressor_models_types/index.md). It is a necessary input parameter which describes the inlet temperature to a compressor stage. Temperature **must** be given in oC. +This is a keyword used in [COMPRESSOR MODELLING](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md). It is a necessary input parameter which describes the inlet temperature to a compressor stage. Temperature **must** be given in oC. As of now, this is can only be given as a single value. Time-series are not accepted here. diff --git a/docs/docs/about/references/keywords/INSTALLATIONS.md b/docs/docs/about/references/keywords/INSTALLATIONS.md index 19a0b178d5..f2b17f13b1 100644 --- a/docs/docs/about/references/keywords/INSTALLATIONS.md +++ b/docs/docs/about/references/keywords/INSTALLATIONS.md @@ -1,12 +1,12 @@ # INSTALLATIONS -[INSTALLATIONS](INSTALLATIONS) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) ## Description -In [INSTALLATIONS](INSTALLATIONS) the system of energy consumers is described. Installations, in this setting, are typically the different platforms and production units for a field, group of fields, or area. Mobile units (such as drilling rigs) are also modelled as an installation. +In [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) the system of energy consumers is described. Installations, in this setting, are typically the different platforms and production units for a field, group of fields, or area. Mobile units (such as drilling rigs) are also modelled as an installation. The structure of the keywords under installations is linked to the structure in the general consumer overview for an installation. -See [INSTALLATIONS](../../modelling/setup/installations/) for more details about usage. \ No newline at end of file +See [INSTALLATIONS](/about/modelling/setup/installations/index.md) for more details about usage. \ No newline at end of file diff --git a/docs/docs/about/references/keywords/INTERPOLATION_TYPE.md b/docs/docs/about/references/keywords/INTERPOLATION_TYPE.md index e70e1c2765..b5634d709d 100644 --- a/docs/docs/about/references/keywords/INTERPOLATION_TYPE.md +++ b/docs/docs/about/references/keywords/INTERPOLATION_TYPE.md @@ -1,13 +1,13 @@ # INTERPOLATION_TYPE -[TIME_SERIES](TIME_SERIES.md) / -[INTERPOLATION_TYPE](INTERPOLATION_TYPE) +[TIME_SERIES](/about/references/keywords/TIME_SERIES.md) / +[INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md) New in **v8.1**, previously known as `RATE_INTERPOLATION_TYPE` that was renamed to `INTERPOLATION_TYPE`. ## Description :::caution Caution -Only valid for CSV data of source `MISCELLANEOUS`. For `TIME_SERIES` of [TYPE](TYPE) +Only valid for CSV data of source `MISCELLANEOUS`. For `TIME_SERIES` of [TYPE](/about/references/keywords/TYPE.md) `DEFAULT` the keyword is not allowed as input. The following applies: - MISCELLANEOUS: Interpolation type is mandatory. - DEFAULT: Interpolation type not allowed. Default `RIGHT` is used. @@ -24,7 +24,7 @@ within the same file. ::: Rates are given at defined time steps in the data source but are in essence valid for a time -interval. The [INTERPOLATION_TYPE](INTERPOLATION_TYPE) +interval. The [INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md) will determine how rates are interpolated between the given time steps. - `LEFT`: The rate given at the current time step is defining the rate in the time interval between the current and @@ -33,7 +33,7 @@ will determine how rates are interpolated between the given time steps. next time step. This is in data science also known as forward filling of missing values. - `LINEAR`: The rate will be linearly interpolated between the time steps. -The plot below shows how the different choices for [INTERPOLATION_TYPE](INTERPOLATION_TYPE) works in practice. +The plot below shows how the different choices for [INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md) works in practice. ![](/img/docs/interpolation_plot.png) @@ -44,10 +44,10 @@ INTERPOLATION_TYPE: ``` ### Requirements -[INTERPOLATION_TYPE](INTERPOLATION_TYPE) has to be specified if -[TYPE](TYPE) is set to `MISCELLANEOUS`. +[INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md) has to be specified if +[TYPE](/about/references/keywords/TYPE.md) is set to `MISCELLANEOUS`. -[INTERPOLATION_TYPE](INTERPOLATION_TYPE) can not be specified if [TYPE](TYPE) is set to `DEFAULT`. +[INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md) can not be specified if [TYPE](/about/references/keywords/TYPE.md) is set to `DEFAULT`. ## Example -See the [TIME_SERIES](TIME_SERIES.md) `time_series_format`. +See the [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) `time_series_format`. diff --git a/docs/docs/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md b/docs/docs/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md index 20c85ce7c4..097a5ac5c4 100644 --- a/docs/docs/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md +++ b/docs/docs/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md @@ -1,9 +1,9 @@ # INTERSTAGE_CONTROL_PRESSURE -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / [...] / -[INTERSTAGE_CONTROL_PRESSURE](INTERSTAGE_CONTROL_PRESSURE) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / [...] / +[INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) ## Description @@ -12,13 +12,13 @@ This keyword can **only** be utilised for a `VARIABLE_SPEED_COMPRESSOR_TRAIN_MUL - `MODELS` - to define the upstream and downstream pressure control methods - `ENERGY_USAGE_MODEL` - to define the interstage pressure -### Use in [MODELS](MODELS) +### Use in [MODELS](/about/references/keywords/MODELS.md) :::note This keyword cannot be specified for the first stage, and it may only be used **once** in a given compression train. ::: -Under the `INTERSTAGE_CONTROL_PRESSURE` keyword, the [UPSTREAM_PRESSURE_CONTROL](UPSTREAM_PRESSURE_CONTROL) and [DOWNSTREAM_PRESSURE_CONTROL](DOWNSTREAM_PRESSURE_CONTROL) keywords can be specified. +Under the `INTERSTAGE_CONTROL_PRESSURE` keyword, the [UPSTREAM_PRESSURE_CONTROL](/about/references/keywords/UPSTREAM_PRESSURE_CONTROL.md) and [DOWNSTREAM_PRESSURE_CONTROL](/about/references/keywords/DOWNSTREAM_PRESSURE_CONTROL.md) keywords can be specified. #### Format @@ -41,12 +41,12 @@ MODELS: ~~~~ The reason why upstream and downstream pressure control methods need to be specified is that the compression train is essentially split in two - before and after the interstage pressure. Thus, a control method for each "side" of the model needs to be defined. -See [Variable speed compressor train model with multiple streams and pressures](../../modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures) for more details. +See [Variable speed compressor train model with multiple streams and pressures](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md) for more details. -### Use in [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) +### Use in [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) -Within the `ENERGY_USAGE_MODEL` section (**only** when [TYPE](TYPE) is set to `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES`) the actual value for the interstage pressure is set in **bar**. -This can either be a single value or an [EXPRESSION](EXPRESSION.md). +Within the `ENERGY_USAGE_MODEL` section (**only** when [TYPE](/about/references/keywords/TYPE.md) is set to `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES`) the actual value for the interstage pressure is set in **bar**. +This can either be a single value or an [EXPRESSION](/about/references/keywords/EXPRESSION.md). #### Format diff --git a/docs/docs/about/references/keywords/LOAD.md b/docs/docs/about/references/keywords/LOAD.md index 6ac23711e0..fe9f00a54b 100644 --- a/docs/docs/about/references/keywords/LOAD.md +++ b/docs/docs/about/references/keywords/LOAD.md @@ -1,9 +1,9 @@ # LOAD -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[LOAD](LOAD) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[LOAD](/about/references/keywords/LOAD.md) ## Description Used for direct load `energy usage models` to define electrical power load directly diff --git a/docs/docs/about/references/keywords/LOWER_HEATING_VALUE.md b/docs/docs/about/references/keywords/LOWER_HEATING_VALUE.md index 14a4e283c4..f2db9a5caf 100644 --- a/docs/docs/about/references/keywords/LOWER_HEATING_VALUE.md +++ b/docs/docs/about/references/keywords/LOWER_HEATING_VALUE.md @@ -2,7 +2,7 @@ ## Description -`LOWER_HEATING_VALUE` is a required to be specified under the [TURBINE_MODEL](TURBINE_MODEL.md) keyword. +`LOWER_HEATING_VALUE` is a required to be specified under the [TURBINE_MODEL](/about/references/keywords/TURBINE_MODEL.md) keyword. This **must** be specified in MJ/Sm3 This can only be inputted as a single value and dictates the quantity of thermal energy available after burning a standard cubic metre of fuel (natural gas in this gas). diff --git a/docs/docs/about/references/keywords/MAXIMUM_DISCHARGE_PRESSURE.md b/docs/docs/about/references/keywords/MAXIMUM_DISCHARGE_PRESSURE.md index eaf0e63409..bbb59229f1 100644 --- a/docs/docs/about/references/keywords/MAXIMUM_DISCHARGE_PRESSURE.md +++ b/docs/docs/about/references/keywords/MAXIMUM_DISCHARGE_PRESSURE.md @@ -1,7 +1,7 @@ # MAXIMUM_DISCHARGE_PRESSURE -[MODELS](MODELS) / -[MAXIMUM_DISCHARGE_PRESSURE](MAXIMUM_DISCHARGE_PRESSURE.md) +[MODELS](/about/references/keywords/MODELS.md) / +[MAXIMUM_DISCHARGE_PRESSURE](/about/references/keywords/MAXIMUM_DISCHARGE_PRESSURE.md) ## Description @@ -10,7 +10,7 @@ In reality, setting the maximum discharge pressure can be to avoid excessively h ## Functionality -This is an optional setting and is **only** supported for [SINGLE SPEED COMPRESSORS](../../modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model), and **only** if the `PRESSURE_CONTROL` is `DOWNSTREAM_CHOKE`. +This is an optional setting and is **only** supported for [SINGLE SPEED COMPRESSORS](/about/modelling/setup/models/compressor_modelling/compressor_models_types/single_speed_compressor_train_model.md), and **only** if the `PRESSURE_CONTROL` is `DOWNSTREAM_CHOKE`. * If `MAXIMUM_DISCHARGE_PRESSURE` has been defined and if any of the inputted discharge pressures exceeds the maximum value, a ValueError message will be raised. * If any of the input rates and suction pressures result in a discharge pressure which is above the `MAXIMUM_DISCHARGE_PRESSURE`, the suction pressure will be reduced until the calculations provide a discharge pressure below the maximum value (assuming an upstream choke can handle this). diff --git a/docs/docs/about/references/keywords/MODELS.md b/docs/docs/about/references/keywords/MODELS.md index 96cb6b9595..886038b548 100644 --- a/docs/docs/about/references/keywords/MODELS.md +++ b/docs/docs/about/references/keywords/MODELS.md @@ -1,14 +1,14 @@ # MODELS -[MODELS](MODELS) +[MODELS](/about/references/keywords/MODELS.md) ## Description Each element is specified in a list. These are later used as input to other models, or in the -[INSTALLATIONS](INSTALLATIONS) part of the setup by referencing their -[NAME](NAME). +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) part of the setup by referencing their +[NAME](/about/references/keywords/NAME.md). This part of the setup specifies models not having any input data and/or multi level models, that is models which use -other models (from both [MODELS](MODELS) and from [FACILITY_INPUTS](FACILITY_INPUTS)). +other models (from both [MODELS](/about/references/keywords/MODELS.md) and from [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md)). ## Format @@ -33,4 +33,4 @@ The supported types are: - `COMPRESSOR_WITH_TURBINE` -The documentation of each of these is found on the [Compressor Modelling](../../modelling/setup/models/compressor_modelling/compressor_models_types/) page. \ No newline at end of file +The documentation of each of these is found on the [Compressor Modelling](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md) page. \ No newline at end of file diff --git a/docs/docs/about/references/keywords/NAME.md b/docs/docs/about/references/keywords/NAME.md index 2dc9f27523..4c6a9d59c5 100644 --- a/docs/docs/about/references/keywords/NAME.md +++ b/docs/docs/about/references/keywords/NAME.md @@ -1,11 +1,11 @@ # NAME [...] / -[NAME](NAME) +[NAME](/about/references/keywords/NAME.md) ## Description Name of an entity. -[CATEGORY](CATEGORY.md) names must be written with uppercase letters - see example below: +[CATEGORY](/about/references/keywords/CATEGORY.md) names must be written with uppercase letters - see example below: ## Format ~~~~~~~~yaml @@ -13,14 +13,14 @@ NAME: ~~~~~~~~ ## Example -Usage in [EMISSIONS](EMISSIONS.md): +Usage in [EMISSIONS](/about/references/keywords/EMISSIONS.md): ~~~~~~~~yaml EMISSIONS: - NAME: CO2 ~~~~~~~~ -Usage in [FUEL_TYPES](FUEL_TYPES.md) and [CATEGORIES](CATEGORY.md): +Usage in [FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) and [CATEGORIES](/about/references/keywords/CATEGORY.md): ~~~~~~~~yaml FUEL_TYPES: diff --git a/docs/docs/about/references/keywords/OPERATIONAL_SETTINGS.md b/docs/docs/about/references/keywords/OPERATIONAL_SETTINGS.md index b17f7b215e..56bde4dd8b 100644 --- a/docs/docs/about/references/keywords/OPERATIONAL_SETTINGS.md +++ b/docs/docs/about/references/keywords/OPERATIONAL_SETTINGS.md @@ -1,23 +1,23 @@ # OPERATIONAL_SETTINGS -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[OPERATIONAL_SETTINGS](OPERATIONAL_SETTINGS) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[OPERATIONAL_SETTINGS](/about/references/keywords/OPERATIONAL_SETTINGS.md) ## Description -Used to define the operational settings in an [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) +Used to define the operational settings in an [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) of type `PUMP_SYSTEM` or `COMPRESSOR_SYSTEM`. The rate [Sm3/day] through each consumer in the system may be specified in two different ways, either directly using `RATES`, or by defining the `rate fraction` for each consumer which is then multiplied with the `total system rate`. -The suction pressure may either be specified with [SUCTION_PRESSURE](SUCTION_PRESSURE) +The suction pressure may either be specified with [SUCTION_PRESSURE](/about/references/keywords/SUCTION_PRESSURE.md) which will then be the common suction pressure for all consumers in the system. Alternatively, `SUCTION_PRESSURES` may be used to specify one suction pressure expression per consumer. -The discharge pressure may either be specified with [DISCHARGE_PRESSURE](DISCHARGE_PRESSURE) +The discharge pressure may either be specified with [DISCHARGE_PRESSURE](/about/references/keywords/DISCHARGE_PRESSURE.md) which will then be the common discharge pressure for all consumers in the system. Alternatively, `DISCHARGE_PRESSURES` may be used to specify one discharge pressure expression per consumer. @@ -36,29 +36,29 @@ not both in one operational setting. ### RATE_FRACTIONS A list with one expression per consumer specifying the rate fraction for each consumer. If this is used, -[TOTAL_SYSTEM_RATE](TOTAL_SYSTEM_RATE) for the [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) +[TOTAL_SYSTEM_RATE](/about/references/keywords/TOTAL_SYSTEM_RATE.md) for the [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) is also required. Use either `RATES` or `RATE_FRACTIONS`, not both in one operational setting. ### SUCTION_PRESSURES A list with one expression per consumer specifying the suction pressure for each consumer. Use either `SUCTION_PRESSURES` or -[SUCTION_PRESSURE](SUCTION_PRESSURE), not both in the same operational setting. +[SUCTION_PRESSURE](/about/references/keywords/SUCTION_PRESSURE.md), not both in the same operational setting. -Use [SUCTION_PRESSURE](SUCTION_PRESSURE) to set the same suction pressure for all consumers in the system and +Use [SUCTION_PRESSURE](/about/references/keywords/SUCTION_PRESSURE.md) to set the same suction pressure for all consumers in the system and `SUCTION_PRESSURES` to specify one suction pressure expression per consumer. ### DISCHARGE_PRESSURES A list with one expression per consumer specifying the discharge pressure for each consumer. Use either `DISCHARGE_PRESSURES` -or [DISCHARGE_PRESSURE](DISCHARGE_PRESSURE), not both in the same operational setting. +or [DISCHARGE_PRESSURE](/about/references/keywords/DISCHARGE_PRESSURE.md), not both in the same operational setting. -Use [DISCHARGE_PRESSURE](DISCHARGE_PRESSURE) to set the same discharge pressure for all consumers in the system and +Use [DISCHARGE_PRESSURE](/about/references/keywords/DISCHARGE_PRESSURE.md) to set the same discharge pressure for all consumers in the system and `DISCHARGE_PRESSURES` to specify one discharge pressure expression per consumer. ### FLUID_DENSITIES Only supported for `energy usage models` of type `PUMP_SYSTEM`. A list with one expression per consumer specifying the fluid density for each consumer. If used, it will over-ride -[FLUID_DENSITY](FLUID_DENSITY) for the `PUMP_SYSTEM`. +[FLUID_DENSITY](/about/references/keywords/FLUID_DENSITY.md) for the `PUMP_SYSTEM`. -Use [FLUID_DENSITY](FLUID_DENSITY) for the `energy usage models` +Use [FLUID_DENSITY](/about/references/keywords/FLUID_DENSITY.md) for the `energy usage models` to set one fixed fluid density for the entire system for all operational settings. Use `FLUID_DENSITIES` for the `operational setting` to vary the fluid density between consumers and operational settings. diff --git a/docs/docs/about/references/keywords/POWERLOSSFACTOR.md b/docs/docs/about/references/keywords/POWERLOSSFACTOR.md index 71c578d3ad..1c0d545ffc 100644 --- a/docs/docs/about/references/keywords/POWERLOSSFACTOR.md +++ b/docs/docs/about/references/keywords/POWERLOSSFACTOR.md @@ -1,13 +1,13 @@ # POWERLOSSFACTOR -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[POWERLOSSFACTOR](POWERLOSSFACTOR) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[POWERLOSSFACTOR](/about/references/keywords/POWERLOSSFACTOR.md) ## Description A factor that may be added to account for power line losses. E.g. if you have a subsea installation with a power line to -another installation, there may be line losses. For a power line loss of 5%, [POWERLOSSFACTOR](POWERLOSSFACTOR) +another installation, there may be line losses. For a power line loss of 5%, [POWERLOSSFACTOR](/about/references/keywords/POWERLOSSFACTOR.md) is set to 0.05 and the power required from the power source (generator set) will be $$ diff --git a/docs/docs/about/references/keywords/POWER_ADJUSTMENT_CONSTANT.md b/docs/docs/about/references/keywords/POWER_ADJUSTMENT_CONSTANT.md index f3881d6cc7..e6f859fe81 100644 --- a/docs/docs/about/references/keywords/POWER_ADJUSTMENT_CONSTANT.md +++ b/docs/docs/about/references/keywords/POWER_ADJUSTMENT_CONSTANT.md @@ -1,7 +1,7 @@ # POWER_ADJUSTMENT_CONSTANT -[MODELS](MODELS) / -[POWER_ADJUSTMENT_CONSTANT](POWER_ADJUSTMENT_CONSTANT) +[MODELS](/about/references/keywords/MODELS.md) / +[POWER_ADJUSTMENT_CONSTANT](/about/references/keywords/POWER_ADJUSTMENT_CONSTANT.md) ## Description Optional constant MW adjustment added to the model. Only added if (electrical) POWER > 0. diff --git a/docs/docs/about/references/keywords/PRESSURE_CONTROL.md b/docs/docs/about/references/keywords/PRESSURE_CONTROL.md index a7819f3196..ed7038f62f 100644 --- a/docs/docs/about/references/keywords/PRESSURE_CONTROL.md +++ b/docs/docs/about/references/keywords/PRESSURE_CONTROL.md @@ -10,7 +10,7 @@ - COMMON_ASV - NONE -Further description on how each pressure control method works can be found in [COMPRESSOR MODELLING](../../modelling/setup/models/compressor_modelling/compressor_models_types/) +Further description on how each pressure control method works can be found in [COMPRESSOR MODELLING](/about/modelling/setup/models/compressor_modelling/compressor_models_types/index.md) ## Format diff --git a/docs/docs/about/references/keywords/PRICE.md b/docs/docs/about/references/keywords/PRICE.md index ab2f6749bd..d587987a6b 100644 --- a/docs/docs/about/references/keywords/PRICE.md +++ b/docs/docs/about/references/keywords/PRICE.md @@ -1,11 +1,11 @@ # PRICE -[FUEL_TYPES](FUEL_TYPES) / -[PRICE](PRICE) +[FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) / +[PRICE](/about/references/keywords/PRICE.md) ## Description -The fuel [PRICE](PRICE) defines the fuel cost (or the sales value of produced gas used as fuel). -The unit of the price is NOK/Sm3. [PRICE](PRICE) can either be a fixed number or an expression (time series). Thus, it can be decided if a constant price or a price varying with time is needed. +The fuel [PRICE](/about/references/keywords/PRICE.md) defines the fuel cost (or the sales value of produced gas used as fuel). +The unit of the price is NOK/Sm3. [PRICE](/about/references/keywords/PRICE.md) can either be a fixed number or an expression (time series). Thus, it can be decided if a constant price or a price varying with time is needed. ## Format ~~~~~~~~yaml @@ -49,5 +49,5 @@ DATE, FUEL_PRICE 01.01.2023, 10500 ~~~~~~~~ -Make sure the file [TYPE](TYPE) is set to `FUEL_PRICE` to have a default `RIGHT` -[INTERPOLATION_TYPE](INTERPOLATION_TYPE). +Make sure the file [TYPE](/about/references/keywords/TYPE.md) is set to `FUEL_PRICE` to have a default `RIGHT` +[INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md). diff --git a/docs/docs/about/references/keywords/PUMPS.md b/docs/docs/about/references/keywords/PUMPS.md index f8459dc766..7ce896a67c 100644 --- a/docs/docs/about/references/keywords/PUMPS.md +++ b/docs/docs/about/references/keywords/PUMPS.md @@ -1,8 +1,8 @@ # PUMPS -[INSTALLATIONS](INSTALLATIONS) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[PUMPS](PUMPS) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[PUMPS](/about/references/keywords/PUMPS.md) ## Description Used to define a list of pumps in a `PUMP_SYSTEM ENERGY USAGE MODEL`. Each pump is defined with a name and with a diff --git a/docs/docs/about/references/keywords/QUOTA.md b/docs/docs/about/references/keywords/QUOTA.md index 104d4769de..2e2223826f 100644 --- a/docs/docs/about/references/keywords/QUOTA.md +++ b/docs/docs/about/references/keywords/QUOTA.md @@ -1,10 +1,10 @@ # QUOTA [...] / -[QUOTA](QUOTA) +[QUOTA](/about/references/keywords/QUOTA.md) ## Description -Quota cost in NOK/Sm3 for the emission. [QUOTA](QUOTA) can either be a fixed number or an +Quota cost in NOK/Sm3 for the emission. [QUOTA](/about/references/keywords/QUOTA.md) can either be a fixed number or an expression (time series). With the use of an expression, a time series can be defined which can let the quota value vary over the model timespan. ## Format diff --git a/docs/docs/about/references/keywords/RATE.md b/docs/docs/about/references/keywords/RATE.md index 7c4e0b96c7..a17885e97e 100644 --- a/docs/docs/about/references/keywords/RATE.md +++ b/docs/docs/about/references/keywords/RATE.md @@ -1,17 +1,17 @@ # RATE -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[RATE](RATE) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[RATE](/about/references/keywords/RATE.md) ## Description This can be used in two ways: -- Used to define the rate for some [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) +- Used to define the rate for some [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) types using an `Expression` -- Used defining the units of a [PUMP](../../modelling/setup/facility_inputs/pump_modelling/pump_charts) and [COMPRESSOR CHARTS](../../modelling/setup/models/compressor_modelling/compressor_charts/). +- Used defining the units of a [PUMP](/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md) and [COMPRESSOR CHARTS](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md). ## Format diff --git a/docs/docs/about/references/keywords/RATE_PER_STREAM.md b/docs/docs/about/references/keywords/RATE_PER_STREAM.md index 5d8c85fe55..124898463b 100644 --- a/docs/docs/about/references/keywords/RATE_PER_STREAM.md +++ b/docs/docs/about/references/keywords/RATE_PER_STREAM.md @@ -1,13 +1,13 @@ # RATE_PER_STREAM -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[RATE_PER_STREAM](RATE_PER_STREAM) +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[RATE_PER_STREAM](/about/references/keywords/RATE_PER_STREAM.md) ## Description Used to define the rate for each stream for the VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) types using a list of `expression` +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) types using a list of `expression` ## Format ~~~~~~~~yaml diff --git a/docs/docs/about/references/keywords/REGULARITY.md b/docs/docs/about/references/keywords/REGULARITY.md index 1f586f1b05..d7e2f69167 100644 --- a/docs/docs/about/references/keywords/REGULARITY.md +++ b/docs/docs/about/references/keywords/REGULARITY.md @@ -1,11 +1,11 @@ # REGULARITY -[INSTALLATIONS](INSTALLATIONS) / -[REGULARITY](REGULARITY) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / +[REGULARITY](/about/references/keywords/REGULARITY.md) ## Description -In eCalc™, consumers in an [ENERGY USAGE MODEL](ENERGY_USAGE_MODEL) are evaluated with the actual rate passing through them whilst +In eCalc™, consumers in an [ENERGY USAGE MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) are evaluated with the actual rate passing through them whilst they are in operation. This actual rate is referred to as _stream day (sd) rates_. Despite the consumers being evaluated with stream day rates, input files are often given in _calender day (cd) rates_. As expected from this definition, `REGULARITY` is closely related to the production efficiency (PE) of a facility. @@ -23,23 +23,23 @@ An example of this can be seen in the figure below: ![Regularity work flow example](regularity.png) -For detailed modeling, it might be a better option to increase the resolution in the [TIME_SERIES](TIME_SERIES.md) +For detailed modeling, it might be a better option to increase the resolution in the [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) inputs to capture down periods and variations in conditions rather than using regularity. :::note - Rates from reservoir simulations may be both stream day and calendar day. - If eCalc™ is used -without specifying [REGULARITY](REGULARITY), then regularity will default to 1. -- All user defined input rates used in [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) are **assumed to be calendar day rates**. +without specifying [REGULARITY](/about/references/keywords/REGULARITY.md), then regularity will default to 1. +- All user defined input rates used in [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) are **assumed to be calendar day rates**. ::: ### Use in a `DIRECT ENERGY USAGE MODEL` -It should be noted that not all [ENERGY USAGE MODELS](ENERGY_USAGE_MODEL) are evaluated with _stream day rates_. -`DIRECT ENERGY USAGE MODELS` can be specified with the keyword [CONSUMPTION_RATE_TYPE](CONSUMPTION_RATE_TYPE) - where either `CALENDAR_DAY` or `STREAM_DAY` can be specified. +It should be noted that not all [ENERGY USAGE MODELS](/about/references/keywords/ENERGY_USAGE_MODEL.md) are evaluated with _stream day rates_. +`DIRECT ENERGY USAGE MODELS` can be specified with the keyword [CONSUMPTION_RATE_TYPE](/about/references/keywords/CONSUMPTION_RATE_TYPE.md) - where either `CALENDAR_DAY` or `STREAM_DAY` can be specified. Note that the default input rate is `STREAM_DAY` rate - the opposite of the other models. -For further details on stream day rate vs. calendar day rate, see [CONSUMPTION_RATE_TYPE](CONSUMPTION_RATE_TYPE). +For further details on stream day rate vs. calendar day rate, see [CONSUMPTION_RATE_TYPE](/about/references/keywords/CONSUMPTION_RATE_TYPE.md). |ENERGY_USAGE_MODEL Type|Can use CONSUMPTION_RATE_TYPE?| Evaluated rate type | |:---:|:---:|:-------------------:| @@ -88,7 +88,7 @@ REGULARITY: SIM1;REGULARITY ### Special: Combining calendar and stream day rates If there is a need to combine stream day and calendar day rates in an expression, -(or to use a stream day rate from a [TIME_SERIES](TIME_SERIES.md) source), one can manually do +(or to use a stream day rate from a [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) source), one can manually do what is necessary to obtain calendar day rates by dividing by regularity. For example, combining a calendar day rate (`SIM2;GAS_PROD_A`) with stream day rate diff --git a/docs/docs/about/references/keywords/STAGES.md b/docs/docs/about/references/keywords/STAGES.md index 4705869d40..8fc63ddfb6 100644 --- a/docs/docs/about/references/keywords/STAGES.md +++ b/docs/docs/about/references/keywords/STAGES.md @@ -1,8 +1,8 @@ # STAGES -[MODELS](MODELS) / +[MODELS](/about/references/keywords/MODELS.md) / [...] / -[STREAMS](STREAMS.md) +[STREAMS](/about/references/keywords/STREAMS.md) ## Description diff --git a/docs/docs/about/references/keywords/START.md b/docs/docs/about/references/keywords/START.md index 96259b3833..f7768d3ebf 100644 --- a/docs/docs/about/references/keywords/START.md +++ b/docs/docs/about/references/keywords/START.md @@ -1,6 +1,6 @@ # START -[START](START) +[START](/about/references/keywords/START.md) ## Description The global start date for eCalc to begin energy and emission calculations. It is recommended that you have control @@ -11,10 +11,10 @@ of the day are implicitly set to "00:00:00", so the counting starts from midnigh You can provide a date that is before the global time vector, but it is recommended to set it to the start of your timeseries data. Normally the timeseries data provides this information directly, when specifying the first time step e.g. 2020-01-01, meaning that the data is valid from January 1st 2020, -but data by default has ([INTERPOLATION_TYPE](INTERPOLATION_TYPE)), which means that it backfills data, and then we will know how far back +but data by default has ([INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md)), which means that it backfills data, and then we will know how far back to backfill data (ie defines this for the first period). -The cousin of is [END](END) and have similar behaviour, but check the reference for details, to make sure you have the correct understanding. +The cousin of is [END](/about/references/keywords/END.md) and have similar behaviour, but check the reference for details, to make sure you have the correct understanding. If is not specified, eCalc will make and educated *GUESS* on when the output data should start, but that may be incorrect, therefore it is recommended that you stay in control of that to make sure you get correct output. diff --git a/docs/docs/about/references/keywords/STREAM.md b/docs/docs/about/references/keywords/STREAM.md index 9a7b59b187..32782a51dd 100644 --- a/docs/docs/about/references/keywords/STREAM.md +++ b/docs/docs/about/references/keywords/STREAM.md @@ -1,8 +1,8 @@ # STREAM -[MODELS](MODELS) / -[...] / [STAGES](STAGES.md) -[STREAMS](STREAMS.md) +[MODELS](/about/references/keywords/MODELS.md) / +[...] / [STAGES](/about/references/keywords/STAGES.md) +[STREAMS](/about/references/keywords/STREAMS.md) :::note This keyword is not to be confused with `STREAMS` - which is also utilised for `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` @@ -10,9 +10,9 @@ This keyword is not to be confused with `STREAMS` - which is also utilised for ` ## Description -This keyword can **only** be utilised for a `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` model type and is used under the [STAGES](STAGES.md) keyword. +This keyword can **only** be utilised for a `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` model type and is used under the [STAGES](/about/references/keywords/STAGES.md) keyword. -This is used to refer a [STAGE](STAGES.md) to a previously defined [STREAMS](STREAMS.md). +This is used to refer a [STAGE](/about/references/keywords/STAGES.md) to a previously defined [STREAMS](/about/references/keywords/STREAMS.md). ## Format diff --git a/docs/docs/about/references/keywords/STREAMS.md b/docs/docs/about/references/keywords/STREAMS.md index 5c9bb0e679..b3661d3faf 100644 --- a/docs/docs/about/references/keywords/STREAMS.md +++ b/docs/docs/about/references/keywords/STREAMS.md @@ -1,8 +1,8 @@ # STREAMS -[MODELS](MODELS) / +[MODELS](/about/references/keywords/MODELS.md) / [...] / -[STREAMS](STREAMS.md) +[STREAMS](/about/references/keywords/STREAMS.md) ## Description diff --git a/docs/docs/about/references/keywords/SUCTION_PRESSURE.md b/docs/docs/about/references/keywords/SUCTION_PRESSURE.md index 26165bf676..fb89a0b2f0 100644 --- a/docs/docs/about/references/keywords/SUCTION_PRESSURE.md +++ b/docs/docs/about/references/keywords/SUCTION_PRESSURE.md @@ -1,14 +1,14 @@ # SUCTION_PRESSURE -[INSTALLATIONS](INSTALLATIONS) / +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / [...] / -[SUCTION_PRESSURE](SUCTION_PRESSURE) +[SUCTION_PRESSURE](/about/references/keywords/SUCTION_PRESSURE.md) ## Description -Used to define the suction pressure for some [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) -types and in [OPERATIONAL_SETTINGS](OPERATIONAL_SETTINGS) using +Used to define the suction pressure for some [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) +types and in [OPERATIONAL_SETTINGS](/about/references/keywords/OPERATIONAL_SETTINGS.md) using a fixed value or an expression. If an expression is used, a time series can be used so that the suction pressure of the unit can vary over the lifespan of the model. Note that pressure values **must** be inputted in `bar`. diff --git a/docs/docs/about/references/keywords/TAX.md b/docs/docs/about/references/keywords/TAX.md index 6e99d2f906..ee9d3d26cf 100644 --- a/docs/docs/about/references/keywords/TAX.md +++ b/docs/docs/about/references/keywords/TAX.md @@ -1,11 +1,11 @@ # TAX -[FUEL_TYPES](FUEL_TYPES) / -[EMISSIONS](EMISSIONS.md) / -[TAX](TAX) +[FUEL_TYPES](/about/references/keywords/FUEL_TYPES.md) / +[EMISSIONS](/about/references/keywords/EMISSIONS.md) / +[TAX](/about/references/keywords/TAX.md) ## Description -Tax is payable in NOK/Sm3 for the emission. [TAX](TAX) can either be a fixed number or an +Tax is payable in NOK/Sm3 for the emission. [TAX](/about/references/keywords/TAX.md) can either be a fixed number or an `expression `. ## Format @@ -49,5 +49,5 @@ DATE, TAX 01.01.2023, 2.1 ~~~~~~~~ -Make sure the file [TYPE](TYPE) is set to `EMISSION_TAX_PER_FUEL_VOLUME` to have a default `RIGHT` -[INTERPOLATION_TYPE](INTERPOLATION_TYPE). +Make sure the file [TYPE](/about/references/keywords/TYPE.md) is set to `EMISSION_TAX_PER_FUEL_VOLUME` to have a default `RIGHT` +[INTERPOLATION_TYPE](/about/references/keywords/INTERPOLATION_TYPE.md). diff --git a/docs/docs/about/references/keywords/TIME_SERIES.md b/docs/docs/about/references/keywords/TIME_SERIES.md index e0b3b93bea..a65063bef4 100644 --- a/docs/docs/about/references/keywords/TIME_SERIES.md +++ b/docs/docs/about/references/keywords/TIME_SERIES.md @@ -1,6 +1,6 @@ # TIME_SERIES -[TIME_SERIES](TIME_SERIES.md) / +[TIME_SERIES](/about/references/keywords/TIME_SERIES.md) / ## Description This keyword defines the inputs for time dependent variables, or "reservoir @@ -11,9 +11,9 @@ For example, a field may have a reservoir simulation model for some areas and de the reservoir. There may also be tie-ins which are affecting the energy/emissions on the field installations. Also, there may be time profiles for fuel prices, emission tax, etc. Therefore, a set of sources may be specified with a name, path to data and type. The name is -later referred to in the system of energy consumers defined under [INSTALLATIONS](INSTALLATIONS). +later referred to in the system of energy consumers defined under [INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md). Reservoir variables and other time varying data not coming from a reservoir simulation model can be specified in a [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) file. -See [TIME SERIES](../../modelling/setup/time_series) for more details about usage. \ No newline at end of file +See [TIME SERIES](/about/modelling/setup/time_series.md) for more details about usage. \ No newline at end of file diff --git a/docs/docs/about/references/keywords/TOTAL_SYSTEM_RATE.md b/docs/docs/about/references/keywords/TOTAL_SYSTEM_RATE.md index f9e29192b6..09d578173f 100644 --- a/docs/docs/about/references/keywords/TOTAL_SYSTEM_RATE.md +++ b/docs/docs/about/references/keywords/TOTAL_SYSTEM_RATE.md @@ -1,8 +1,8 @@ # TOTAL_SYSTEM_RATE -[INSTALLATIONS](INSTALLATIONS) / [...] / -[ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL) / -[TOTAL_SYSTEM_RATE](TOTAL_SYSTEM_RATE) +[INSTALLATIONS](/about/references/keywords/INSTALLATIONS.md) / [...] / +[ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) / +[TOTAL_SYSTEM_RATE](/about/references/keywords/TOTAL_SYSTEM_RATE.md) ## Description Used to define the total system rate [Sm3/day] for `ENERGY_USAGE_MODEL` of type `COMPRESSOR_SYSTEM` diff --git a/docs/docs/about/references/keywords/TURBINE_EFFICIENCIES.md b/docs/docs/about/references/keywords/TURBINE_EFFICIENCIES.md index a36a620629..7216f6c9cf 100644 --- a/docs/docs/about/references/keywords/TURBINE_EFFICIENCIES.md +++ b/docs/docs/about/references/keywords/TURBINE_EFFICIENCIES.md @@ -2,7 +2,7 @@ ## Description -`TURBINE_EFFICIENCIES` is a required to be specified under the [TURBINE_MODEL](TURBINE_MODEL.md) keyword. +`TURBINE_EFFICIENCIES` is a required to be specified under the [TURBINE_MODEL](/about/references/keywords/TURBINE_MODEL.md) keyword. This **must** be specified as a fraction and **must** have equal length to the corresponding `TURBINE_LOAD` values. diff --git a/docs/docs/about/references/keywords/TURBINE_LOAD.md b/docs/docs/about/references/keywords/TURBINE_LOAD.md index ebc272289c..b9737a9920 100644 --- a/docs/docs/about/references/keywords/TURBINE_LOAD.md +++ b/docs/docs/about/references/keywords/TURBINE_LOAD.md @@ -2,7 +2,7 @@ ## Description -`TURBINE_LOAD` is a required to be specified under the [TURBINE_MODEL](TURBINE_MODEL.md) keyword. +`TURBINE_LOAD` is a required to be specified under the [TURBINE_MODEL](/about/references/keywords/TURBINE_MODEL.md) keyword. This **must** be specified in MW (Mega-Watts) and **must** have equal length to the corresponding `TURBINE_EFFICIENCY` values. diff --git a/docs/docs/about/references/keywords/TURBINE_MODEL.md b/docs/docs/about/references/keywords/TURBINE_MODEL.md index 49a66ec868..d88d0ef1c8 100644 --- a/docs/docs/about/references/keywords/TURBINE_MODEL.md +++ b/docs/docs/about/references/keywords/TURBINE_MODEL.md @@ -2,7 +2,7 @@ ## Description -When using a [TURBINE](../../modelling/setup/models/turbine_modeling) it is required for a `TURBINE_MODEL` to be specified. This is done under the `MODELS` section. +When using a [TURBINE](/about/modelling/setup/models/turbine_modeling.md) it is required for a `TURBINE_MODEL` to be specified. This is done under the `MODELS` section. A turbine model describes a gas-fired turbine that is coupled to a compressor or compression train. It is specified in a similar way to a [GENERATORSET](GENERATORSETS.md). `TURBINE_LOAD`, `TURBINE_EFFICIENCY` and `LOWER_HEATING_VALUE` needs to be inputted here. diff --git a/docs/docs/about/references/keywords/TYPE.md b/docs/docs/about/references/keywords/TYPE.md index f625e9c72b..891c128ca6 100644 --- a/docs/docs/about/references/keywords/TYPE.md +++ b/docs/docs/about/references/keywords/TYPE.md @@ -1,24 +1,24 @@ # TYPE [...] / -[TYPE](TYPE.md) / +[TYPE](/about/references/keywords/TYPE.md) / ## Description -The [TYPE](TYPE.md) is always a string. The allowed strings, and the resulting change in behavior, -will depend on where [TYPE](TYPE.md) is used: +The [TYPE](/about/references/keywords/TYPE.md) is always a string. The allowed strings, and the resulting change in behavior, +will depend on where [TYPE](/about/references/keywords/TYPE.md) is used: -### Use in [FACILITY_INPUTS](FACILITY_INPUTS.md) +### Use in [FACILITY_INPUTS](/about/references/keywords/FACILITY_INPUTS.md) - `ELECTRICITY2FUEL` - `TABULAR` - `COMPRESSOR_TABULAR` - `PUMP_CHART_SINGLE_SPEED` - `PUMP_CHART_VARIABLE_SPEED` -### Use in [TIME_SERIES](TIME_SERIES.md) +### Use in [TIME_SERIES](/about/references/keywords/TIME_SERIES.md) - `MISCELLANEOUS` - `DEFAULT` -### Use in [ENERGY_USAGE_MODEL](ENERGY_USAGE_MODEL.md) +### Use in [ENERGY_USAGE_MODEL](/about/references/keywords/ENERGY_USAGE_MODEL.md) - `DIRECT` - `COMPRESSOR` - `PUMP` @@ -27,7 +27,7 @@ will depend on where [TYPE](TYPE.md) is used: - `TABULATED` - `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` -### Use in [MODELS](MODELS.md) +### Use in [MODELS](/about/references/keywords/MODELS.md) - `FLUID` - `VARIABLE_SPEED_COMPRESSOR_TRAIN` - `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` diff --git a/docs/docs/about/references/keywords/UNITS.md b/docs/docs/about/references/keywords/UNITS.md index 47c9894312..a1b4f89c56 100644 --- a/docs/docs/about/references/keywords/UNITS.md +++ b/docs/docs/about/references/keywords/UNITS.md @@ -2,7 +2,7 @@ ## Description -`UNITS` is a keyword that can be specified for [PUMP](../../modelling/setup/facility_inputs/pump_modelling/pump_charts) and [COMPRESSOR CHARTS](../../modelling/setup/models/compressor_modelling/compressor_charts/). This is a requirement and **must** be specified. +`UNITS` is a keyword that can be specified for [PUMP](/about/modelling/setup/facility_inputs/pump_modelling/pump_charts.md) and [COMPRESSOR CHARTS](/about/modelling/setup/models/compressor_modelling/compressor_charts/index.md). This is a requirement and **must** be specified. For pumps this must be specified in `FACILITY_INPUTS`, whilst for compressors it must be within `MODELS`. diff --git a/docs/docs/about/references/keywords/UPSTREAM_PRESSURE_CONTROL.md b/docs/docs/about/references/keywords/UPSTREAM_PRESSURE_CONTROL.md index ca41038d5e..79d7bd5303 100644 --- a/docs/docs/about/references/keywords/UPSTREAM_PRESSURE_CONTROL.md +++ b/docs/docs/about/references/keywords/UPSTREAM_PRESSURE_CONTROL.md @@ -1,15 +1,15 @@ # UPSTREAM_PRESSURE_CONTROL -[MODELS](MODELS) / +[MODELS](/about/references/keywords/MODELS.md) / [...] / -[INTERSTAGE_CONTROL_PRESSURE](INTERSTAGE_CONTROL_PRESSURE) -/ [UPSTREAM_PRESSURE_CONTROL](UPSTREAM_PRESSURE_CONTROL) +[INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) +/ [UPSTREAM_PRESSURE_CONTROL](/about/references/keywords/UPSTREAM_PRESSURE_CONTROL.md) ## Description -This keyword is used only for `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` type. It is used within the [INTERSTAGE_CONTROL_PRESSURE](INTERSTAGE_CONTROL_PRESSURE) keyword. +This keyword is used only for `VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES` type. It is used within the [INTERSTAGE_CONTROL_PRESSURE](/about/references/keywords/INTERSTAGE_CONTROL_PRESSURE.md) keyword. The pressure control method upstream (before) the interstage pressure is specified in this keyword. -For more explanation see [Variable speed compressor train model with multiple streams and pressures](../../modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures). +For more explanation see [Variable speed compressor train model with multiple streams and pressures](/about/modelling/setup/models/compressor_modelling/compressor_models_types/variable_speed_compressor_train_model_with_multiple_streams_and_pressures.md). ## Format diff --git a/docs/docs/about/references/keywords/VARIABLES.md b/docs/docs/about/references/keywords/VARIABLES.md index 9c9c1d78de..281f23742b 100644 --- a/docs/docs/about/references/keywords/VARIABLES.md +++ b/docs/docs/about/references/keywords/VARIABLES.md @@ -1,9 +1,9 @@ # VARIABLES -[VARIABLES](VARIABLES) +[VARIABLES](/about/references/keywords/VARIABLES.md) ## Description This keyword is used to define variables which can be used throughout the YAML file via the use of expressions. These variables can be based on time or can be independent. -Information about defining and using variables can be seen [here](../../modelling/setup/variables). \ No newline at end of file +Information about defining and using variables can be seen [here](/about/modelling/setup/variables.md). \ No newline at end of file