`lib-ghg` 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793685089/FIN+5.3.1+lib-ghg 中文整理基于 FIN 5.3.1

导读： 温室气体排放延伸

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

目录（导读）

lib
meta
docs
tags
apps
funcs
views
def
supertypes
Overview
Emission Source
Emission
Factor Grid
Factor His
Ghg Unit Format
Ghg Service
Utility Functions
Emission Calculation Formula
Equivalent Emissions
ghgCreateDirectSource(dis, filterExpr, fuelType, biomass: false)
ghgCreateEmission(source, navName, ghg, factor, factorHis: null)
ghgCreateFactorHisPoint(dis, unit, emissionRec: null, merge: {})
ghgCreateIndirectSource(dis, filterExpr)
ghgEmissions(target, span, opts: null)
- usage
- tags
- subtypes
- src

概述（中译）

温室气体排放延伸

API 正文（英文）

docs

Overview • Emission Source • Emission • Factor Grid • Factor His • Ghg Unit Format • Ghg Service • Utility Functions • Emission Calculation Formula • Equivalent Emissions

tags


ghgConsumptionOn	An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions
ghgDirectSource	Direct emissions include
ghgEmissionSourceRef	Ref to the emission source where this emission factor will apply
ghgFactorGrid	Identifies emission factor values to calculate the emissions of the associated Greenhouse Gas
ghgFactorHis	Identifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions
ghgFactorHisRef	References a ghgFactorHis point record that the Greenhouse Gas Emission Engine uses to calculate emissions
ghgFuelSource	Identifies a direct fuel source used for combustion
ghgHeatContent	Identifies a direct emission with local heat content data
ghgHeatContentDis	Describes source of location specific heat content values
ghgHeatContentSyncId	Used internally for syncing location specific heat content values
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity
ghgMobileCombustion	Identifies direct GHG emissions associated with fuel combustion in owned or operated mobile sources
ghgSource	Identifies an emission source
ghgSourceRef	Ref to the emission source used to calculate Greenhouse Gas Emissions
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
ghgStationaryCombustion	Identifies direct GHG emissions from stationary (non-transport) combustion of fossil fuels at a facility (e.g., boilers, turbines, process heat)
ghgSyncId	Identifies the individual Greenhouse Gas Emission to sync

apps


ghg	Views used to visualize and analyze Greenhouse Gas Emissions

funcs


ghgCreateDirectSource	Create a ghgDirectSource record (scope 1 emission source)
ghgCreateEmission	Create an emission record
ghgCreateFactorHisPoint	Create an ghgFactorHis point record
ghgCreateIndirectSource	Create a ghgIndirectSource record (scope 2 emission source)
ghgEmissions	Calculate emissions for an equip, site, or ghgSource

views


ghgDirectSources	Manage Direct Greenhouse Gas ghgSource and emission records
ghgEmissions	View Greenhouse Gas Emissions for selected sites
ghgEquivalentEmissions	View Equivalent Greenhouse Gas Emissions for selected sites
ghgIndirectSources	Manage Indirect Greenhouse Gas ghgSource and emission records
ghgManageSourceRefs	Manage ghgSourceRefs for Equip Records

app:ghg

Views used to visualize and analyze Greenhouse Gas Emissions

meta


def	app:ghg
disKey	ghgExt::ghg
icon	greenhouseGas
is	app
lib	lib:ghg

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
app	UI application grouping of views

lib ghg

Overview

The Greenhouse Gas Ext (ghgExt) provides a common model for calculating Greenhouse Gas Emissions in SkySpark. The ghgExt requires a SkySpark license with active maintenance.

To setup an emission source, individual Greenhouse gas emissions and calculate the total emissions of an equip, the following high-level steps need to be completed.

Enable the ghg extension, which will add the GhG App to the project.
Create a ghgSource record. Use the GhG | Direct - Scope 1 or GhG | Indirect - Scope 2 views to create ghgSource records.
Create an emission record for each Greenhouse gas, which defines the emission factor and other attributes to use for calculating emissions. These records are automatically created when creating a ghgSource record using the built-in views.
Add a ghgSourceRef to each equip that identifies the source of the equips emissions. This is easily accomplished in the Ghg | Manage Source Refs view by selecting a ghgSource and using the Set Ghg Source action.

The Greenhouse Gas Ext connects to a built-in Ghg Service to simplify the setup process.

Emission Source

An Emission Source (ghgSource) models a collection of Greenhouse Gas emissions. An Emission Source must be one of the following types:

Direct (ghgDirectSource) - Models a fuel source
Indirect (ghgIndirectSource) - Models purchased electricity

See the Utility Functions section for convenience functions to simplify the creation of ghgSource records.

Emission

An emission models properties used to calculate the total amount of Greenhouse Gas emissions for a specific type of Greenhouse Gas.

At a minimum, an emission record must define the following tags:

ghgSyncId - Identifies the greenhouse gas.
ghgFactorGrid - Models emission factor values. See Factor Grid for details.
ghgEmissionSourceRef - Reference to the emission source.

See the Utility Functions section for convenience functions to simplify the creation of emission records.

Factor Grid

The ghgFactorGrid tag must define the following tags:

start - The start date to be used when calculating historical emissions
factor - The emission factor, which must include a unit that follows the Ghg Unit Format.

NOTE: Review the Factor His section. The factor tag is not required if using a factor history.

There are optional tags that can be defined based on whether on emission is from a direct or indirect source.

Direct emissions can also model:

hhv - Heat content of the fuel source, which must include a unit that follows the Ghg Unit Format.
gwp - Global Warming Potential of the Greenhouse Gas used to calculate Carbon Dioxide Equivalent (CO2e)

Indirect emissions can also model:

gridLossPercent - Percent of grid loss for purchased electricity. This value does not need a unit and is converted to a decimal format for calculations (divided by 100). For example, the value 4.49 will be converted to .0449.
gwp - Global Warming Potential of the Greenhouse Gas used to calculate Carbon Dioxide Equivalent (CO2e)

If gwp is not specified, the following values will be used (or 1f for all other emission types):

emission 	gwp
--------	-----
co2 		1f
ch4 		25f
n2o 		298f

Example ghgFactorGrid on a emission-co2 record of an indirect emission source:

start         factor            gridLossPercent     gwp
----------    --------------    ----------------    -----
2016-01-01    805_lb_per_MWh    4.49                1
2018-01-01    743_lb_per_MWh    4.88                1
2019-01-01    675_lb_per_MWh    5.1                 1

Example ghgFactorGrid on a emission-ch4 record of a direct emission source:

start         factor                   hhv                     gwp
----------    ---------------------    --------------------    -----
2018-01-01    0.00103_g_per_ft³_gas    1052_BTU_per_ft³_gas    25
2019-01-01    0.00103_g_per_ft³_gas    1051_BTU_per_ft³_gas    25

Factor His

A Factor Grid provides a convenient way to define aggregated emission factors that change infrequently. It is a good starting point when trying to understand trends in emission data, but emission factors can actually change much more frequently as the source of electricity coming from the electric grid changes.

If higher frequency emission factor data is available, it is possible to track the emission factors in a history point, which can provide a more accurate calculation of emissions. The SkyFoundry Ghg Service does not provide a source to automatically sync factor history points at this time, so this data will need to be collected from a third-party and manually written to the ghgFactorHis point record.

To configure a factor history, create a ghgFactorHis point record using the ghgCreateFactorHisPoint() function. That function accepts an optional emission record as a parameter, which will automatically set the ghgFactorHisRef tag on the emission record. When the ghgFactorHisRef is configured on an emission record, the emission factor in the ghgFactorGrid will be ignored, but the grid loss and global warming potential information will be combined with the factor history during emission calculation.

It is also possible to manually configure the ghgFactorHisRef tag on an emission record if the ghgFactorHis point record is already created or multiple emission records will use the same ghgFactorHis point to calculate emissions.

NOTE: Factor history is only supported for scope 2 emissions.

Ghg Unit Format

The units for emission factors and heat content (hhv) do not represent a measurement of energy so they don’t fit as standard units to define in units.txt. The Greenhouse Gas extension needs to be able to parse the numerator and denominator of these units to ensure the calculations are accurate.

When specifying emission factors, units are defined using an underscore and the numerator and denominator are separated by a _per_ token. The numerator and denominator must be existing units in the SkySpark unit database. For example, _kg_per_MMBTU, both kg and MMBTU are known units.

Ghg Service

SkySpark includes a built-in Ghg Service with some predefined models of Emission Sources and Emissions using published location-based data. Users can search for their location to simplify configuration. SkyFoundry will continue to add additional data sources as they are requested.

Utility Functions

The ghgEmissions() function calculates Greenhouse Gas emissions for a single site, equip, or source.
The ghgCreateDirectSource() function creates direct emission source records.
The ghgCreateIndirectSource() function creates indirect emission source records.
The ghgCreateEmission() function creates emission records.
The ghgCreateFactorHisPoint() function creates emission factor history point records.

Emission Calculation Formula

Scope 1 Emissions are calculated with this formula: Emissions = Fuel * Fuel Heat Content * Emission Factor

The Fuel Heat Content, or higher heating value (HHV), is optional. Some published data precalculates the heat content into the Emission Factor.

Scope 2 Emissions are calculated with this formula: Emissions = Consumed Electricity * Emission Factor * Grid Loss Percent

The Grid Loss Percent is optional.

Equivalent Emissions

SkySpark allows the user to calculate equivalent estimates of emissions in a number of different "units". These can be viewed in the GhG | Equivalent Emissions view.

When using the ghgEmissions() function, the following tags can be used to access specific equivalent values by setting one of the tags as the value of the equivalent option:

passengerVehiclesDrivenPerYear - Passenger Vehicles Driven Per Year
milesDrivenByAveragePassengerVehicle - Miles Driven By Average Passenger Vehicle
gallonsOfGasolineConsumed - Gallons of Gasoline Consumed
gallonsOfDieselConsumed - Gallons of Diesel Consumed
propaneCylindersUsedForHomeBbq - Propane Cylinders Used For Home BBQ
poundsOfCoalBurned - Pounds Of Coal Burned
numberOfSmartphonesCharged - Number Of Smartphones Charged
numberOfUrbanTreeSeedlingsGrownFor10Years - New Urban Trees Grown 10 Years To Sequester Emissions
avgPersonEmissionsPerYear - Number of People Worldwide Average Annual Emissions
socialCostOfCarbon - Social Cost of Carbon ($)

def

func:ghgCreateDirectSource

ghgCreateDirectSource(dis, filterExpr, fuelType, biomass: false)

Create a ghgDirectSource record (scope 1 emission source). The parameters:

dis: The display name for the source.
filterExpr: The filter Str to find the consumption point of the associated equip.
fuelType: This will get added as a marker tag to the record.
biomass (Bool): If the emissions are from biomass (non-fossil) fuel set this to true.

Returns the new ghgDirectSource record.

Example:

// Natural Gas Source
ghgCreateDirectSource("Natural Gas", "volume and sensor", "naturalGas")

// Landfill Gas Source
ghgCreateDirectSource("Landfill Gas", "volume and sensor", "landfillGas", true)

meta


admin	✓
def	func:ghgCreateDirectSource
is	func
lib	lib:ghg
name	ghgCreateDirectSource

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:ghgCreateEmission

ghgCreateEmission(source, navName, ghg, factor, factorHis: null)

Create an emission record. The parameters:

source: Emission Source that the Emission References. May be any target accepted by toRec().
navName: The navName for the emission.
ghg: The marker tag for a supported Greenhouse Gas - co2e, co2, ch4, n2o, so2, hfc, pcf, sf6, nf3
factor: Dict, Dict[], Grid, or null - If specifying an optional factorHis, then this may be null, or the factor tag is not required. When not specifying a factorHis created using ghgCreateFactorHisPoint() function, this cannot be null and must contain at a minimum the start and factor tags. Review the Factor Grid docs.
factorHis (Optional): Ref or Dict to the ghgFactorHis point record (only supported for scope 2). Review the Factor His docs.

