urbanopt-reporting 0.1.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eae158ffc7f5239454037c578719bc38263a2991b0597ea1654ff682c875dbf0
-  data.tar.gz: 83f93741c0f85426fd02132cc57c245b1f38967f1e4f02712447c8c0ad8e4ca6
+  metadata.gz: 0adaa330d8958566edae263cedfd8a1bdee84769c881b98b86481ec4b0ee8bd5
+  data.tar.gz: ceb2145a16413bd4885a1ef81fc9e534d8ed96e49ba19aaff47980dfeaa4838a
 SHA512:
-  metadata.gz: ffcc7a5f81d1bc56569a74cfecfc14593125faacede9f5e52256a568392eec8cb0a8e02d0ba2ce4ae3f9d4d52f7d00cf60720f30d7d66b2a8d38dcef898e0cac
-  data.tar.gz: 685fcf61b239616865a48b4cdf1f3179f246b07fceeed4be9f240dee44eefba3fac32b4b52afeb564675873a5bef5eb72a60a3b64b411e151b21eb7b5423ba5b
+  metadata.gz: d8b2234582c11610f1ad932566bc60e8006930b6038dc619d307955739b21b63b3493488fea25cb2c66d3bb8c70433aebdacd66739920c944d08f53052ac105c
+  data.tar.gz: 5be211005727f24581d0a2e2540db99b1aff5ac1003bdbaf61fafd0b6c4bbfbb2b293408afaac7cb45aa4f757cb153fb2c4aa420ca7bbcbc3e2e5ee40c1f5b3d

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,19 @@
+### Expected behavior
+
+_A clear and concise description of what you expected to happen._
+
+### Actual behavior
+
+_A clear and concise description of what actually happens._
+
+### To Reproduce
+
+Steps to reproduce the behavior:
+
+1. Go to '...'
+1. Enter '...'
+1. Enter '...'
+
+### Additional context
+
+_E.g.: Windows, Mac, Linux? Are you behind a firewall? Do you have additional security constraints?_

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+### Is your feature request related to a problem?
+
+A clear and concise description of what the problem is. _I'm frustrated when..._
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -0,0 +1,13 @@
+### Resolves #[issue number here]
+
+### Pull Request Description
+
+[description here]
+
+### Checklist (Delete lines that don't apply)
+
+- [ ] Unit tests have been added or updated
+- [ ] Documentation has been modified appropriately
+- [ ] All ci tests pass (green)
+- [ ] An [ISSUE](https://github.com/urbanopt/urbanopt-reporting-gem/issues) has been created that this is addressing. Issues will get added to the Change Log when the change_log.rb script is run.
+- [ ] This branch is up-to-date with develop

data/.rdoc_options

@@ -0,0 +1,36 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- lib
+charset: UTF-8
+exclude:
+- doc_templates
+- docs
+- lib/measures
+- node_modules
+- spec
+- test
+- Gemfile
+- Gemfile.lock
+- Jenkinsfile
+- LICENSE.md
+- README.md
+- Rakefile
+- urbanopt-reporting-gem.gemspec
+- JSON
+- Object
+hyperlink_all: false
+line_numbers: false
+locale:
+locale_dir: locale
+locale_name:
+main_page: RDOC_MAIN.md
+output_decoration: true
+op_dir: ./docs/.vuepress/public/rdoc
+show_hash: false
+tab_width: 8
+template_stylesheets: ["./docs/.vuepress/public/custom_rdoc_styles.css"]
+title:
+visibility: :protected
+webcvs:

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # URBANopt Reporting Gem
 
+## Version 0.3.2
+
+Date Range: 12/07/20 - 12/08/20
+
+- Fixed [#27]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/27 ), reporting measure fails when there are no additional fuels in the model
+- Fixed [#29]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/29 ), restore save_feature_report function for backward compatibility
+- Fixed [#32]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/32 ), bump extension-gem dependency
+
+## Version 0.3.1
+
+Date Range: 11/26/2020 - 12/07/2020
+
+- Fixed [#19]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/19 ), check for nil values to avoid crashing unit conversion
+- Fixed [#24]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/24 ), Support reporting of other fuels
+- Fixed [#28]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/28 ), fix for other_fuels being nil and restore save_feature_report function
+
+## Version 0.3.0
+
+Date Range: 11/12/2020 - 11/25/2020
+
+- Updating dependencies to support OpenStudio 3.1.0
+
+## Version 0.2.1
+
+Date Range: 09/22/2020 - 11/12/2020
+
+- Fixed [#12]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/12 ), add units to the json report attributes
+- Fixed [#14]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/14 ), Add rdocs
+- Fixed [#16]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/16 ), increase sidebar width to show class names
+- Fixed [#18]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/18 ), measure: Handle nil values that crash OpenStudio.convert
+- Fixed [#20]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/20 ), fixed saving csv results bug
+
+## Version 0.2.0
+
+Date Range: 08/27/2020 - 09/21/2020
+
+- Fixed [#5]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/5 ), bug fixes related to REopt classes
+- Fixed [#7]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/7 ), adding TM symbol
+- Fixed [#8]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/8 ), New reopt results
+
 ## Version 0.1.1
 
 08/26/2020
@@ -11,4 +51,4 @@
 
 08/17/2020
 
-Initial release of the urbanopt-reporting gem.
+Initial release of the urbanopt-reporting gem.

data/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Version 1.0
 
-The URBANopt team welcomes your contribution to the project. You can contribute to the URBANopt project in several ways: by using the software, reporting issues, contributing documentation, or contributing code back to the project. The GitHub [Contributing to Open Source](https://opensource.guide/how-to-contribute/) guide provides a good overview. If you contribute code, you agree that your contribution may be incorporated into the URBANopt Software Development Kit (SDK) and made available under the URBANopt SDK license.
+The URBANopt<sup>&trade;</sup> team welcomes your contribution to the project. You can contribute to the URBANopt project in several ways: by using the software, reporting issues, contributing documentation, or contributing code back to the project. The GitHub [Contributing to Open Source](https://opensource.guide/how-to-contribute/) guide provides a good overview. If you contribute code, you agree that your contribution may be incorporated into the URBANopt Software Development Kit (SDK) and made available under the URBANopt SDK license.
 
 The contribution process for URBANopt is composed of three steps:
 

data/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, 

data/RDOC_MAIN.md

@@ -0,0 +1,10 @@
+# URBANopt Reporting Gem
+
+### [back to main docs](../)
+
+The URBANopt™ Reporting Gem defines the URBANopt Scenario report and Feature reports. It also includes the default reporting measure which queries the simulation results from the energyplus sql database and inserts them into the Feature reports.
+
+The [schema](https://urbanopt.github.io/urbanopt-reporting-gem/schemas/scenario-schema.html) link contains more information about the JSON schema for Scenario and Feature reports.
+
+[RDoc Documentation](https://urbanopt.github.io/urbanopt-reporting-gem/)
+

data/README.md

@@ -1,6 +1,6 @@
 # URBANopt Reporting Gem
 
-The URBANopt Reporting Gem defines the URABNopt reports (Scenario and Feature reports). It also includes the default reporting measure which query results from the energyplus sql database and reports it in the Feature reports.
+The URBANopt<sup>&trade;</sup> Reporting Gem defines the URABNopt reports (Scenario and Feature reports). It also includes the default reporting measure which query results from the energyplus sql database and reports it in the Feature reports.
 
 
 [RDoc Documentation](https://urbanopt.github.io/urbanopt-reporting-gem/)

data/Rakefile

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/deploy_docs.sh

@@ -0,0 +1,5 @@
+set -e
+bundle exec rdoc --template-stylesheets ./docs/.vuepress/public/custom_rdoc_styles.css
+npm run build --prefix docs
+#npm run dev --prefix docs
+npm run deploy --prefix docs

data/doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, 

data/doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *********************************************************************************
-  # URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
   # contributors. All rights reserved.
   #
   # Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/copyright_js.txt

@@ -1,4 +1,4 @@
 /* @preserve
- * URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
+ * URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
  * Use of this source code is governed by the BSD 3-Clause license.
 */

data/doc_templates/copyright_ruby.txt

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/docs/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.vuepress/public/rdoc/
+.vuepress/dist/

data/docs/.vuepress/components/InnerJsonSchema.vue

@@ -0,0 +1,76 @@
+<template>
+  <div>
+    <a v-if="rawMode" @click="rawMode = false">view pretty</a>
+    <a v-if="!rawMode" @click="rawMode = true">view raw</a>
+    <div v-show="!rawMode" ref="schemaTarget" class="schema-pretty"/>
+    <pre v-show="rawMode"><code v-html="schemaFormatted" class="json"/></pre>
+  </div>
+</template>
+<script>
+import "json-schema-view-js/dist/style.css";
+import "highlight.js/styles/railscasts.css";
+import highlightJson from "../highlight";
+import { emptyPromise } from '../utils';
+
+const JSONSchemaViewP = emptyPromise();
+
+export default {
+  name: "InnerJsonSchema",
+  props: ["schema"],
+  data() {
+    return {
+      rawMode: false,
+    };
+  },
+  created() {
+    // created only runs on the client, which is good because
+    // this module causes an error if we load it in a server context
+    import("json-schema-view-js").then(JSONSchemaViewP.resolve);
+  },
+  computed: {
+    view() {
+      return JSONSchemaViewP
+        .then( () => new window.JSONSchemaView(this.schema, 2, {
+          theme: "dark"
+        }));
+    },
+    schemaFormatted() {
+      return highlightJson(JSON.stringify(this.schema, null, 2));
+    }
+  },
+  methods: {
+    async replaceRenderedSchema() {
+      const v = await this.view; // this never resolves on the server
+      this.$refs.schemaTarget.innerHtml = "";
+      this.$refs.schemaTarget.appendChild(v.render());
+    }
+  },
+  watch: {
+    schema: {
+      handler: "replaceRenderedSchema",
+      immediate: true
+    }
+  }
+};
+</script>
+<style>
+.schema-pretty {
+  margin-top: 0.85rem;
+  background-color: #282c34;
+  padding: 1.25rem 1.5rem;
+  border-radius: 6px;
+}
+.json-formatter-row a {
+  color: white;
+}
+.json-formatter-row .json-formatter-bracket,
+.json-formatter-row .json-formatter-number {
+  color: #9090fb;
+}
+.json-formatter-row .json-formatter-key {
+  color: #8665d0;
+}
+.json-schema-view .object .inner.oneOf b {
+  color: aqua;
+}
+</style>

data/docs/.vuepress/components/JsonSchema.vue

@@ -0,0 +1,12 @@
+<template>
+  <ClientOnly>
+    <InnerJsonSchema :schema="schema" />
+  </ClientOnly>
+</template>
+
+<script>
+export default {
+  name: 'JsonSchema',
+  props: ['schema'],
+}
+</script>

data/docs/.vuepress/components/ScenarioSchema.vue

@@ -0,0 +1,12 @@
+<template>
+  <JsonSchema :schema="schema"/>
+</template>
+<script>
+import { default as schema } from "../../../lib/urbanopt/reporting/default_reports/schema/scenario_schema.json";
+export default {
+  name: "ScenarioSchema",
+  data() {
+    return { schema };
+  }
+};
+</script>

data/docs/.vuepress/components/StaticLink.vue

@@ -0,0 +1,8 @@
+<script>
+export default {
+  name: "StaticLink",
+  render(h) {
+    return h("a", { domProps: this.props }, this.$slots.default);
+  }
+};
+</script>

data/docs/.vuepress/config.js

@@ -0,0 +1,25 @@
+const path = require('path');
+
+module.exports = {
+  base: '/urbanopt-reporting-gem/',
+  themeConfig: {
+    navbar: false,
+    sidebar: [
+      "/",
+      {
+        title: "Schemas",
+        children: [
+          "/schemas/scenario-schema.md"
+        ]
+      }
+    ]
+  },
+  chainWebpack: config => {
+    config.module
+      .rule('json')
+        .test(/\.json$/)
+        .use(path.join(__dirname, 'json-schema-deref-loader.js'))
+          .loader(path.join(__dirname, 'json-schema-deref-loader.js'))
+          .end()
+  },
+};

data/docs/.vuepress/highlight.js

@@ -0,0 +1,8 @@
+import hljs from "highlight.js";
+import json from "highlight.js/lib/languages/json";
+
+hljs.registerLanguage("json", json);
+
+export default function(code) {
+  return hljs.highlight("json", code, true).value;
+}

data/docs/.vuepress/json-schema-deref-loader.js

@@ -0,0 +1,22 @@
+// thanks to https://gist.github.com/mgesmundo/07d6ea3958ed4c7d19d1161551fa46ca
+const $RefParser = require('@apidevtools/json-schema-ref-parser')
+
+module.exports = async function () {
+  const parser = new $RefParser()
+  const schema = await parser.dereference(this.resourcePath, {
+    dereference: {
+      circular: false
+    }
+  })
+  const resolve = await parser.resolve(this.resourcePath, {
+    dereference: {
+      circular: false
+    }
+  })
+
+  for (const dep in resolve._$refs) {
+    this.addDependency(dep)
+  }
+
+  return JSON.stringify(schema)
+}

data/docs/.vuepress/public/custom_rdoc_styles.css

@@ -0,0 +1,78 @@
+:link, :visited {
+    color: #3eaf7c;
+}
+:link:hover  {
+    border-bottom: 1px solid #3eaf7c;
+}
+body {
+    background-color: #fff;
+    font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif !important;
+}
+
+main h1, main h2, main h3, main h4, main h5, main h6 {
+    font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;
+}
+h1, h2, h3, h4, h5, h6 {
+    font-weight: 600;
+    line-height: 1.25;
+}
+main h1 {
+    margin-top: 1.5rem !important;
+    margin-bottom: 1rem;
+    font-size: 2.2rem;
+}
+
+#home-section, #search-section, #fileindex-section {
+    display: none !important;
+}
+
+nav {
+    width: 450px;
+}
+.nav-section h3 {
+    color: #999;
+    font-size: 1.1em;
+    font-weight: 700;
+    background-color: #fff;
+    text-align: left;
+}
+nav .nav-section {
+    border-top: none;
+    font-size: unset;
+}
+
+.link-list a {
+    display: inline-block;
+    padding: .35rem 1rem .35rem 2rem;
+    font-weight: 400;
+    color: #2c3e50;
+    border-left: .25rem solid transparent;
+    padding: .35rem 1rem .35rem 1.25rem;
+    line-height: 1.4;
+    width: 100%;
+    box-sizing: border-box;
+}
+.link-list a:hover, .link-list :link:hover {
+    color: #3eaf7c;
+    border-bottom: none;
+}
+
+/* Hide the URBANopt::Scenario:: prefix common to most links */
+ul.link-list li {
+    margin: .35rem 1rem .35rem 1.25rem;
+    overflow: hidden;
+}
+.link-list a[href^="./URBANopt/Scenario/"] {
+  margin-left: -145px;
+}
+.link-list a {
+  padding: 0;
+  margin: -4px;
+}
+
+/* Remove some modules that aren't commented */
+.link-list a[href="./URBANopt.html"],
+.link-list a[href="./URBANopt/Scenario.html"],
+.link-list a[href="./URBANopt/Scenario/DefaultReports.html"] {
+    display: none;
+}