urbanopt-cli 0.8.2 → 0.9.0

data/example_files/python_deps/dependencies.json

@@ -0,0 +1,5 @@
+[ 
+  { "name": "urbanopt-ditto-reader", "version": "0.5.1"}, 
+  { "name": "NREL-disco", "version": "0.4.1"},
+  { "name": "geojson-modelica-translator", "version": "0.4.0"}
+]

data/example_files/python_deps/install_python.ps1

@@ -0,0 +1,96 @@
+param (
+    [Parameter(Mandatory=$true)][string]$conda_version,
+    [Parameter(Mandatory=$true)][string]$python_version,
+    [Parameter()][string]$install_path = "."
+)
+
+function Invoke-WebRequestExitOnError {
+    param([string]$url, [string]$filename)
+    Write-Debug "Invoke-WebRequest $url"
+
+    try {
+        Invoke-WebRequest -OutFile $filename $url
+    }
+    catch {
+        throw "failed to download $url"
+    }
+}
+
+
+function Get-Python {
+    param([string]$conda_base_url, [string]$filename, [string]$python_version, [string]$install_path)
+    $path = Join-Path "." "${filename}"
+	$url = "https://repo.anaconda.com/miniconda/${filename}"
+    if (($FORCE_DOWNLOAD -eq 1) -and (Test-Path $path)) {
+        Remove-Item $path
+    }
+    if (!(Test-Path $path)) {
+        Invoke-WebRequestExitOnError $url $path
+    }
+
+    $full_path = Resolve-Path $install_path
+    $dst = Join-Path $full_path "python-$python_version"
+    $cmd_args = "/InstallationType=JustMe /AddToPath=0 RegisterPython=0 /S /D=${dst}"
+    $result = Start-Process -FilePath ${path} -NoNewWindow -PassThru -Wait -ArgumentList $cmd_args
+    if ($FORCE_DOWNLOAD -eq 1) {
+        # This delay exists because we've observed cases where deleting the file fails because
+        # Windows says it is still in use. This seems to fix the issue.
+        Start-Sleep -Seconds 5
+        Remove-Item $path
+    }
+    if ($result.ExitCode -ne 0) {
+        $msg = "Failed to run Python installer: ExitCode=${result.ExitCode}" 
+        Write-Error $msg
+        exit $result.ExitCode
+    }
+}
+
+
+### MAIN ###
+#
+# Example usage:
+# .\install_python.ps1 4.12.0 3.9
+#
+# Anaconda recommends only running this distribution in an Anaconda shell.
+# pip will fail with SSL errors in a non-Anaconda PowerShell.
+# Anaconda says to workaround the issue by setting this environment variable:
+# $env:CONDA_DLL_SEARCH_MODIFICATION_ENABLE = 1
+# Refer to https://github.com/conda/conda/issues/8273
+# To test the install run these commands:
+# .\python-3.9\python --version
+# .\python-3.9\Scripts\pip list
+#
+# To enable debug prints run this in the shell:
+# $DebugPreference="Continue"
+#
+# To prevent re-download of the Python package set the environment variable
+# FORCE_DOWNLOAD to 0.
+#
+# If you get the error "running scripts is disabled on this system" then follow
+# the provided link or run the command below to change the security policy for
+# the current shell:
+# Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process
+
+$python_version_fields = $python_version -split "\."
+if ($python_version_fields.length -ne 2) {
+    $msg = "failed to run [$command]: ExitCode={0}" -f $result.ExitCode
+    Write-Error "Python version must be major.minor, such as '3.9'"
+    exit 1
+}
+$python_major_minor = -join $python_version_fields[0..1]
+$conda_base_url = "https://repo.anaconda.com/miniconda/"
+$conda_package_name = "Miniconda3-py${python_major_minor}_${conda_version}-Windows-x86_64.exe"
+
+if (Test-Path env:FORCE_DOWNLOAD) {
+    $FORCE_DOWNLOAD = $env:FORCE_DOWNLOAD
+} else {
+    $FORCE_DOWNLOAD = 1
+}
+Write-Debug "FORCE_DOWNLOAD=${FORCE_DOWNLOAD}"
+
+if (!(Test-Path $install_path)) {
+    mkdir $install_path
+}
+
+$ErrorActionPreference = "Stop"
+Get-Python $conda_base_url $conda_package_name $python_version $install_path

data/example_files/python_deps/install_python.sh

