From 50c1ade5174196ba3d23acc0a5ecdbf590d45a06 Mon Sep 17 00:00:00 2001 From: travis Date: Mon, 25 Sep 2023 09:52:03 -0700 Subject: [PATCH 1/3] Update README.md and tools/README.md --- README.md | 2 +- tools/README.md | 33 +++++++++++++++++++++++++-------- 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3be98ea652..e60f46a17c 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ This project is structured as follows: * Tools that allow the following: * [ABEL](./tools/abel/README.md) generates from/to Google spreadsheet/[Building Configuration](./ontology/docs/building_config.md). * [Explorer](./tools/explorer/README.md) allows users to explorer the ontology types and their associated fields. - * [Yaml Validator](./tools/validators/ontology_validator/README.md) which allows to validate the yaml ontology upon a change or an extension. + * [Instance Validator](./tools/validators/ontology_validator/README.md) which allows to validate the yaml ontology upon a change or an extension. * [RDF/OWL Generator](./tools/rdf_generator/README.md) which allows to generate an RDF version from the yaml ontology files. * [Internal Building Representation](./ibr/README.md) (IBR) File Format to represent data from different verticals such as spatial, assets. diff --git a/tools/README.md b/tools/README.md index 8d524159b9..f964df06f3 100644 --- a/tools/README.md +++ b/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](./tools/abel/README.md) generates from/to Google spreadsheet/[Building Configuration](./ontology/docs/building_config.md). + * [Explorer](./tools/explorer/README.md) allows users to explorer the ontology types and their associated fields. + * [Instance Validator](./tools/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](./tools/validators/instance_validator/README.md#telemetry-validation) + corresponding to entity blocks in a building configuration file. + * [Ontology Validator](./tools/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: From 1ee76d12f85bc98b73ff0d7a799e476cf54bd77c Mon Sep 17 00:00:00 2001 From: Travis Date: Thu, 28 Sep 2023 10:32:17 -0700 Subject: [PATCH 2/3] update readme --- tools/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tools/README.md b/tools/README.md index f964df06f3..8d9299c47b 100644 --- a/tools/README.md +++ b/tools/README.md @@ -3,12 +3,12 @@ Various tools have been developed to support the use of the Digital Buildings Ontology and Building Configuration files. The tools are: - * [ABEL](./tools/abel/README.md) generates from/to Google spreadsheet/[Building Configuration](./ontology/docs/building_config.md). - * [Explorer](./tools/explorer/README.md) allows users to explorer the ontology types and their associated fields. - * [Instance Validator](./tools/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](./tools/validators/instance_validator/README.md#telemetry-validation) + * [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](./tools/validators/ontology_validator/README.md) which allows to validate the yaml ontology upon a change or an extension. + * [Ontology Validator](./validators/ontology_validator/README.md) which allows to validate the yaml ontology upon a change or an extension. ## Digital Buildings Toolkit From 91cae843b4cea9295e68a3b5f3076930fe5e0871 Mon Sep 17 00:00:00 2001 From: db-robot Date: Thu, 28 Sep 2023 18:58:18 +0000 Subject: [PATCH 3/3] Add GUIDs to new entity types --- ontology/yaml/resources/HVAC/entity_types/ABSTRACT.yaml | 1 + ontology/yaml/resources/HVAC/entity_types/SDC.yaml | 1 + 2 files changed, 2 insertions(+) diff --git a/ontology/yaml/resources/HVAC/entity_types/ABSTRACT.yaml b/ontology/yaml/resources/HVAC/entity_types/ABSTRACT.yaml index 857c6623d9..0fa0e92e95 100644 --- a/ontology/yaml/resources/HVAC/entity_types/ABSTRACT.yaml +++ b/ontology/yaml/resources/HVAC/entity_types/ABSTRACT.yaml @@ -6794,6 +6794,7 @@ OAQM: - MONITORING UDEC: + guid: "8755e46b-4e3a-40a1-8abb-778bf309c8f8" description: "Up and down extension control for shades." is_abstract: true uses: diff --git a/ontology/yaml/resources/HVAC/entity_types/SDC.yaml b/ontology/yaml/resources/HVAC/entity_types/SDC.yaml index f1af804292..ffd7f5fa68 100644 --- a/ontology/yaml/resources/HVAC/entity_types/SDC.yaml +++ b/ontology/yaml/resources/HVAC/entity_types/SDC.yaml @@ -86,6 +86,7 @@ SDC_EXTOR: - shade_mode SDC_UDEC: + guid: "3d48a34f-f6bf-4ae6-b31c-1e4091458b02" description: "Simple shade with up and down extent control." is_canonical: true implements: