Skip to content
No description, website, or topics provided.
Scala CSS JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
conf Bug Fixes. Jul 27, 2017
lib
libexec
project
public fixed text bugs and added number images for lists through out the use… Aug 24, 2017
resources
test
.gitignore
LICENSE
README.md
build.sbt

README.md

README

Data Quality Tool

Verson 1.0 The Data Quality Tool is a simple, open source, application that allows you to validate the data you have stored within the Energy Star Portfolio Manager (PM). The tool provides an easy way to identify problems with both your building's meta data and resource consumption data.

The Data Quality Tools allows you to:

  • Validate PM building meta data
  • Validate Resource Consumption data
  • Access the time frame of the validation in the Current Energy Year
  • Easily find data that needs your attention

The Data Quality Tool is one of many open source tools created by the Maalka Team with support from the U.S. Department of Energy Better Buildings Municipal Portfolio Benchmarking project.

Portfolio Manager fields

Data is imported from an Excel spreadsheet that is populated from within Portfolio Manager. Please references:

Using the Data Quality Tool

The Data Quality Tool provides a way to validate information you have stored in PM. This includes your building meta data; it's address, the date it was built, etc. It also provides validation of current year resource consumption and analytics. It can easily lead you directly to solutions to data problems and helps in curating your Portfolio Manager data.

The steps below provide guidance in extracting your portfolio data and using the Data Quality Tool. In addition, we have prepared a video tutorial to help.

##Data Quality Tool Steps:

  1. Sign in to your Energy Star Portfolio Manager Account
  2. Upload the Data Quality Tool PM Report to your PM Account by pressing this link. Copy Validation Template to your Portfolio Manager Account
    • You will be taken to the Portfolio Manager Custom Reports dashboard.
    • There you will find a new custom report named Municipal Portfolio Benchmark report
  3. Select the Municipal Portfolio Benchmark report and select I want to" ... "Edit this Template"
    • During the edit process, you will add the buildings from within your PM account that you wish to review the data quality.
    • Save the edit template
  4. Select the I want to" ... "Generate New Report"
    • This will populate the Municipal Portfolio Benchmark report with data from the buildings you selected during step #3.
    • You will need to wait for the new report to be completed.
  5. Select the I want to" ... "Download Current Report in Excel"
    • This will download the report to your local machine
    • You are now ready to upload the report to the Data Quality Tool.
  6. Switch back to the Data Quality Tool in your browser
  7. Press the **Select Energy Star Portfolio Manager Report" button
    • You will be presented with a select local file dialog
    • Select the Municipal Portfolio Benchmark Excel (xlsx) file that was downloaded from Portfolio Manager
  8. Press the Validate link within the Data Quality Tool.

Sample Template

You can also test out the Data Quality Tool using a Sample PM Report. This will provide you with a full run-through of the tool.

  1. Download the Sample Report (note - this picks up at step #5 above)
  2. go to the Data Quality Tool
  3. Press the **Select Energy Star Portfolio Manager Report" button
    • You will be presented with a select local file dialog
    • Select the Municipal Portfolio Benchmariking_test report.xlsx Excel (xlsx) file that was downloaded in #2 above
  4. Press the Validate link within the Data Quality Tool.

You will see the following screen:

Alt text

Data Validation

The Data Validation Tool applies a collection of rules to the data in the PM report. These rules are represented in the open source tool as a collection of programmatic conditions. They allow access to various information concerning your buildings.

Building parameters

  • Use type parameters validated by national ranges (see national average document)
  • Property Floor Area-Building(s) (if > 0)
  • Year Built (if > 1800)
  • Property Name (if exists)
  • Location
    • Address (if exists)
    • City (if exists)
    • State (if one of 50 states)
    • Country (if exists)
    • Zipcode (if 6 digits, numeric)
  • ENERGY STAR Score
    • if("Primary Property Type - EPA Calculated" is in Property List Below) {ES Score shoud be 1-100}

      Bank branch | Barracks | Courthouse | Data center | Distribution center | Financial office | Hospital (general medical & surgical) | Hotel | K-12 school | Medical office | Multifamily housing | Non-refrigerated warehouse | Office | Refrigerated warehouse | Residence hall/ dormitory | Retail store | Senior care community | Supermarket/grocery store | Wastewater treatment plant | Wholesale club/supercenter | Worship facility |

Energy parameters

  • Metered Areas (Energy)
    • Should Exist, Should = "Whole Building"
  • Electricity Use-Grid Purchase & Generate
    • Should Exist, Should be > 0, Should not be "Not Available"
  • Natural Gas Use (kBtu)
    • Should Exist, Should be > 0, Should not be "Not Available"
  • Site EUI (kBtu/ft2)
    • Should exist, Should be >0, Should not be "Not Available", Should be >40 & <375
  • Weather Normalized Source EUI (kBtu/ft2)
    • Should exist, should be >0, should not be "Not Available"

Municipal Benchmark Report Field Definitions

The Municipal Benchmark Report is a Portfolio Manager custom report that is used to collect information from your Portfolio Manager buildings. It is uploaded into your Portfolio Manager account, populated with your portfolio data, and downloaded for validation using the Data Quality tool. This downloaded report is a standard Microsoft Excel spreadsheet that has rows for each of your buildings and columns representing the data for those buildings.

The following data fields are contained in the Municipal Benchmark Report:

  • Property Id - The Portfolio Mangager property ID
  • Property Name - A user friendly name of the property
  • Year Ending - The Date of the final data entry
  • Address 1 - Street address of the property
  • City - The city of the property
  • Country - The country
  • State/Province - The state or provence
  • Postal Code - Address postal code
  • Property GFA - Gross Floor Area should include all space within the building(s), including classrooms, administrative space, conference rooms, kitchens used by staff, lobbies, cafeterias, auditoriums, stairways, atriums, elevator shafts, and storage areas.
    • EPA Calculated (Parking) (ft²) - Area of parking associated with the property
    • EPA Calculated (Buildings) (ft²) - Floor area of the building (all floors and uses)
    • EPA Calculated (Buildings and Parking) (ft²) - Combination of building and parking areas
  • Primary Property Type (EPA Calculated)- The primary use of the property (reference the Portfolio Manager Glossary)
  • Electricity Use - The total of electric power used by the property represented by the specific source of the electricity. Note that in general, a single property will have only a subset of these metered sources.
    • Grid Purchase and Generated from Onsite Renewable Systems (kWh) - Total electricity used as measured in kilowatt hours
    • Grid Purchase and Generated from Onsite Renewable Systems (kBtu) - Total electricity used as measured in thousands of British Thermo Units
    • Grid Purchase (kWh) - Total electricity purchased from the electrical grid as measured in kilowatt hours
    • Grid Purchase (kBtu) - Total electricity purchased from the electrical grid as measured in thousands of British Thermo Units
    • Generated from Onsite Renewable Systems and Used Onsite (kWh) - Total electricity generated and used on the property as measured in kilowatt hours
    • Generated from Onsite Renewable Systems and Used Onsite (kBtu) - Total electricity generated and used on the property as measured in thousands of British Thermo Units
  • Natural Gas Use (kBtu) - Total natural gas used on the property as measured in thousands of British Thermo Units
  • Fuel Oil #1 Use (kBtu) - Total #1 fuel oil used on the property as measured in thousands of British Thermo Units
  • Fuel Oil #2 Use (kBtu) - Total #2 fuel oil used on the property as measured in thousands of British Thermo Units
  • Fuel Oil #4 Use (kBtu) - Total #4 fuel oil used on the property as measured in thousands of British Thermo Units
  • Fuel Oil #5 & 6 Use (kBtu) - Total #5 or #6 fuel oil used on the property as measured in thousands of British Thermo Units
  • Diesel #2 Use (kBtu) - Total #2 diesel used on the property as measured in thousands of British Thermo Units
  • Kerosene Use (kBtu) - Total kerosene used on the property as measured in thousands of British Thermo Units
  • Propane Use (kBtu) - Total propane used on the property as measured in thousands of British Thermo Units
  • District Steam Use (kBtu) - Total district steam used on the property as measured in thousands of British Thermo Units
  • District Hot Water Use (kBtu) - Total district hot water used on the property as measured in thousands of British Thermo Units
  • District Chilled Water Use (kBtu) - Total district chilled water used on the property as measured in thousands of British Thermo Units
  • Coal - Anthracite Use (kBtu) - Total anthracite coal used on the property as measured in thousands of British Thermo Units
  • Coal - Bituminous Use (kBtu) - Total bituminous coal used on the property as measured in thousands of British Thermo Units
  • Coke Use (kBtu) - Total coke used on the property as measured in thousands of British Thermo Units
  • Wood Use (kBtu) - Total wood product used on the property as measured in thousands of British Thermo Units
  • Other Use (kBtu) - Total any other energy source used on the property as measured in thousands of British Thermo Units
  • Site EUI (kBtu/ft²) - The Energy Use Intensity of the site as calculated by on-site energy uses.
  • Source EUI (kBtu/ft²) - The Energy Use Intensity of the site as calculated by factoring in losses and characteristics of the off-site energy generation facilities.
  • Weather Normalized Source EUI (kBtu/ft²) - Source EUI as normalized by local weather metrics.
  • Address 2 - If needed, a second address line
  • Energy Current Date - The date of the most recent energy consumption metrics

What is this repository for?

Run

  • from sbt command line run: sbt run

  • Now the application can be invoked either from a browser or from the command line (curl)

  • To Set which gfa field to use: maalka { bedesOccupencyTypeCompositeField = "Observed Primary Occupancy Classification" }

You can’t perform that action at this time.