Returns the new emission record.

Example:

// Landfill Gas
ghgCreateEmission(read(ghgDirectSource and dis == "Landfill Gas"),
                  "CO2 factor",
                  "co2",
                  {start:2019-01-01, factor: 0.025254_kg_per_ft³_gas, hhv:485_BTU_per_ft³_gas, gwp:1})

// Grid
ghgCreateEmission(read(ghgIndirectSource and dis == "Electric Grid"),
                  "CO2 factor",
                  "co2",
                  {start:2019-01-01, factor: 842_lb_per_MWh, gridLossPercent:4.49, gwp:1})

// Grid with Factor His
ghgCreateEmission(read(ghgIndirectSource and dis == "Electric Grid"),
                  "CO2 factor",
                  "co2",
                  {start:2019-01-01, gridLossPercent:4.49, gwp:1},
                  read(ghgFactorHis and dis == "Hourly Emission Factor"))

meta


admin	✓
def	func:ghgCreateEmission
is	func
lib	lib:ghg
name	ghgCreateEmission

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:ghgCreateFactorHisPoint

ghgCreateFactorHisPoint(dis, unit, emissionRec: null, merge: {})

Create an ghgFactorHis point record:

dis: The dis for the emission factor his.
unit: The emission factor unit
emissionRec (optional): Ref or Dict to the emission record (only supported for scope 2). May be any target accepted by toRec().
merge: Dict that the record will be merged with. Tags to consider:
- tz: If not specified, the environment default timezone is used
- siteRef: If not specified, tag not added to the record
- equipRef: If not specified, tag not added to the record

Returns the new emission factor history record.

Example:

ghgCreateFactorHisPoint("Hourly Emission Factor",
                        "_lb_per_MWh",
                        read(emission and co2 and ghgEmissionSourceRef->dis == "Electric Utility"),
                        {tz: "New_York"})

meta


admin	✓
def	func:ghgCreateFactorHisPoint
is	func
lib	lib:ghg
name	ghgCreateFactorHisPoint

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:ghgCreateIndirectSource

ghgCreateIndirectSource(dis, filterExpr)

Create a ghgIndirectSource record (scope 2 emission source). The parameters:

dis: The display name for the source.
filterExpr: The filter Str to find the consumption point of the associated equip.

Returns the new ghgIndirectSource record.

Example:

// Electric Utility
ghgCreateIndirectSource("Utility", "energy and sensor")

meta


admin	✓
def	func:ghgCreateIndirectSource
is	func
lib	lib:ghg
name	ghgCreateIndirectSource

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:ghgEmissions

ghgEmissions(target, span, opts: null)

Calculate emissions for an equip, site, or ghgSource. The parameters:

target: May be any target accepted by toRec().
span (Span): Span to calculate the emissions for.

The opts parameter is a Dict and supports the following options:

co2e (Marker): When set will return the emissions calculation of the Carbon Dioxide Equivalent using the co2e emission factor if present or the sum of all configured emissions using the configured Global Warming Potential of each emission.
equivalent (Marker or Str): When set function will return emissions calculations converted to equivalent estimated concrete values that may be easier to understand, such as the number of passenger vehicles driven per year. When specified as a marker tag, all available equivalent calculations are returned. A string value for one of the availble equivalent calculations can also be specified to return that individual value.
submeter (Marker): When set, this function will return emissions calculation for submeters. This option ensures that emissions will not be counted twice for the siteMeter and each submeter. If the target is a meter record than the emissions calculations for that meter will be returned otherwise only the siteMeter will be used to calculate emissions without this option.
scope (Str): Valid values are "direct" or "indirect". By default, emissions for both scopes are returned.
ghgSourceOverride (Ref or Dict): May be any target accepted by toRec().
data (Dict): The data option is used to override the historical consumption data that the ghg engine uses to calculate emissions. The value of this option is a dict where where the keys are string encodings of a point's id. The values are history grids. See the discussion below for more details.

The function returns the emissions as a history grid where each value column corresponds to an individual greenhouse gas emission (or the Carbon Dioxide Equivalent when used with the co2e option or equivalent emissions when used with the equivalent option).

The data option: Normally, the ghg engine will determine the history point to use for calculating emissions by looking at the ghgConsumptionOn of a ghgSource, and then resolve that filter to the appropriate point. However, if the data dict has a key with the same id as the resolved ghgConsumptionOn point, then the history grid in the dict will be used instead. Typically, this would be used to transform the existing history prior to calculating emissions.

Example:

//Calculate individual emissions for lastMonth
ghgEmissions(@Equip, lastMonth)

//Calculate Carbon Dioxide Equivalent for lastMonth
ghgEmissions(@Site, lastMonth, {co2e})

//Calculate Equivalent Emission Values for lastMonth
ghgEmissions(@ghgSource, lastMonth, {equivalent})

//Calculate individual emissions for lastMonth with data override
pt: read(@consumptionPoint and equipRef == @Equip)
data: pt.hisRead(lastMonth).hisMap(val => val * 2) 
dataOverride: {}.set(pt["id"].toStr, data)
ghgEmissions(@Equip, lastMonth, {data: dataOverride})

meta


def	func:ghgEmissions
is	func
lib	lib:ghg
name	ghgEmissions

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

ghgConsumptionOn

An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions.

meta


def	ghgConsumptionOn
is	filterStr
lib	lib:ghg
tagOn	ghgSource

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters
filterStr	Haystack filter string

def

ghgDirectSource

Direct emissions include:

Onsite generation of electricity, heat, or steam
Onsite physical or chemical processing
Transportation of materials, products, waste or employees
Fugitive emissions

meta


def	ghgDirectSource
disKey	ghgExt::ghgDirect
icon	greenhouseGas
is	ghgSource
lib	lib:ghg
mandatory	✓
tagOn	ghgSource

usage


ghgDirectSource ghgSource

supertypes


marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier
ghgSource	Identifies an emission source

tags


biomass	Plant or animal material used as fuel to produce electricity or heat
dis	Display name for an entity
ghgConsumptionOn	An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions
ghgDirectSource	Direct emissions include
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity
ghgMobileCombustion	Identifies direct GHG emissions associated with fuel combustion in owned or operated mobile sources
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
ghgStationaryCombustion	Identifies direct GHG emissions from stationary (non-transport) combustion of fossil fuels at a facility (e.g., boilers, turbines, process heat)
id	Defines the unique identifier of an entity in system using a `ref` value type

def

ghgEmissionSourceRef

Ref to the emission source where this emission factor will apply.

meta


containedBy	ghgSource
def	ghgEmissionSourceRef
is	ref
lib	lib:ghg
of	ghgSource
tagOn	emission

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

def

ghgFactorGrid

Identifies emission factor values to calculate the emissions of the associated Greenhouse Gas.

meta


def	ghgFactorGrid
is	grid
lib	lib:ghg
tagOn	emission

supertypes


val	Data value type
grid	Two dimension table of columns and rows

def

ghgFactorHis

Identifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions.

meta


def	ghgFactorHis
is	marker
lib	lib:ghg
tagOn	point

supertypes


marker	Marker labels a dict with typing information

def

ghgFactorHisRef

References a ghgFactorHis point record that the Greenhouse Gas Emission Engine uses to calculate emissions.

meta


def	ghgFactorHisRef
is	ref
lib	lib:ghg
of	ghgFactorHis
tagOn	emission

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

def

ghgFuelSource

Identifies a direct fuel source used for combustion

meta


def	ghgFuelSource
is	marker
lib	lib:ghg

supertypes


marker	Marker labels a dict with typing information

def

ghgHeatContent

Identifies a direct emission with local heat content data.

meta


def	ghgHeatContent
is	marker
lib	lib:ghg

supertypes


marker	Marker labels a dict with typing information

tags


ghgHeatContentDis	Describes source of location specific heat content values
ghgHeatContentSyncId	Used internally for syncing location specific heat content values

def

ghgHeatContentDis