@@ -0,0 +1,120 @@
+#!/bin/bash
+
+# Installs Python via Miniconda for Linux and MacOS.
+
+function log_message
+{
+	# Severity is first argument.
+	echo ${@:2}
+	echo "$(date) - $1 - ${@:2}" >> $LOG_FILE
+}
+
+function debug
+{
+	if [ $VERBOSE -eq 1 ]; then
+		log_message "DEBUG" $@
+	fi
+}
+
+function info
+{
+	log_message "INFO" $@
+}
+
+function error
+{
+	log_message "ERROR" $@
+}
+
+function run_command
+{
+	debug "run command [$@]"
+	$@ > /dev/null
+	ret=$?
+	if [ $ret != 0 ]; then
+		error "command=[$@] failed return_code=$ret"
+		exit $ret
+	fi
+}
+
+function show_help
+{
+	echo "Usage:  $0 MINICONDA_VERSION PYTHON_VERSION PATH"
+}
+
+### MAIN ###
+
+LOG_FILE="/tmp/install_python.log"
+> $LOG_FILE
+
+if [ -z $VERBOSE ]; then
+	VERBOSE=0
+fi
+
+# Developers can set this to 0 to prevent repeated downloads.
+# Normal operation is download the file every run and delete it afterwards.
+if [ -z $FORCE_DOWNLOAD ]; then
+	FORCE_DOWNLOAD=1
+fi
+
+if [ -z $3 ]; then
+	show_help
+	exit 1
+fi
+
+CONDA_VERSION=$1
+PYTHON_FULL_VERSION=$2
+IFS="." read -ra VER_ARRAY <<< "$PYTHON_FULL_VERSION"
+if [ ${#VER_ARRAY[@]} -lt 2 ] ; then
+	error "invalid python version: format x.y.z"
+	exit 1
+fi
+PYTHON_MAJOR_MINOR="${VER_ARRAY[0]}${VER_ARRAY[1]}"
+INSTALL_BASE=$3
+
+if [ ! -d $INSTALL_BASE ]; then
+	error "path $INSTALL_BASE does not exist"
+	exit 1
+fi
+
+if [[ "$OSTYPE" == "linux-gnu" ]]; then
+	PLATFORM=Linux-x86_64
+elif [[ "$OSTYPE" == "darwin"* ]]; then
+	PLATFORM=MacOSX-x86_64
+else
+	error "unknown OS type $OSTYPE"
+	exit 1
+fi
+
+CONDA_PACKAGE_NAME=Miniconda3-py${PYTHON_MAJOR_MINOR}_${CONDA_VERSION}-${PLATFORM}.sh
+CONDA_URL=https://repo.anaconda.com/miniconda/$CONDA_PACKAGE_NAME
+CONDA_PACKAGE_PATH=/tmp/$CONDA_PACKAGE_NAME
+
+INSTALL_PATH=./Miniconda-${CONDA_VERSION}
+PIP=$INSTALL_PATH/bin/pip
+PYTHON=$INSTALL_PATH/bin/python
+
+debug "PYTHON_FULL_VERSION=$PYTHON_FULL_VERSION"
+debug "PYTHON_MAJOR_MINOR=$PYTHON_MAJOR_MINOR"
+debug "CONDA_VERSION=$CONDA_VERSION"
+debug "CONDA_PACKAGE_NAME=$CONDA_PACKAGE_NAME"
+debug "CONDA_URL=$CONDA_URL"
+debug "CONDA_PACKAGE_PATH=$CONDA_PACKAGE_PATH"
+debug "INSTALL_PATH=$INSTALL_PATH"
+debug "PIP=$PIP"
+
+if [ $FORCE_DOWNLOAD -eq 1 ] && [ -f $CONDA_PACKAGE_PATH ]; then
+	run_command "rm -f $CONDA_PACKAGE_PATH"
+fi
+
+if [ ! -f $CONDA_PACKAGE_PATH ]; then
+	run_command "curl $CONDA_URL -o $CONDA_PACKAGE_PATH"
+	debug "Finished downloading $CONDA_PACKAGE_NAME"
+fi
+
+run_command "bash $CONDA_PACKAGE_PATH -b -p $INSTALL_PATH -u"
+if [ $FORCE_DOWNLOAD -eq 1 ]; then
+	run_command "rm -rf $CONDA_PACKAGE_PATH"
+fi
+
+debug "Finished installation of Python $PYTHON_FULL_VERSION"

data/example_files/residential/clothes_dryer.tsv

@@ -1,12 +1,12 @@
-Dependency=Template Month	Dependency=Template Year	Dependency=clothes_dryer_fuel_type	clothes_dryer_location	clothes_dryer_efficiency	Source
+Dependency=Template Month	Dependency=Template Year	Dependency=clothes_dryer_fuel_type	clothes_dryer_present	clothes_dryer_efficiency	Source
 				lb/kWh	
-Sep	2020	electricity	auto	3.93	"ResStock ""Electric, Premium, EnergyStar 100% Usage"""
-Sep	2020	natural gas	auto	3.03	"ResStock ""Gas, Premium, 100% Usage"""
-Sep	2020	fuel oil	auto	3.03	Engineering judgment
-Sep	2020	propane	auto	3.03	Engineering judgment
-Sep	2020	wood	auto	3.03	Engineering judgment
-Apr	2022	electricity	none	3.93	No Appliance
-Apr	2022	natural gas	none	3.03	No Appliance
-Apr	2022	fuel oil	none	3.03	No Appliance
-Apr	2022	propane	none	3.03	No Appliance
-Apr	2022	wood	none	3.03	No Appliance
+Sep	2020	electricity	true	3.93	"ResStock ""Electric, Premium, EnergyStar 100% Usage"""
+Sep	2020	natural gas	true	3.03	"ResStock ""Gas, Premium, 100% Usage"""
+Sep	2020	fuel oil	true	3.03	Engineering judgment
+Sep	2020	propane	true	3.03	Engineering judgment
+Sep	2020	wood	true	3.03	Engineering judgment
+Apr	2022	electricity	false	3.93	No Appliance
+Apr	2022	natural gas	false	3.03	No Appliance
+Apr	2022	fuel oil	false	3.03	No Appliance
+Apr	2022	propane	false	3.03	No Appliance
+Apr	2022	wood	false	3.03	No Appliance

data/example_files/residential/clothes_washer.tsv

@@ -1,4 +1,4 @@
-Dependency=Template Month	Dependency=Template Year	clothes_washer_efficiency	clothes_washer_rated_annual_kwh	clothes_washer_label_electric_rate	clothes_washer_label_gas_rate	clothes_washer_label_annual_gas_cost	clothes_washer_label_usage	clothes_washer_capacity	clothes_washer_location	Source
+Dependency=Template Month	Dependency=Template Year	clothes_washer_efficiency	clothes_washer_rated_annual_kwh	clothes_washer_label_electric_rate	clothes_washer_label_gas_rate	clothes_washer_label_annual_gas_cost	clothes_washer_label_usage	clothes_washer_capacity	clothes_washer_present	Source
 		ft^2/kWh-cyc	kWh/yr	$/kWh	$/therm	$	cyc/wk	ft^3		
-Sep	2020	2.92	75	0.12	1.09	7	6	4.5	auto	"ResStock ""EnergyStar Most Efficient, 100% Usage"""
-Apr 	2022	2.92	75	0.12	1.09	7	6	4.5	none	No Appliance
+Sep	2020	2.92	75	0.12	1.09	7	6	4.5	true	"ResStock ""EnergyStar Most Efficient, 100% Usage"""
+Apr 	2022	2.92	75	0.12	1.09	7	6	4.5	false	No Appliance

data/example_files/residential/dishwasher.tsv

@@ -1,4 +1,4 @@
-Dependency=Template Month	Dependency=Template Year	dishwasher_efficiency	dishwasher_label_electric_rate	dishwasher_label_gas_rate	dishwasher_label_annual_gas_cost	dishwasher_label_usage	dishwasher_place_setting_capacity	dishwasher_location	Source
+Dependency=Template Month	Dependency=Template Year	dishwasher_efficiency	dishwasher_label_electric_rate	dishwasher_label_gas_rate	dishwasher_label_annual_gas_cost	dishwasher_label_usage	dishwasher_place_setting_capacity	dishwasher_present	Source
 		kWh/yr	$/kWh	$/therm	$	cyc/wk	#		
-Sep	2020	199	0.12	1.09	18	4	12	auto	"ResStock ""199 Rated kWh, 100% Usage"""
-Apr	2022	199	0.12	1.09	18	4	12	none	No Appliance
+Sep	2020	199	0.12	1.09	18	4	12	true	"ResStock ""199 Rated kWh, 100% Usage"""
+Apr	2022	199	0.12	1.09	18	4	12	false	No Appliance

data/example_files/resources/hpxml-measures/.github/pull_request_template.md

@@ -14,5 +14,4 @@ PR Reviewer: Verify each has been completed.
 - [ ] Documentation has been updated
 - [ ] Changelog has been updated
 - [ ] `openstudio tasks.rb update_measures` has been run
-- [ ] Checked the code coverage report on CI
 - [ ] No unexpected changes to simulation results of sample files

data/example_files/resources/hpxml-measures/.github/workflows/config.yml

@@ -11,7 +11,7 @@ jobs:
   run-unit-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.4.0
+      image: docker://nrel/openstudio:3.5.0
     steps:
       - uses: actions/checkout@v2
         with:
@@ -20,22 +20,9 @@ jobs:
       - name: Install software
         run: |
           rm -f Gemfile.lock && bundle install
+          export DEBIAN_FRONTEND=noninteractive
           sudo apt update
-          sudo apt-get install -y wget unzip libxml2-utils python3-lxml python3-pip
-          sudo pip3 install sphinx sphinx-rtd-theme
-
-      - name: XSD validation
-        shell: bash
-        run: |
-          export XSDPATH=HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd
-          for xmlfile in workflow/sample_files/*.xml; do xmllint --schema $XSDPATH $xmlfile --noout; done
-
-      - name: Schematron validation
-        shell: bash
-        run: |
-          export PYTHONIOENCODING=utf8
-          export SCTPATH=HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml
-          for xmlfile in workflow/sample_files/*.xml; do XMLPATH=$xmlfile python3 -c "import os; import sys; from lxml import isoschematron, etree; from pathlib import Path; sct = Path(os.environ.get('SCTPATH')).read_text(); sct_doc = etree.fromstring(bytes(sct, encoding='utf-8')); schematron = isoschematron.Schematron(sct_doc, store_report = True); xml_path = os.environ.get('XMLPATH'); xml = Path(xml_path).read_text(); xml_doc = etree.fromstring(bytes(xml, encoding='utf-8')); valid = schematron.validate(xml_doc); (not valid) and print(schematron.validation_report); (not valid) and print(f'{xml_path} fails to validate'); valid and print(f'{xml_path} validates'); (not valid) and sys.exit(1)"; done
+          sudo -E apt-get install -y wget unzip python3-sphinx-rtd-theme
 
       - name: Run measure unit tests
         run: |
@@ -50,7 +37,7 @@ jobs:
       - name: Build documentation
         run: |
           cd docs
-          make html
+          make html SPHINXOPTS="-W --keep-going -n"
 
       - name: Save Docs
         uses: actions/upload-artifact@v2
@@ -61,7 +48,7 @@ jobs:
   run-workflow-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.4.0
+      image: docker://nrel/openstudio:3.5.0
     steps:
       - uses: actions/checkout@v2
         with:
@@ -90,11 +77,11 @@ jobs:
       - name: Install software and run test
         shell: pwsh
         run: |
-          $env:OS_VERSION="3.4.0"
-          $env:OS_SHA="4bd816f785"
+          $env:OS_VERSION="3.5.0"
+          $env:OS_SHA="7b14ce1588"
           Invoke-WebRequest -OutFile Windows.tar.gz -URI "https://github.com/NREL/OpenStudio/releases/download/v${env:OS_VERSION}/OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows.tar.gz"
           tar -xzf Windows.tar.gz
-          & .\OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows\bin\openstudio.exe workflow\run_simulation.rb -x workflow\sample_files\base.xml --hourly ALL --add-component-loads --add-utility-bills --add-detailed-schedule stochastic
+          & .\OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows\bin\openstudio.exe workflow\run_simulation.rb -x workflow\sample_files\base.xml --hourly ALL --add-component-loads --add-detailed-schedule stochastic
 
   compare-results:
     if: github.event_name == 'pull_request'

data/example_files/resources/hpxml-measures/.gitignore

@@ -2008,4 +2008,6 @@
 /workflow/sample_files/run
 /files
 /BuildResidentialHPXML/tests/extra_files
+/ReportUtilityBills/resources/detailed_rates/*.json
+!/ReportUtilityBills/resources/detailed_rates/Sample*.json
 /ReportUtilityBills/tests/results_bills.csv