Skip to main content

File format

The setup file is written in YAML format and needs to follow a strict pattern which consists of several levels specified by indentation. The indentation is very important. It is recommended to use an indentation of 2 spaces per level. At each level, there might be both required and optional keywords.

Setup file syntax​

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 which defines the input from facility characterization, TIME_SERIES which defines time-dependant input parameters (e.g. reservoir profiles), FUEL_TYPES which defines the various fuel types used in the system, and INSTALLATIONS which is the top node defining the system of energy consumers. MODELS 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: List of input sources, CSV-files, containing all time series data including the reservoir variables.
  • FACILITY_INPUTS: 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.
  • FUEL_TYPES: Defining the fuel types being used in the model and the corresponding emissions.
  • MODELS: Used for multi-level models, one model may refer to other models from either MODELS or FACILITY_INPUTS
  • VARIABLES: Used for defining variables to be used in expressions throughout the YAML file
  • INSTALLATIONS: Defining the system of energy consumers on each installation (e.g. platform or mobile unit).

An eCalc model may contain one or several installations. Each installation has a set of specifications (e.g. fuel type, hydrocarbon export, ...) and specifications of the system of consumers.

Emissions are emitted when fuel is burned. Thus, the first sublevel of consumers for an installation, are the fuel burners. As the figure below shows, there are three main types of fuel burners:

  • Electricity generation (generator sets),
  • Turbine-driven processes,
  • Flare/vent/other non reservoir dependent burners/emitters.

In eCalc under each installation, there is one keyword (GENERATORSETS) specifying the generator sets and one keyword (FUELCONSUMERS) 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.

Comments

Comments are supported anywhere in the yml and csv files by using '#' to indicate the start of a comment. All data after a '#' on the same line is ignored. If '#' is used at the beginning of the file, the first line without a preceding '#' is used as the header.

Examples​

YAML format example​

TIME_SERIES:
  - FILE:
    TYPE:
    NAME:

FACILITY INPUTS:
  - FILE:
    TYPE:
    NAME:

FUEL_TYPES:
  - NAME:
    FACTOR:

MODELS:
  - NAME:
  - TYPE:

VARIABLES:
  <variable_name>
    VALUE: <expression>

INSTALLATIONS:
  - NAME:
    HCEXPORT:
    FUEL:
    GENERATORSETS:
      - NAME:
        ELECTRICITY2FUEL:
        CATEGORY:
        CONSUMERS:
          - NAME:
            CATEGORY:
            ENERGY_USAGE_MODEL:

Full examples​

Examples are an excellent way to quickly get an overview of the syntax. Check them out here.