Describes source of location specific heat content values.

meta


def	ghgHeatContentDis
is	str
lib	lib:ghg
tagOn	ghgHeatContent

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

ghgHeatContentSyncId

Used internally for syncing location specific heat content values.

meta


def	ghgHeatContentSyncId
is	str
lib	lib:ghg
tagOn	ghgHeatContent

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

ghgIndirectSource

Indirect emissions are from the generation of purchased electricity

meta


def	ghgIndirectSource
disKey	ghgExt::ghgIndirect
icon	greenhouseGas
is	ghgSource
lib	lib:ghg
mandatory	✓
tagOn	ghgSource

usage


ghgIndirectSource ghgSource

supertypes


marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier
ghgSource	Identifies an emission source

tags


dis	Display name for an entity
ghgConsumptionOn	An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions
ghgDirectSource	Direct emissions include
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
id	Defines the unique identifier of an entity in system using a `ref` value type

def

ghgMobileCombustion

Identifies direct GHG emissions associated with fuel combustion in owned or operated mobile sources

meta


def	ghgMobileCombustion
disKey	ghgExt::ghgMobile
is	marker
lib	lib:ghg
mandatory	✓
tagOn	ghgDirectSource

supertypes


marker	Marker labels a dict with typing information

def

ghgSource

Identifies an emission source

meta


def	ghgSource
icon	greenhouseGas
is	entity
lib	lib:ghg
mandatory	✓

supertypes


marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier

subtypes


ghgDirectSource	Direct emissions include
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity

tags


dis	Display name for an entity
ghgConsumptionOn	An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions
ghgDirectSource	Direct emissions include
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
id	Defines the unique identifier of an entity in system using a `ref` value type

def

ghgSourceRef

Ref to the emission source used to calculate Greenhouse Gas Emissions.

meta


def	ghgSourceRef
is	ref
lib	lib:ghg
of	ghgSource
tagOn	equip

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

def

ghgSourceSyncId

Identifies the emission source used for automatically creating emission factors.

meta


def	ghgSourceSyncId
is	str
lib	lib:ghg
tagOn	ghgSource

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

ghgStationaryCombustion

Identifies direct GHG emissions from stationary (non-transport) combustion of fossil fuels at a facility (e.g., boilers, turbines, process heat)

meta


def	ghgStationaryCombustion
disKey	ghgExt::ghgStationary
is	marker
lib	lib:ghg
mandatory	✓
tagOn	ghgDirectSource

supertypes


marker	Marker labels a dict with typing information

def

ghgSyncId

Identifies the individual Greenhouse Gas Emission to sync

meta


def	ghgSyncId
is	str
lib	lib:ghg
tagOn	emission

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

view:ghgDirectSources

Manage Direct Greenhouse Gas ghgSource and emission records

meta


admin	✓
appName	ghg
def	view:ghgDirectSources
disKey	ghgExt::ghgDirectSourcesView
icon	view
is	view
lib	lib:ghg
order	3

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:   { inherit:"tile" }
layout: { var kind:"Str" defVal:"grid 6x6; 0 0 6 3; 0 3 6 3" }
sources: Trio:
  view:           { inherit:"table" defName:"ghgSource" }
  selectedSource: { var kind:"Ref<ghgSource>" bindSelect:"id"}
  new:            { action:"recNew" uiInput:"ghgExt::EmissionSourceActions.newDirectAction" }
  edit:           { disMacro:"$<ui::edit> $<ghgExt::ghgSource>" action:"recEdit" select }
  trash:          { disMacro:"$<ui::trash> $<ghgExt::ghgSource>" action:"recTrash" select }
  sync:           { disKey:"ui::sync" select multi action:"ghgExt::EmissionFactorSyncAction.onSync" }
  hhv:            { dis:"Search Heat Content" select action:"ghgExt::DirectEmissionHeatContentSearch.open"}
  data:           { expr:"ghgDirectSourcesTable()" }
emissions: Trio:
  view:           { inherit:"table" }
  selectedSource: { var input binding:"../sources/selectedSource" }
  factor:         { disMacro:"$<ui::view> $<ghgExt::ghgFactorGrid>" action:"ghgExt::EmissionAction.viewFactorGrid" select }
  data:           { expr:"ghgEmissionsTable({{selectedSource}})" }

def

view:ghgEmissions

View Greenhouse Gas Emissions for selected sites

meta


appName	ghg
def	view:ghgEmissions
disKey	ghgExt::ghgEmissionsView
icon	view
is	view
lib	lib:ghg
order	1

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:   {inherit:"chart"}
sites:  {input var disKey:"ui::site" kind:"Ref<equip>[]" navCluster navSelAny share navAuxFilter:"ghgSourceRef"}
span:   {input var defVal:Span("today") spanModes:["day", "week", "month", "quarter", "year"] share}
opts:Trio:
  var
  kind:"Dict"
  disKey:"ui::options"
  input
  uiInput:"ghgExt::EmissionOptsInput"
  templateName:"ghgEmissionsOpts"
  defVal:Trio:
    mode:"siteEmissions"
    ghgDisUnit:"lb"
    scope:"all"
    co2e:true
    rollup:{fold:"auto" interval:"auto"}
    baseline:"none"
    meterType:"siteMeter"
menu:   {action:"uiContextMenu" selInput:"sites" }
data:   {expr:"ghgEmissionsView({{sites}}, {{span}}, {{opts}})"}

def

view:ghgEquivalentEmissions

View Equivalent Greenhouse Gas Emissions for selected sites

meta


appName	ghg
def	view:ghgEquivalentEmissions
disKey	ghgExt::ghgEquivalentEmissionsView
icon	view
is	view
lib	lib:ghg
order	2

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:   {inherit:"card"}
sites:  {input var disKey:"ui::site" kind:"Ref<equip>[]" navCluster navSelAny share navAuxFilter:"ghgSourceRef"}
span:   {input var defVal:Span("today") spanModes:["day", "week", "month", "quarter", "year"] share}
opts:Trio:
  var
  kind:"Dict"
  disKey:"ui::options"
  input
  uiInput:"ghgExt::EquivalentOptsInput"
  templateName:"ghgEquivalentOpts"
  defVal:Trio:
    equivalent:"passengerVehiclesDrivenPerYear"
    meterType:"siteMeter"
data:   {expr:"ghgEquivalentEmissionsView({{sites}}, {{span}}, {{opts}})"}

def

view:ghgIndirectSources

Manage Indirect Greenhouse Gas ghgSource and emission records

meta


admin	✓
appName	ghg
def	view:ghgIndirectSources
disKey	ghgExt::ghgIndirectSourcesView
icon	view
is	view
lib	lib:ghg
order	4

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:   { inherit:"tile" }
layout: { var kind:"Str" defVal:"grid 6x6; 0 0 6 3; 0 3 6 3" }
sources: Trio:
  view:           { inherit:"table" defName:"ghgSource" }
  selectedSource: { var kind:"Ref<ghgSource>" bindSelect:"id"}
  new:            { action:"recNew" uiInput:"ghgExt::EmissionSourceActions.newIndirectAction" }
  edit:           { disMacro:"$<ui::edit> $<ghgExt::ghgSource>" action:"recEdit" select }
  trash:          { disMacro:"$<ui::trash> $<ghgExt::ghgSource>" action:"recTrash" select }
  sync:           { disKey:"ui::sync" select multi action:"ghgExt::EmissionFactorSyncAction.onSync" }
  data:           { expr:"ghgIndirectSourcesTable()" }
emissions: Trio:
  view:           { inherit:"table" defName:"emission" }
  selectedSource: { var input binding:"../sources/selectedSource" }
  factor:         { disMacro:"$<ui::view> $<ghgExt::ghgFactorGrid>" action:"ghgExt::EmissionAction.viewFactorGrid" select }
  factorHis:      { disMacro:"$<ui::view> $<ghgExt::ghgFactorHis>" action:"ghgExt::EmissionAction.viewFactorHis" select }
  data:           { expr:"ghgEmissionsTable({{selectedSource}})" }

