Merge pull request #879 from cambridge-cares/dev-rename-dtvf

dev-rename-dtvf

Author: mdhillman

.github/scripts/dtvf/make-release-body.sh

@@ -1,22 +1,22 @@
 #!/bin/bash
 
-# This script checks that the version of the Digital Twin Visualisation Framework
-# (DTVF) is as expected, the example visualisations have been updated to use that
+# This script checks that the version of the TWA Visualisation Framework (TWA-VF
+# is as expected, the example visualisations have been updated to use that
 # version, and that the CHANGELOG has been updated acorrdingly.
 #
-# Author: Michael Hillman (mdhillman<@>cmclinnovations.com)
+# Author: Michael Hillman (mdhillman<@>cmcl.io)
 
 
 # Read (what should be) the correct version
-VERSION=`cat -s "./web/digital-twin-vis-framework/library/VERSION" 2>/dev/null`
+VERSION=`cat -s "./web/twa-vis-framework/library/VERSION" 2>/dev/null`
 if [ "$VERSION" == "" ]; then
-	echo "The VERSION file of the DTVF has no content!"
+	echo "The VERSION file of the TWA-VF has no content!"
 	exit -1
 fi
-echo "DTVF defined in file as: $VERSION"
+echo "TWA-VF defined in file as: $VERSION"
 
 # Get the VERSION file from the main branch of the repo, check that this new version does not match
-MAIN_VERSION=$(curl -s "https://raw.githubusercontent.com/cambridge-cares/TheWorldAvatar/main/web/digital-twin-vis-framework/library/VERSION")
+MAIN_VERSION=$(curl -s "https://raw.githubusercontent.com/cambridge-cares/TheWorldAvatar/main/web/twa-vis-framework/library/VERSION")
 if [ "$VERSION" == "$MAIN_VERSION" ]; then
 	echo "Contents of VERSION file on this branch match that on the main branch!"
 	exit -1
@@ -32,7 +32,7 @@ fi
 echo "Version does not contain -SNAPSHOT qualifier."
 
 # Check that the change log contains an entry for that version
-CHANGELOG="./web/digital-twin-vis-framework/CHANGELOG.md"
+CHANGELOG="./web/twa-vis-framework/CHANGELOG.md"
 TOKEN="# $VERSION"
 if ! grep -q "$TOKEN" "$CHANGELOG"; then
 	echo "Could not find corresponding node in CHANGELOG.md file!"

.github/scripts/dtvf/check-version.sh .github/scripts/twa-vf/check-version.sh.github/scripts/dtvf/check-version.sh renamed to .github/scripts/twa-vf/check-version.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+# This script generates the body text for releases of the
+# TWA Visualisation Framework (TWA-VF).
+#
+# Author: Michael Hillman (mdhillman<@>cmcl.io)
+
+CHANGELOG="./web/twa-vis-framework/CHANGELOG.md"
+regexp="^#\s.*"
+SECTION=0
+
+BODY="This release package marks a release of the TWA Visualisation Framework (TWA-VF), a framework for customisable visualisations using The World Avatar project. Release notes for this version of the TWA-VF can be found below, for more details, see the \`CHANGELOG.md\` and \`README.md\` files within the \`/web/twa-vis-framework/\` directory.\n\n"
+
+# Read changelog line by line
+# Only store notes within the first header
+while IFS= read -r line
+do
+  if [[ $line =~ $regexp ]]; then
+	SECTION=$((SECTION + 1))
+  fi
+  
+  if [[ $SECTION == 1 ]]; then
+    BODY="$BODY\n$line"
+  fi
+  
+done < "$CHANGELOG"
+		  
+# Output final notes
+echo -e "$BODY"

.github/scripts/twa-vf/make-release-body.sh

@@ -1,25 +1,25 @@
 #!/bin/bash
 
 # This script generates the HTML text for the email notification
-# generated with a new version of the Digital Twin Visualisation Framework
-# (DTVF) is released.
+# generated with a new version of the TWA Visualisation Framework
+# (TWA-VF) is released.
 #
 # Note that this script also expects Python to have been installed and setup
 # to run the markdown2html.py script within thie directory.
 #
-# Author: Michael Hillman (mdhillman<@>cmclinnovations.com)
+# Author: Michael Hillman (mdhillman<@>cmcl.io)
 
 import os
 import markdown
 
 # Read version from file
-with open('./web/digital-twin-vis-framework/library/VERSION', 'r') as f:
+with open('./web/twa-vis-framework/library/VERSION', 'r') as f:
     version = f.read()
 print("Have read version file.")
 
 # Read the top most section of the patch notes
 notes = ""
-with open('./web/digital-twin-vis-framework/CHANGELOG.md', 'r') as f:
+with open('./web/twa-vis-framework/CHANGELOG.md', 'r') as f:
     lines = f.readlines()
     section = 0
 
@@ -39,7 +39,7 @@
 print("Have converted change log to HTML.")
 
 # Read template email file
-with open('./web/digital-twin-vis-framework/library/release.html', 'r') as f:
+with open('./web/twa-vis-framework/library/release.html', 'r') as f:
     template = f.read()
 print("Have read template email file.")
 

…ithub/scripts/dtvf/make-release-email.py …hub/scripts/twa-vf/make-release-email.py.github/scripts/dtvf/make-release-email.py renamed to .github/scripts/twa-vf/make-release-email.py .github/scripts/dtvf/make-release-email.py renamed to .github/scripts/twa-vf/make-release-email.py

@@ -1,19 +1,19 @@
 #
-# Checks that the version of the DTVF has been updated.
+# Checks that the version of the TWA-VF has been updated.
 #
-# Author: Michael Hillman (mdhillman<@>cmclinnovations.com)
+# Author: Michael Hillman (mdhillman<@>cmcl.io)
 #
-name: Check DTVF Version
+name: Check TWA-VF Version
 
 
 # Trigger this workflow during pull requests to the 'main' branch,
-# but ONLY when files within the DTVF source code are changed.
+# but ONLY when files within the TWA-VF source code are changed.
 on:
   pull_request:
     branches:
       - main
     paths:
