OED Documentation

Examples

Version V1.0.0

The following gives a description of the sample data that was used to create the documentation examples. It gives both a high-level description and the details. It assumes you understand the ideas and terminology of units, meters and groups.. For those interested, more details about conversions and units is available.

Units

The units (and conversions) are described graphically in this figure: Unit and conversion graphic

For now, ignore the arrows that describe the conversions. The different items are labeled as follows:

  • Blue boxes represent meter units
  • Orange ovals represent a unit for graphing (graphing unit)

All units are of type quantity except these:

  • kW and Electric_kW are flow units
  • Fahrenheit, Celsius, Temperature_Fahrenheit and Temperature_Celsius are raw units

Why these units exist will be described on other documentation pages.

Conversions

The conversions linking the units in the example are shown as arrows in the figure above. The actual value of the conversion is not shown. The different items are labeled as follows:

  • A line represents a conversion between two units. The arrow indicates which direction or directions are allowed. If the line has arrows in both directions then it is bidirectional meaning you can convert either way. The line between kg and lb is this way which means OED will convert from kg to lb and lb to kg. A line with only one arrow is unidirectional. The line between Recycling and ton is this way. As such, you can convert from Recycling to ton but not the other way around.
  • A blue line links a meter (in blue) to the unit in which it collects (in orange). For example, the Electric_Utility meter unit is connected to the kWh unit which is a standard electric energy unit. The Electric_Solar meter unit is also connected to the kWh unit as it also collects in this unit. There are also times that the same type of energy source may have meters that collect in different units. This is shown by Natural_Gas_BTU and Natural_Gas_M3 which are both gas meters but they collect in BTU and cubic meters of gas, respectively. Note that these conversions only have an arrow from the meter unit to the graphing unit since OED will only convert data in that direction. As is common, all the conversion values along blue lines are the identity and do not change the value because the meter collects in the connected unit.
  • A pink line is similar to a blue line but represents a conversion that allows one to graph the meter data in the linked unit.
  • A black line links two units (not of type meter). As would be expected, these are all bidirectional since you can, in general, convert both way. In the example, you can convert from ton to lb and lb to ton.

OED can do what it calls chained conversions. This means that any unit that can be reached via an arrow in the allowed direction can be used for graphing a meter unit. For example, the Recycling meter unit can be graphed in kg because there is a chain of conversions from Recycling to ton, ton to lb and lb to kg. Given this, OED can calculate the overall conversion from Recycling to kg. Note the unidirectional arrows stop undesirable conversions such as converting kg of CO2 to meter units such as Electric_Utility. You cannot use CO2 to create electricity.

The follow table gives the details on each interesting conversion. A conversion is defined by the source, destination, slope and intercept. The row with source of Electric_Utility, destination of US $, slope of 0.115 and intercept of 0 means that each kWh of electricity costs 0.115 U.S. dollars or 11.5 cents. Most conversions have an intercept of 0 but temperature is the exception in this example. The table also indicates if the conversion is bidirectional. The conversion from a meter to its unit of collection (blue, unidirectional arrows) are all slope of 1, intercept of 0 and bidirectional of No so are not listed. The values are meant to be reasonable for each quantity; clearly different locations and times will have different values.

SourceDestinationSlopeInterceptBidirectional?Note
Electric_UtilityUS $0.1150No
Electric_Utilitykg of CO₂0.7090No
Electric_SolarUS $0.70No
Electric_Solarkg of CO₂00NoAssumes solar has no incremental CO2
Natural_Gas_BTUUS $6.75 x 10-60No
Natural_Gas_BTUkg of CO₂5.29 x 10-50No
Natural_Gas_M3US $0.250No
Natural_Gas_M3kg of CO₂1.940No
Water_Gallonkg of CO₂0.00120No
Water_GallonUS $0.0110No
Water_Literkg of CO₂0.000310No
Water_LiterUS $0.002910No
Recyclingkg of CO₂-28900NoThis is CO2 saved from not going to trash and not the net created.
RecyclingUS $00NoAssumes recycling is free.
litergallon0.26417290Yes
kglb2.20Yes
tonlb20000Yes
kWhBTU3412.1420Yes
BTUm3 gas2.73 x 10-50Yes
kgmetric ton0.0010Yes
CelsiusFahrenheit1.832Yes

The value for the example chained conversion above (Recycling to kg) is worked out as follows (all intercepts are 0):

  1. Recycling to ton has a conversion of slope = 1 which indicates that the quantity of recycling is provided in the unit of ton.
  2. ton to lb has a conversion of 2000 so the total conversion is 1 x 2000 = 2000.
  3. lb to kg has a conversion of 1 / 2.2 because the provided conversion is kg to lb so it must be inverted. This gives a final conversion of 2000 / 2.2 = 909.09. Thus, 1 ton of recycling is the same as 909.09 kg of recycling.

Note that units are incompatible if they are not connected by any direct or chained conversion. For example, if you have a meter collecting in Electric_Utility units then it can be graphed in these compatible units: kWh, BTU, m3 gas, kg of CO2, lb of CO2, metric ton of CO2, ton of CO2 and US $. All other units are incompatible so you cannot display that meter in liter, gallon, kW, Fahrenheit, Celsius, kg, lb nor ton.

Meters

The meters and groups in the example are showing in the following figure. For now we will ignore the groups. Meter and group graphic

The meters are on the left-hand side of the image in the blue rectangles. The beginning of the meter name is the building it is associated with: Library, Dining Hall, Theater or Great Dorm. The exception is "Campus Recycling" which is a campus-wide meter and not associated with a building. It is also unique because this type of data would normally be manually entered into OED and not received from a automated meter. All meters collect for its entire building except the electric meters for "Great Dorm" which has separate meters for the first and second floor of the building.

The following table gives information about the meters. The headers for the columns indicate it contains this information:

  • Name: Is the name of the meter shown in OED and in the figures.
  • Unit: The first part is the meter unit that the meter collects data in and the second is the associated graphic unit. This association can be seen in the image above by the blue arrows from the blue meter unit to the orange graphic unit.
  • Default graphing unit: This is the graphic unit that OED will use if a unit has yet to be selected.
  • Area: This is the size of the building associated with the meter. If it is blank then there is no value. All meters in the example use square meters for the area. Some meters do not have an area. This could be because it was not provided for this sample site or it does not make sense such as for "Campus Recycling".
  • Reading frequency: This is the time that each reading spans for this meter. For example, a value of 1 hour means each reading given to OED should be for 1 hour of use. This value impacts the accuracy of points returned in the line graphic.
  • Note: Any needed descriptive information.
NameUnitDefault graphic unitAreaReading frequencyNote
Dining Hall ElectricElectric_Utility / kWhkWh1,00015 minutes
Dining Hall GasNatural_Gas_BTU / BTUBTU1,00015 minutes
Dining Hall WaterWater_Gallon / gallongallon1,0001 hour
Dining Hall Electric PowerElectric_kW / kWkW1,0005 minutesNote that all Power meters are kW (not kWh). The meter reads at a highest frequency.
Theater ElectricElectric_Utility / kWhkWh10,00020 minutes
Theater GasNatural_Gas_M3 / m3 gasBTU10,00020 minutesNote that the default graphic unit differs from the meter unit.
Theater Electric PowerElectric_kW / kWkW10,00020 minutes
Theater TemperatureTemperature_Celsius / kWhFahrenheit20 minutesNote that the default graphic unit differs from the meter unit.
Library ElectricElectric_Utility / kWhkWh100,00023 minutesThis is an unusual reading frequency but shows OED can handle it.
Library TemperatureTemperature_Fahrenheit / FahrenheitFahrenheit20 minutes
Great Dorm 1st Floor ElectricElectric_Solar / kWhkWh5,00020 minutesOnly the first floor of a two story building and half the area. Note it gets electricity from solar.
Great Dorm 2nd Floor ElectricElectric_Solar / kWhkWh5,00020 minutesOnly the second floor of a two story building and half the area. Note it gets electricity from solar.
Great Dorm GasNatural_Gas_BTU / BTUBTU10,00020 minutes
Great Dorm WaterWater_Liter / litergallon10,00015 minutesNote that the default graphic unit differs from the meter unit. Also, water is read at a different frequency than other meters in this building.
Campus RecyclingRecycling / tonlb7 daysNote that the default graphic unit differs from the meter unit. Also, the reading frequency is very low because it is entered manually but OED can deal with that.

groups

The figure above has the groups shown in the yellow rectangles. A line from a meter to a group indicates that the meter is a member of the group. A line from a group to a group indicates the group on the left is a member of the group on the right. Each group shows all of its members with the same color line. For example, "Dinning Hall All" contains the meter "Dining Hall Water" and the group "Dining Hall Energy" where they are connected by a pink line.

As an example shown another way, the "Campus Gas" group can be visualized similarly to the map shown in OED as in the following figure that shows it includes "Dining Hall Gas", "Theater Gas" and "Great Dorm Gas" meters. Campus Gas group graphic

As another example, the "Campus Electric" group can be visualized as in the following figure that shows it includes "Library Electric", "Dining Hall Electric" and "Theater Electric" meters along with the "Great Dorm Electric" group. Campus Electric group graphic

The following table gives information about the groups where the headers indicate similar information as the meter equivalent.

NameDefault graphic unitAreaNote
Dining Hall EnergykWh1,000
Dining Hall Allton of CO₂1,000
Theater EnergykWh10,000
Theater Allton of CO₂10,000
Dining & Theater Electric PowerkW
Library EnergykWh10,0000
Great Dorm ElectrickWh10,000
Great Dorm EnergykWh10,000
Great Dorm Allton of CO₂10,000
Campus ElectrickWh121,000
Campus GasBTU121,000
Campus EnergykWh121,000
Campus Allton of CO₂121,000
Campus All - Anotherton of CO₂121,000