def

view:ghgManageSourceRefs

Manage ghgSourceRefs for Equip Records

meta


admin	✓
appName	ghg
def	view:ghgManageSourceRefs
disKey	ghgExt::ghgManageEquipSourcesView
icon	view
is	view
lib	lib:ghg
order	5

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:           { inherit:"table" }
set:            { disMacro:"$<ghgExt::ghgSetSourceRef>" action:"ghgExt::SourceRefActions.setAction" select multi }
remove:         { disMacro:"$<ghgExt::ghgRemoveSourceRef>" action:"ghgExt::SourceRefActions.removeAction" select multi }
inspect:        { disMacro:"$<ghgExt::ghgManageEquipSourcesView.inspectConfig>" action:"ghgExt::EmissionSourceInspectAction.onInspect" }
source:         { var kind:"Ref<ghgSource>" defVal:@null input }
data:           { expr:"ghgFindValidEquips({{source}})" }

lib-ghg 库参考 ​

目录（导读） ​

概述（中译） ​

API 正文（英文） ​

docs ​

apps ​

funcs ​

views ​

app:ghg ​

lib ghg ​

Overview ​

Emission Source ​

Emission ​

Factor Grid ​

Factor His ​

Ghg Unit Format ​

Ghg Service ​

Utility Functions ​

Emission Calculation Formula ​

Equivalent Emissions ​

func:ghgCreateDirectSource ​

ghgCreateDirectSource(dis, filterExpr, fuelType, biomass: false) ​

func:ghgCreateEmission ​

ghgCreateEmission(source, navName, ghg, factor, factorHis: null) ​

func:ghgCreateFactorHisPoint ​

ghgCreateFactorHisPoint(dis, unit, emissionRec: null, merge: {}) ​

func:ghgCreateIndirectSource ​

ghgCreateIndirectSource(dis, filterExpr) ​

func:ghgEmissions ​

ghgEmissions(target, span, opts: null) ​

ghgConsumptionOn ​

ghgDirectSource ​

ghgEmissionSourceRef ​

ghgFactorGrid ​

ghgFactorHis ​

ghgFactorHisRef ​

ghgFuelSource ​

ghgHeatContent ​

ghgHeatContentDis ​

ghgHeatContentSyncId ​

ghgIndirectSource ​

ghgMobileCombustion ​

ghgSource ​

ghgSourceRef ​

ghgSourceSyncId ​

ghgStationaryCombustion ​

ghgSyncId ​

view:ghgDirectSources ​

src ​

view:ghgEmissions ​

src ​

view:ghgEquivalentEmissions ​

src ​

view:ghgIndirectSources ​

`lib-ghg` 库参考

目录（导读）

概述（中译）

API 正文（英文）

docs

apps

funcs

views

app:ghg

lib ghg

Overview

Emission Source

Emission

Factor Grid

Factor His

Ghg Unit Format

Ghg Service

Utility Functions

Emission Calculation Formula

Equivalent Emissions

func:ghgCreateDirectSource

ghgCreateDirectSource(dis, filterExpr, fuelType, biomass: false)

func:ghgCreateEmission

ghgCreateEmission(source, navName, ghg, factor, factorHis: null)

func:ghgCreateFactorHisPoint

ghgCreateFactorHisPoint(dis, unit, emissionRec: null, merge: {})

func:ghgCreateIndirectSource

ghgCreateIndirectSource(dis, filterExpr)

func:ghgEmissions

ghgEmissions(target, span, opts: null)

ghgConsumptionOn

ghgDirectSource

ghgEmissionSourceRef

ghgFactorGrid

ghgFactorHis

ghgFactorHisRef

ghgFuelSource

ghgHeatContent

ghgHeatContentDis

ghgHeatContentSyncId

ghgIndirectSource

ghgMobileCombustion

ghgSource

ghgSourceRef

ghgSourceSyncId

ghgStationaryCombustion

ghgSyncId

view:ghgDirectSources

src

view:ghgEmissions

src

view:ghgEquivalentEmissions

src

view:ghgIndirectSources