-      - web/digital-twin-vis-framework/library/**
+      - web/twa-vis-framework/library/**
 
 
 # Job definitions
@@ -34,6 +34,6 @@ jobs:
       - name: Run version check script
         working-directory: ./
         run: |
-          chmod +x ./.github/scripts/dtvf/check-version.sh
-          ./.github/scripts/dtvf/check-version.sh
+          chmod +x ./.github/scripts/twa-vf/check-version.sh
+          ./.github/scripts/twa-vf/check-version.sh
   

.github/workflows/dtvf_check-version.yml

@@ -1,20 +1,20 @@
 #
 # Runs actions related to a new release (i.e. merged PR to main) of the
-# Digital Twin Visualisation Framework (DTVF).
+# TWA Visualisation Framework (TWA-VF).
 #
-# Author: Michael Hillman (mdhillman<@>cmclinnovations.com)
+# Author: Michael Hillman (mdhillman<@>cmcl.io)
 #
-name: Release the DTVF
+name: Release the TWA-VF
 
 
 # Trigger this workflow during pushes to the 'main' branch, and
-# ONLY when files within the DTVF source code are changed.
+# ONLY when files within the TWA-VF source code are changed.
 on:
   push:
     branches:
       - main
     paths:
-      - 'web/digital-twin-vis-framework/library/**'
+      - 'web/twa-vis-framework/library/**'
 
 
 # Job definitions
@@ -33,20 +33,20 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
 
-      # Get the version of the DTVF
-      - name: Get DTVF version
+      # Get the version of the TWA-VF
+      - name: Get TWA-VF version
         id: versioner
         run: |
-          echo version=$(cat web/digital-twin-vis-framework/library/VERSION) >> $GITHUB_ENV
+          echo version=$(cat web/twa-vis-framework/library/VERSION) >> $GITHUB_ENV
           
-      # Compile the DTVF and ZIP results
-      - name: Compile the DTVF
+      # Compile the TWA-VF and ZIP results
+      - name: Compile the TWA-VF
         id: compiler
-        working-directory: ./web/digital-twin-vis-framework/library
+        working-directory: ./web/twa-vis-framework/library
         run: |
           docker-compose -f docker-compose.dev.yml up compile
-          zip -r $HOME/dtvf.zip output/
-          echo zip=$HOME/dtvf.zip >> $GITHUB_ENV
+          zip -r $HOME/twa-vf.zip output/
+          echo zip=$HOME/twa-vf.zip >> $GITHUB_ENV
           
       # Login to Docker image registry
       - name: Login to Docker registry
@@ -61,26 +61,26 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           push: true
-          context: ./web/digital-twin-vis-framework/library
+          context: ./web/twa-vis-framework/library
           tags: |
-            ghcr.io/cambridge-cares/dtvf-base-image:${{ env.version }}
-            ghcr.io/cambridge-cares/dtvf-base-image:latest
+            ghcr.io/cambridge-cares/twa-vf:${{ env.version }}
+            ghcr.io/cambridge-cares/twa-vf:latest
          
       # Generate the release body text
       - name: Generate release text
         id: generate-text
         working-directory: ./
         run: |
-          chmod +x ./.github/scripts/dtvf/make-release-body.sh
-          ./.github/scripts/dtvf/make-release-body.sh > $HOME/body.md
+          chmod +x ./.github/scripts/twa-vf/make-release-body.sh
+          ./.github/scripts/twa-vf/make-release-body.sh > $HOME/body.md
           echo body=$HOME/body.md >> $GITHUB_ENV
           
       # Make a release on the main branch
       - name: Make release
         uses: ncipollo/release-action@v1
         with:
-          name: "dtvf-${{ env.version }}"
-          tag: "dtvf-${{ env.version }}"
+          name: "twa-vf-${{ env.version }}"
+          tag: "twa-vf-${{ env.version }}"
           commit: "main"
           bodyFile: "${{ env.body }}"
           artifacts: "${{ env.zip }}"
@@ -97,7 +97,7 @@ jobs:
         working-directory: ./
         run: |
           pip install markdown
-          python ./.github/scripts/dtvf/make-release-email.py
+          python ./.github/scripts/twa-vf/make-release-email.py
           echo email=$HOME/email.html >> $GITHUB_ENV
       
       # Send a notification email
@@ -109,7 +109,7 @@ jobs:
           secure: true
           username: ${{secrets.CMCL_MAIL_USERNAME}}
           password: ${{secrets.CMCL_MAIL_PASSWORD}}
-          subject: "New TWA release: DTVF ${{ env.version }}"
+          subject: "New TWA release: TWA-VF ${{ env.version }}"
           to: cares-twa@lists.cam.ac.uk,all@cmcl.io
           from: Automated TWA action
           html_body: "file://${{ env.email }}"

.github/workflows/dtvf_release.yml

@@ -45,5 +45,5 @@ Afterwards the visualisation can be viewed via Docker Desktop. For more informat
 
 [properties file]: resources/properties.properties
 [CitiesKG Agents]: https://github.com/cambridge-cares/CitiesKG/tree/develop/agents
-[DTVF]: https://github.com/cambridge-cares/TheWorldAvatar/wiki/Digital-Twin-Visualisations
+[DTVF]: https://github.com/cambridge-cares/TheWorldAvatar/wiki/TWA-Visualisations
 [Minimum Working Example]: https://github.com/cambridge-cares/TheWorldAvatar/tree/develop/Agents/TimeSeriesExample

Agents/CReDoPhase1BuildingsAgent/README.md

@@ -3,7 +3,7 @@
 ## Purpose
 This example visualisation has been put together to demonstrate the intended use of the centralised Digital Twin Visualisation Framework (DTVF). This framework has been designed to make it easier for users not experienced with Javascript (or the mapping libraries) to quickly & easily put together a new Digital Twin visualisation. It is intended for developers to use this example visualisation to gain an understanding of the DTVF before attempting to create their own visualisation; to do that, this example can be copied and used as a starting point.
 
-This centralised framework expects users to have structured their data in a particular format, and provide a number of associated metadata files. Before starting, ensure your data meets this format by reading the ["Visualisation Framework"](https://github.com/cambridge-cares/TheWorldAvatar/wiki/Digital-Twin-Visualisations) page on the GitHub wiki. This page also details how the framework functions, and how to configure your visualisation to use it.
+This centralised framework expects users to have structured their data in a particular format, and provide a number of associated metadata files. Before starting, ensure your data meets this format by reading the ["Visualisation Framework"](https://github.com/cambridge-cares/TheWorldAvatar/wiki/TWA-Visualisations) page on the GitHub wiki. This page also details how the framework functions, and how to configure your visualisation to use it.
 
 ## Building the Image
 The `docker` folder contains the required files to build a Docker Image for the example visualisation; the `Dockerfile` file contains the instructions to build an Image; before making any changes to it, please consult the application's developer or the system administrators at CMCL (Michael Hillman <mdhillman@cmclinnovations.com>).

Agents/CReDoPhase1BuildingsAgent/dtvf_visualisation_bha_data/README.md

@@ -3,7 +3,7 @@
 ## Purpose
 This example visualisation has been put together to demonstrate the intended use of the centralised Digital Twin Visualisation Framework (DTVF). This framework has been designed to make it easier for users not experienced with Javascript (or the mapping libraries) to quickly & easily put together a new Digital Twin visualisation. It is intended for developers to use this example visualisation to gain an understanding of the DTVF before attempting to create their own visualisation; to do that, this example can be copied and used as a starting point.
 
-This centralised framework expects users to have structured their data in a particular format, and provide a number of associated metadata files. Before starting, ensure your data meets this format by reading the ["Visualisation Framework"](https://github.com/cambridge-cares/TheWorldAvatar/wiki/Digital-Twin-Visualisations) page on the GitHub wiki. This page also details how the framework functions, and how to configure your visualisation to use it.
+This centralised framework expects users to have structured their data in a particular format, and provide a number of associated metadata files. Before starting, ensure your data meets this format by reading the ["Visualisation Framework"](https://github.com/cambridge-cares/TheWorldAvatar/wiki/TWA-Visualisations) page on the GitHub wiki. This page also details how the framework functions, and how to configure your visualisation to use it.
 
 ## Building the Image
 The `docker` folder contains the required files to build a Docker Image for the example visualisation; the `Dockerfile` file contains the instructions to build an Image; before making any changes to it, please consult the application's developer or the system administrators at CMCL (Michael Hillman <mdhillman@cmclinnovations.com>).

Agents/CReDoPhase1BuildingsAgent/dtvf_visualisation_open_data/README.md

@@ -1,6 +1,6 @@
 # Feature Info Agent
 
-This Feature Info Agent (FIA) acts as a single access point for [DTVF Visualisations](https://github.com/cambridge-cares/TheWorldAvatar/wiki/Digital-Twin-Visualisations) to query for both meta and time series data of an individual feature (i.e. a single geographical location) before display within the side panel of the visualisation.
+This Feature Info Agent (FIA) acts as a single access point for [TWA Visualisations](https://github.com/cambridge-cares/TheWorldAvatar/wiki/TWA-Visualisations) to query for both meta and time series data of an individual feature (i.e. a single geographical location) before display within the side panel of the visualisation.
 
 The current version of the FIA is v2.0.1.
 
@@ -25,7 +25,7 @@ The FIA is a relatively simple HTTP agent built using the JPS Base Lib's agent f
       3. Look up corresponding meta query for that class.
          1. If none found, send a NO_CONTENT response.
       4. Run query to get metadata.
-      5. Parse resulting metadata into approved DTVF format.
+      5. Parse resulting metadata into approved TWA-VF format.
       6. Look up corresponding timeseries query for that class.
          1. If none found, log warning but continue.
          2. If found, run query.
@@ -93,7 +93,7 @@ select distinct ?class {
 
 To properly parse the metadata and timeseries queries, the agent requires the results from queries to fulfil a set format. For each type of query a number of placeholder tokens can be added that will be populated by the agent just before execution. These are:
 
-- `[IRI]`: The IRI of the **feature** of interest, i.e. the feature selected within the DTVF (the IRI will be injected here into the request)
+- `[IRI]`: The IRI of the **feature** of interest, i.e. the feature selected within the TWA-VF (the IRI will be injected here into the request)
 - `[ONTOP]`: The URL of the Ontop service within the stack will be injected
 
 <ins>Queries for metadata</ins> should not concern themselves with data relating to timeseries (that can be handled within the timeseries query). Queries here need to return a table with two (or optionally three) columns. The first column should be named `Property` and contains the name of the parameter we're reporting, the second should be `Value` and contain the value. The optional third column is `Unit`. **These are case sensitive and any other columns will be ignored**.