urbanopt · vtnate · Jan 6, 2023 · May 17, 2022 · May 17, 2022 · May 17, 2022
diff --git a/.coveragerc b/.coveragerc
@@ -10,7 +10,6 @@ source =
 omit =
     .tox/*
     management/update_schemas.py
-    management/update_licenses.py
     management/check_sys_params.py
     geojson_modelica_translator/model_connectors/load_connectors/templates/RunSpawnCouplingBuilding.most
     geojson_modelica_translator/modelica/lib/runner/__init__.py

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,14 +21,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
-        python-version: ["3.7.1", "3.10"]
+        os: [ubuntu-20.04, windows-latest]
+        python-version: ["3.8", "3.10"]
         test_env: [python, precommit, docs]
-        mbl_branch: [master]
+        mbl_branch: [maint_9.1.x]
         include:
-          - os: ubuntu-latest
+          - os: ubuntu-20.04
             test_env: python
-            mbl_branch: master
+            mbl_branch: maint_9.1.x
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -56,7 +56,7 @@ jobs:
           poetry update
       # -
       #   name: Save Optimica license to file
-      #   if: matrix.os == 'ubuntu-latest'
+      #   if: matrix.os == 'ubuntu-20.04'
       #   shell: bash
       #   run: |
       #     mkdir -p /home/runner/modelon
@@ -80,7 +80,7 @@ jobs:
           MATRIX_OS: ${{ matrix.os }}
           MBL_BRANCH: ${{ matrix.mbl_branch }}
         run: |
-          if [[ "${MATRIX_OS}" == 'ubuntu-latest' ]]; then
+          if [[ "${MATRIX_OS}" == 'ubuntu-20.04' ]]; then
             MODELICAPATH='/home/runner/work/modelica-buildings'
           else
             echo $GITHUB_WORKSPACE
@@ -123,7 +123,8 @@ jobs:
         name: Coveralls
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
-        if: ${{ matrix.os == 'ubuntu-latest' && matrix.test_env == 'python' && matrix.mbl_branch == 'master' }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: ${{ matrix.os == 'ubuntu-20.04' && matrix.test_env == 'python' && matrix.mbl_branch == 'maint_9.1.x' }}
         run: |
           poetry run coveralls
       -

diff --git a/.gitignore b/.gitignore
@@ -105,5 +105,6 @@ tests/*/microgrid_output
 tests/output_ets
 tests/*/output
 /geojson_modelica_translator/modelica/buildingslibrary/
+not/a/real/**
 # TODO: this file shoud not be writtent out, but it is... fix this eventually
 /geojson_modelica_translator/modelica/ets_cooling_indirect_templated.mo
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ exclude: |
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.2.3
+    rev: v4.4.0
     hooks:
       - id: trailing-whitespace
       - id: check-added-large-files
@@ -20,17 +20,45 @@ repos:
       - id: check-yaml
       - id: debug-statements
       - id: end-of-file-fixer
-      #  - id: requirements-txt-fixer
-      - id: flake8
-        args: ['--max-line-length=140']  # default of Black
+      - id: requirements-txt-fixer
       - id: mixed-line-ending
       - id: pretty-format-json
         args: ['--autofix', '--no-sort-keys']
-  - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+  - repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v2.0.1
+    hooks:
+      - id: autopep8
+        args:
+          [
+            "--in-place",
+            "--aggressive",
+            "--aggressive",
+            "--recursive",
+            "--max-line-length=100",
+            "--ignore=E501,E402,W503,W504,E731"
+          ]
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.0.0
+    hooks:
+      - id: autoflake
+        args:
+          [
+            "--in-place",
+            "--recursive",
+            "--remove-all-unused-imports",
+            "--remove-unused-variable",
+            "--ignore-init-module-imports"
+          ]
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        args: ["--ignore=E501,E402,W503,W504,E731,F401"]
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
     hooks:
       - id: isort
-        name: isort (python)
+        args: ["-m=VERTICAL_HANGING_INDENT"] # vertical hanging
   - repo: local
     hooks:
       - id: modelica-fmt

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,15 @@
 Change Log
 ==========
 
+Version 0.4.1
+-------------
+## What's Changed
+* Cli bugfixing
+* Detailed models
+* End-of-year updates to GMT docs
+* Remove support for 3.7 in development, update development dependencies
+* Update copyrights to 2023
+
 Version 0.4.0
 -------------
 As of version 0.4.0 changes will be published using Github automated formatting at the release itself. Those changes are copied here.

diff --git a/LICENSE → LICENSE.md b/LICENSE → LICENSE.md
@@ -1,4 +1,4 @@
-URBANopt, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other contributors.
+URBANopt™, Copyright (c) 2019, 2023 Alliance for Sustainable Energy, LLC, and other contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1 +1 @@
-include LICENSE
+include LICENSE.md
diff --git a/Makefile b/Makefile
@@ -2,4 +2,4 @@ init:
 	pip install -r requirements.txt
 
 test:
-	py.test
+	pytest
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,9 +29,10 @@
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary',
     'sphinx.ext.coverage',
     'sphinx.ext.napoleon',
-    'sphinx.ext.autosummary',
     'sphinx-jsonschema',
 ]
 
@@ -51,7 +52,7 @@
 
 # General information about the project.
 project = u"GeoJSON Modelica Translator"
-copyright = u"2019-2022, Alliance for Sustainable Energy, LLC"
+copyright = u"2019,2023 - Alliance for Sustainable Energy, LLC"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

diff --git a/docs/developer_resources.rst b/docs/developer_resources.rst
@@ -54,15 +54,24 @@ Getting Started as a Developer
 ------------------------------
 
 There are a few steps that are imperative to complete when starting as a developer of the GMT. First, make sure
-to follow the detailed instructions for setting up MBL and Docker in the `getting started <getting_started>`_ guide.
+to follow the detailed instructions for :ref:`Docker Installation` in the Getting Started guide.
 
 Follow the instructions below in order to configure your local environment:
 
-* Clone this repo into a working directory
+* If you need a custom Modelica Buildings Library:
+    * Clone the `MBL <https://github.com/lbl-srg/modelica-buildings>`_ into a working directory outside of the GMT directory
+    * Ensure your MODELICAPATH env var is set to the MBL you want to use! See the documentation at :ref:`MBL Installation`
+    * Change to the directory inside the modelica-buildings repo you just checked out. (:code:`cd modelica-buildings`)
+    * Install git-lfs
+        * Mac: :code:`brew install git-lfs; git lfs install`
+        * Ubuntu: :code:`sudo apt install git-lfs; git lfs install`
+    * The current GMT code works with the :code:`maint_9.1.x` branch of the MBL. GMT version :code:`0.2.3`, which uses JModelica, requires the :code:`issue2204_gmt_mbl` branch of the MBL.
+
+* Clone `the GMT repo <https://github.com/urbanopt/geojson-modelica-translator>`_ into a working directory
 * (optional/as-needed) Add Python 3 to the environment variables
 * For developers, dependency management is through `Poetry`_. Installation is accomplished by running :code:`pip install poetry`.
 * Return to the GMT root directory and run :code:`poetry install`
-* Test if everything is installed correctly by running :code:`poetry run pytest`. This will run all the unit and integration tests.
+* Test if everything is installed correctly by running :code:`poetry run pytest -m 'not compilation and not simulation'`. This will run all the unit and integration tests.
 * Follow the instructions below to install pre-commit.
 * To test pre-commit and building the documentation, you can run :code:`poetry run tox`
 
@@ -102,14 +111,6 @@ project. A developer can run this command by calling
 
 The developer should run the test suite after updating the schemas to ensure that nothing appears to have broken. Note that the tests do not cover all of the properties and should not be used as proof that everything works with the updated schemas.
 
-Updating Licenses
-^^^^^^^^^^^^^^^^^
-
-To apply the copyright/license to all the files, run the following managed task
-
-.. code-block:: bash
-
-    poetry run update_licenses
 
 Adding New Models
 -----------------
@@ -217,7 +218,7 @@ desired, a user can run the simulations manually using JModelica (via Docker). F
 the runner to work locally.
 
 * Make sure jm_ipython.sh is in your local path.
-* After running the :code:`py.test`, go into the :code:`geojson_modelica_translator/modelica/lib/runner/` directory.
+* After running the :code:`pytest`, go into the :code:`geojson_modelica_translator/modelica/lib/runner/` directory.
 * Copy :code:`jmodelica.py` to the :code:`tests/model_connectors/output` directory.
 * From the :code:`tests/model_connectors/output` directory, run examples using either of the the following:
     * :code:`jm_ipython.sh jmodelica.py spawn_single.Loads.B5a6b99ec37f4de7f94020090.coupling`

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -45,12 +45,7 @@ MBL Installation
 
 The Modelica Buildings Library contains many models that are needed to assemble the district systems. Installation of the MBL is done through Git and GitHub. Follow the instructions below to install the MBL needed for the GMT:
 
-* Clone the `MBL`_ into a working directory outside of the GMT directory
-* Change to the directory inside the modelica-buildings repo you just checked out. (:code:`cd modelica-buildings`)
-* Install git-lfs
-    * Mac: :code:`brew install git-lfs; git lfs install`
-    * Ubuntu: :code:`sudo apt install git-lfs; git lfs install`
-* The GMT code works with the :code:`master` branch of the MBL, which is currently version 9.0.0. If the :code:`master` branch has been updated, then use the tag :code:`v9.0.0` to install the MBL.
+* Download and extract the newest 9.1 version of the MBL from `<https://simulationresearch.lbl.gov/modelica/downloads/archive/modelica-buildings.html>`_
 * Add the Modelica Buildings Library path to your MODELICAPATH environment variable (e.g., export MODELICAPATH=${MODELICAPATH}:$HOME/path/to/modelica-buildings). Restart your terminal to ensure that the MBL library is exported correctly.
 
 Once the MBL is installed, then the CLI can be used to create the model with the following command:
@@ -75,7 +70,7 @@ Docker Installation
 -------------------
 
 The preferred method of running the simulations would be within Dymola; however, that is not a
-practical solution for many based on the license requirement. The GMT enables the running of the
+practical solution for many based on the license requirement. Version 0.2.3 of the GMT enables the running of the
 models using JModelica which requires the installation of `Docker`_. To configure Docker, do the
 following:
 

diff --git a/docs/license.rst b/docs/license.rst
@@ -3,4 +3,4 @@
 License
 =======
 
-.. include:: ../LICENSE
+.. include:: ../LICENSE.md
diff --git a/geojson_modelica_translator/geojson/schemas.py b/geojson_modelica_translator/geojson/schemas.py
@@ -1,40 +1,5 @@
-"""
-****************************************************************************************************
-:copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other contributors.
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted
-provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions
-and the following disclaimer.
-
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions
-and the following disclaimer in the documentation and/or other materials provided with the
-distribution.
-
-Neither the name of the copyright holder nor the names of its contributors may be used to endorse
-or promote products derived from this software without specific prior written permission.
-
-Redistribution of this software, without modification, must refer to the software by the same
-designation. Redistribution of a modified version of this software (i) may not refer to the
-modified version by the same designation, or by any confusingly similar designation, and
-(ii) must refer to the underlying software originally provided by Alliance as “URBANopt”. Except
-to comply with the foregoing, the term “URBANopt”, or any confusingly similar designation may
-not be used to refer to any modified version of this software or any modified version of the
-underlying software originally provided by Alliance without the prior written consent of Alliance.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-****************************************************************************************************
-"""
+# :copyright (c) URBANopt, Alliance for Sustainable Energy, LLC, and other contributors.
+# See also https://github.com/urbanopt/geojson-modelica-translator/blob/develop/LICENSE.md
 
 import json
 import os

diff --git a/geojson_modelica_translator/geojson/urbanopt_geojson.py b/geojson_modelica_translator/geojson/urbanopt_geojson.py
@@ -1,40 +1,5 @@
-"""
-****************************************************************************************************
-:copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other contributors.
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted
-provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions
-and the following disclaimer.
-
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions
-and the following disclaimer in the documentation and/or other materials provided with the
-distribution.
-
-Neither the name of the copyright holder nor the names of its contributors may be used to endorse
-or promote products derived from this software without specific prior written permission.
-
-Redistribution of this software, without modification, must refer to the software by the same
-designation. Redistribution of a modified version of this software (i) may not refer to the
-modified version by the same designation, or by any confusingly similar designation, and
-(ii) must refer to the underlying software originally provided by Alliance as “URBANopt”. Except
-to comply with the foregoing, the term “URBANopt”, or any confusingly similar designation may
-not be used to refer to any modified version of this software or any modified version of the
-underlying software originally provided by Alliance without the prior written consent of Alliance.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-****************************************************************************************************
-"""
+# :copyright (c) URBANopt, Alliance for Sustainable Energy, LLC, and other contributors.
+# See also https://github.com/urbanopt/geojson-modelica-translator/blob/develop/LICENSE.md
 
 import logging
 from pathlib import Path
@@ -94,18 +59,16 @@ def __init__(self, filename, building_ids=None):
         self.buildings = []
         for feature in self.data.features:
             if feature["properties"]["type"] == "Building":
-                # Don't validate features with 'detailed_model_filename' in the building properties
-                # Buildings defined by an osm don't have all keys in geojson, they'll always fail validation
-                if "detailed_model_filename" in feature["properties"]:
-                    continue
-                else:
-                    building = UrbanOptLoad(feature)
-                    if not building_ids or building.id in building_ids:
+                building = UrbanOptLoad(feature)
+                if not building_ids or building.id in building_ids:
+                    # Don't care about validation failures for features with 'detailed_model_filename' in the building properties
+                    # Buildings defined by an osm don't have all keys in geojson, they'll always fail validation
+                    if "detailed_model_filename" not in feature["properties"]:
                         errors = self.schemas.validate("building", building.feature.properties)
-                        if errors:
-                            building_errors[building.id] = errors
-                        else:
-                            self.buildings.append(building)
+                    if errors:
+                        building_errors[building.id] = errors
+                    else:
+                        self.buildings.append(building)
 
         if building_errors:
             formatted_errors = ''
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,4 @@ init: @@
     	pip install -r requirements.txt
     test:
-    	py.test
+    	pytest