Merge branch 'master' into master

README.md

@@ -25,10 +25,12 @@ This project is structured as follows:
 *  An [ontology](./ontology/README.md) that defines the parameters of the semantic data model ("Terminology box") and tools for building, validating, and associating real equipment with a specific model. It contains the following formats:
    * [Yaml format](./ontology/yaml/README.md)
    * [RDF/OWL format](./ontology/rdf/README.md)
+
 * A [model instance configuration](./ontology/docs/building_config.md) (a.k.a building configuration file) that contains a mapping between the ontology and the "raw" data. Building configuration files are the "Assertion box."
 * Tools that enable the following:
   * [**ABEL**](./tools/abel/README.md)**:** facilitates easier building configration construction by converting from a templatized Google Sheet to a [building configuration file](./ontology/docs/building_config.md) (and from a building configuration file back to a Google Sheet).
   * [**Explorer**](./tools/explorer/README.md)**:** allows users to explore ontology type fields and compare ontology types to each other.
+  * [**Instance Validator**](./tools/validators/ontology_validator/README.md) which allows to validate the yaml ontology upon a change or an extension.
   * [**Ontology Validator**](./tools/validators/ontology_validator/README.md)**:** validates the ontology upon a change or an extension (currently only for the Yaml format).
   * [**RDF/OWL Generator**](./tools/rdf_generator/README.md)**:** generates an RDF version from the yaml ontology files.
 * An [Internal Building Representation (IBR)](./ibr/README.md) file format to represent data from different verticals such as spatial or assets.

ontology/yaml/resources/HVAC/entity_types/ABSTRACT.yaml

@@ -6789,7 +6789,7 @@ OAQM:
   - MONITORING
 
 UDEC:
-  guid: "956f1afb-04b1-4d4d-afb9-4aff1ac51b20"
+  guid: "8755e46b-4e3a-40a1-8abb-778bf309c8f8"
   description: "Up and down extension control for shades."
   is_abstract: true
   uses:
@@ -6810,4 +6810,3 @@ VSMC:
   - low_speed_status
   - high_speed_status
   - schedule_run_command
-

ontology/yaml/resources/HVAC/entity_types/SDC.yaml

@@ -86,7 +86,7 @@ SDC_EXTOR:
   - shade_mode
 
 SDC_UDEC:
-  guid: "34201ca6-677b-47bc-b624-a80581490b6d"
+  guid: "3d48a34f-f6bf-4ae6-b31c-1e4091458b02"
   description: "Simple shade with up and down extent control."
   is_canonical: true
   implements:

tools/README.md

@@ -1,16 +1,33 @@
-# Digital Buildings Toolkit
+# Digital Buildings Tools
+
+Various tools have been developed to support the use of the Digital Buildings Ontology and Building Configuration files. 
+
+The tools are:
+  * [ABEL](./abel/README.md) generates from/to Google spreadsheet/[Building Configuration](../ontology/docs/building_config.md).
+  * [Explorer](./explorer/README.md) allows users to explorer the ontology types and their associated fields.
+  * [Instance Validator](./validators/instance_validator/README.md) which allows to validate the yaml ontology upon a change or an extension.
+    * A sub function of the Instance Validator is to also [validate telemetry messages](./validators/instance_validator/README.md#telemetry-validation) 
+    corresponding to entity blocks in a building configuration file.
+  * [Ontology Validator](./validators/ontology_validator/README.md) which allows to validate the yaml ontology upon a change or an extension.
+
+## Digital Buildings Toolkit
 
 The Digital Buildings Toolkit provides a centralized
 method for interfacing with all of the tools contained within the Digital
 Buildings Repository.
 
-## Install
+### Toolkit Web Application
+
+The [web-based toolkit application](dbo-toolkit-app.azurewebsites.net) also exists to provide a user-friendly interface to all of the Digital Buildings tools. 
+Only the Instance Validator is currently supported, but other tools are planned to be added in the near future.
+
+### Install
 
 To install please follow the instructions below.
 
-### First create a virtual env
+#### First create a virtual env
 
-Create the virtual environment with `venv` followed by the environment name, in this example: `tooling`
+Create the virtual environment with `venv` followed by the environment name, in this example: `tooling`, in the digitalbuildings repository.
 
 ```
 python -m venv tooling
@@ -32,12 +49,12 @@ tooling\Scripts\activate
 
 Then you can either use pip or setuptools.
 
-### Pip
+#### Pip
 1. Run `python3 -m pip install --upgrade pip` to ensure that your Python package management tools are up-to-date.
 
 2. Run `bash pip_install.sh` or `pip_install.bat` (windows) from the following directory digitalbuildings/tools.
 
-### Docker
+#### Docker
 
 1. Install [Docker Desktop](https://docs.docker.com/desktop/)
 2. Run `./tools/docker_run.sh` to build the docker image.
@@ -46,13 +63,13 @@ Then you can either use pip or setuptools.
 $ ./tools/docker_run.sh abel
 ```
 
-### Setup (to be deprecated)
+#### Setup (to be deprecated)
 
 1. Follow setup instructions for the [Instance Validator](./validators/instance_validator).
 2. Follow setup instructions for the [GUID Generator](./guid_generator).
 3. Run `sudo python setup.py` for this directory.
 
-## Toolkit Workflow
+### Toolkit Workflow
 
 Run `python toolkit.py` and provide the following arguments: