Skip to content
Open
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
67771a6
dev-markdown-link-check: add github workflow to check markdown links.…
mayomatsuda Jul 30, 2024
0d5c309
Merge branch 'main' into dev-markdown-link-check
mayomatsuda Jan 15, 2025
460d477
fix markdown links
mayomatsuda Feb 16, 2025
bf282ef
fix markdown links
mayomatsuda Feb 16, 2025
9dc54e0
fix broken links
mayomatsuda Mar 8, 2025
1258f53
merge main
mayomatsuda Mar 8, 2025
66fbdfb
fix readmes
mayomatsuda Apr 3, 2025
7767353
merge main
Apr 3, 2025
1856c43
fix links
Apr 12, 2025
6517fff
Merge branch 'main' into dev-markdown-link-check
Apr 12, 2025
a46e9d9
fix broken links and configure github action
mayomatsuda Apr 12, 2025
8d3f3d7
add on merge for modified files
mayomatsuda Apr 12, 2025
cde5a3f
dev-markdown-link-check: add github workflow to check markdown links.…
mayomatsuda Apr 12, 2025
7f3d05e
fix config
mayomatsuda Apr 12, 2025
0ded825
fix config
mayomatsuda Apr 12, 2025
442b415
Dev markdown link check (#4)
mayomatsuda Apr 12, 2025
39e9a4f
add on merge fix
mayomatsuda Apr 12, 2025
2d3ad19
Dev markdown link check (#5)
mayomatsuda Apr 12, 2025
71689b5
remove on merge
mayomatsuda Apr 12, 2025
3142610
merge
mayomatsuda Apr 12, 2025
cd659bb
finish link fixes
mayomatsuda Apr 13, 2025
a455cef
finish link fixes
mayomatsuda Apr 13, 2025
ef473c8
Dev markdown link check (#7)
mayomatsuda Apr 13, 2025
306ac01
empty commit to test
mayomatsuda Apr 13, 2025
aeebedd
Merge branch 'main' into dev-markdown-link-check
mayomatsuda Apr 13, 2025
a507a1f
Dev markdown link check (#8)
mayomatsuda Apr 13, 2025
70cf930
rename workflow
mayomatsuda Apr 13, 2025
056ccb2
Dev markdown link check (#9)
mayomatsuda Apr 13, 2025
c5bf894
test
mayomatsuda Apr 13, 2025
b66a6c8
Dev markdown link check (#10)
mayomatsuda Apr 13, 2025
5cad977
undo test
mayomatsuda Apr 13, 2025
d60c5da
undo test
mayomatsuda Apr 13, 2025
b0f8192
Dev markdown link check (#11)
mayomatsuda Apr 13, 2025
318b25d
Merge branch 'main' into dev-markdown-link-check
mayomatsuda Apr 13, 2025
d963046
fix links
mayomatsuda Apr 13, 2025
28a7fcb
Dev markdown link check (#12)
mayomatsuda Apr 13, 2025
3412d73
Merge branch 'main' into dev-markdown-link-check
mayomatsuda Apr 13, 2025
fd50a15
fix config
mayomatsuda Apr 13, 2025
45e27a0
Dev markdown link check (#13)
mayomatsuda Apr 13, 2025
960b63c
Merge branch 'main' into dev-markdown-link-check
mayomatsuda Sep 13, 2025
88f0f70
fix links
mayomatsuda Sep 13, 2025
aa7cf32
Merge branch 'main' into dev-markdown-link-check
mayomatsuda Sep 13, 2025
7098006
accept 202
mayomatsuda Sep 13, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/workflows/twa-md-push.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"ignorePatterns": [
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

certain links prevent the workflow from working even though they're fine, e.g. dropbox. I've added such to this list. The workflow is buggy with header references (#) and mailto so ignoring those as well.

and ignoring /user, /explore and /images/defaults because it's part of the website code

{
"pattern": "http://localhost(:\\d+)?(/[^ ]*)?"
},
{
"pattern": "http://HOST:PORT?(/[^ ]*)?"
},
{
"pattern": "https://www.cmegroup.com?(/[^ ]*)?"
},
{
"pattern": "https?://(www\\.)?theworldavatar.com(/[^ ]*)?"
},
{
"pattern": "https://abc.xyz?(/[^ ]*)?"
},
{
"pattern": "https://maven.pkg.github.com/cambridge-cares/TheWorldAvatar/?"
},
{
"pattern": "https?://twitter.com/?"
},
{
"pattern": "https?://www.w3.org/?"
},
{
"pattern": "https?://www.ontology-of-units-of-measure.org/?"
},
{
"pattern": "https?://kg.cmclinnovations.com/mods-agent(/[^ ]*)?"
},
{
"pattern": "https?://github.com/[^/]+/[^/]+/issues(/[^ ]*)?"
},
{
"pattern": "https?://www.dropbox.com/?"
},
{
"pattern": "https?://docs.unity3d.com/?"
},
{
"pattern": "#(/[^ ]*)?"
},
{
"pattern": "/user(/[^ ]*)?"
},
{
"pattern": "/explore(/[^ ]*)?"
},
{
"pattern": "/images/defaults(/[^ ]*)?"
},
{
"pattern": "mailto:(/[^ ]*)?"
}
],
"retryCount": 3,
"aliveStatusCodes": [
200,
403,
503,
0
]
}
26 changes: 26 additions & 0 deletions .github/workflows/twa-md-push.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#
# This workflow contains a job to check for broken links within Markdown files in the repository.
#
name: Check Markdown links

# Trigger this workflow during pushes to the 'main' branch if changes to Markdown files
on:
push:
branches:
- main
paths:
- '**.md'
- '**.MD'

jobs:
# Check for broken links within all Markdown files
markdown-link-check:
name: Check markdown files for broken links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- name: Markdown links check
uses: ruzickap/action-my-markdown-link-checker@v1
with:
config_file: .github/workflows/twa-md-push.json
2 changes: 1 addition & 1 deletion AR/CARESLab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ A complete guide of setting up **new** MRTK3 project can be found at [here](http
Run in Unity is the most easy and convenient way to test during development. Check [here](https://learn.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/mrtk3-input/packages/input/input-simulation#how-to-use-mrtk3-input-simulation-mrtk3-input-simulator-default-controls) for keys to control.

Other resources:
- [Debug C# code in Unity](https://docs.unity3d.com/Manual/ManagedCodeDebugging.html)
- [Debug C# code in Unity](https://docs.unity3d.com/Manual/managed-code-debugging.html)

### Test and Deploy on Device or Emulator

Expand Down
20 changes: 10 additions & 10 deletions Agents/APIAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This `API Agent` can be used to manage the automatic instantiation and updating

The agent is integrated with the [Derived Information Framework]'s (DIF) to ensure proper data provenance. API information and API-Data-to-TimeSeries mappings are defined under a meta-data instance in KG. TS data is then considered as the derived quantity of the meta-data. The required meta-data triples to derive an API-downloaded TS instance are described in the [required derivation markup](#12-required-derivation-markup) section below.

Once a API is registered using the [`DerivationClient`](https://github.com/cambridge-cares/TheWorldAvatar/blob/main/JPS_BASE_LIB/src/main/java/uk/ac/cam/cares/jps/base/derivation), API agent automatically manages a periodical re-downloading of the data from that API.
Once a API is registered using the [`DerivationClient`](https://github.com/TheWorldAvatar/baselib/tree/main/src/main/java/uk/ac/cam/cares/jps/base/derivation), API agent automatically manages a periodical re-downloading of the data from that API.

Ontology definition of API meta-data relies on [Web of Things (WoT) Hypermedia Controls Ontology]. We also extend [RDF Mapping Language (RML)] for TimeSeries data as `rml4ts Ontology`.

Expand Down Expand Up @@ -135,25 +135,25 @@ One may notice the agent, once started, creates a property file named `APIAgent.
<!-- websites -->
[allows you to publish and install packages]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages
[py4jps]: https://pypi.org/project/py4jps/#description
[TimeSeriesClient]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_BASE_LIB/src/main/java/uk/ac/cam/cares/jps/base/timeseries
[TimeSeriesClient]: https://github.com/TheWorldAvatar/baselib/tree/main/src/main/java/uk/ac/cam/cares/jps/base/timeseries
[Darts]: https://unit8co.github.io/darts/index.html
[Prophet]: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.prophet_model.html
[Facebook Prophet]: https://github.com/facebook/prophet
[Github container registry]: https://ghcr.io
[personal access token]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
[Derived Information Framework]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_BASE_LIB/src/main/java/uk/ac/cam/cares/jps/base/derivation
[Stack manager]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager
[derivation agent]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_BASE_LIB/python_derivation_agent
[Derived Information Framework]: https://github.com/TheWorldAvatar/baselib/tree/main/src/main/java/uk/ac/cam/cares/jps/base/derivation
[Stack manager]: https://github.com/TheWorldAvatar/stack/tree/main/stack-manager
[derivation agent]: https://github.com/TheWorldAvatar/baselib/tree/main/python_derivation_agent

[OntoTimeSeries]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_Ontology/ontology/ontotimeseries
[OntoDerivation]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_Ontology/ontology/ontoderivation
[rml4ts.owl]: https://github.com/cambridge-cares/TheWorldAvatar/blob/main/JPS_Ontology/ontology/rml4ts/rml4ts.owl
[OntoTimeSeries]: https://github.com/TheWorldAvatar/ontology/tree/main/ontology/ontotimeseries
[OntoDerivation]: https://github.com/TheWorldAvatar/ontology/tree/main/ontology/ontoderivation
[rml4ts.owl]: https://github.com/TheWorldAvatar/ontology/tree/main/ontology/rml4ts/rml4ts.owl
<!-- files -->
[docker compose file]: ./docker-compose.yml
[Web of Things (WoT) Hypermedia Controls Ontology]:https://www.w3.org/2019/wot/hypermedia
[RDF Mapping Language (RML)]:https://rml.io/specs/rml/
[test_triples]: ./test_triples

[api_temperature.ttl]: ./tbox_dev/test_triples/api_temperature.ttl
[api_temperature.ttl]: ./test_triples/api_temperature.ttl
[calculations module]: ./data_classes/calculations.py
[api_pvcapacity.ttl]: ./tbox_dev/test_triples/api_pvcapacity.ttl
[api_pvcapacity.ttl]: ./test_triples/api_pvcapacity.ttl
2 changes: 1 addition & 1 deletion Agents/AQMeshInputAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This agent is for maintaining data and the corresponding instances in the knowledge graph (KG) regarding the AQMesh air
quality measuring station. It's only purpose is to retrieve new data (if available) from the API and download it into
the corresponding database, as well as, instantiating KG instances and connection when called for the first time. The
agent uses the [time-series client](https://github.com/cambridge-cares/TheWorldAvatar/tree/develop/JPS_BASE_LIB/src/main/java/uk/ac/cam/cares/jps/base/timeseries)
agent uses the [time-series client](https://github.com/TheWorldAvatar/baselib/tree/main/src/main/java/uk/ac/cam/cares/jps/base/timeseries)
from the JPS base lib to interact with both the KG and database.

Before explaining the usage of the agent, we will briefly summarize the AQMesh API that is
Expand Down
4 changes: 2 additions & 2 deletions Agents/AccessAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ If building a new version of the image, the new image should be pushed to the Gi
docker push ghcr.io/cambridge-cares/access-agent:X.Y.Z
```

where X.Y.Z is the new version number. Please also ensure that you are logged in to the docker registry. Follow [step 1 of this](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager#spinning-up-a-stack) for clarity.
where X.Y.Z is the new version number. Please also ensure that you are logged in to the docker registry. Follow [step 1 of this](https://github.com/TheWorldAvatar/stack/tree/main/stack-manager#spinning-up-a-stack) for clarity.

#### Integration tests

Expand All @@ -54,7 +54,7 @@ This will test the agent in a production environment including connections to th

## 2. Deployment Instructions

The Access Agent can be deployed in a standalone Docker container or as part of The World Avatar [stack](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager).
The Access Agent can be deployed in a standalone Docker container or as part of The World Avatar [stack](https://github.com/TheWorldAvatar/stack/tree/main/stack-manager).

### 2.1 Standalone Container

Expand Down
12 changes: 6 additions & 6 deletions Agents/AirQualityAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,20 +153,20 @@ Markus Hofmeister (mh807@cam.ac.uk), March 2023
<!-- Links -->
[allows you to publish and install packages]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages
[CMCL Docker registry]: https://github.com/cambridge-cares/TheWorldAvatar/wiki/Docker%3A-Image-registry
[Common stack scripts]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/common-scripts
[Common stack scripts]: https://github.com/TheWorldAvatar/stack/tree/main/common-scripts
[Create SSH key]: https://docs.digitalocean.com/products/droplets/how-to/add-ssh-keys/create-with-openssh/
[Github container registry]: https://ghcr.io
[Github package repository]: https://github.com/cambridge-cares/TheWorldAvatar/wiki/Packages
[http://localhost:5002/airqualityagent]: http://localhost:5002/airqualityagent
[Java Development Kit version >=11]: https://adoptium.net/en-GB/temurin/releases/?version=11
[JDBC driver]: https://jdbc.postgresql.org/download/
[JPS_BASE_LIB]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_BASE_LIB
[OntoEMS]: https://raw.githubusercontent.com/cambridge-cares/TheWorldAvatar/main/JPS_Ontology/ontology/ontoems/OntoEMS.owl
[JPS_BASE_LIB]: https://github.com/TheWorldAvatar/baselib/tree/main
[OntoEMS]: https://raw.githubusercontent.com/TheWorldAvatar/ontology/refs/heads/main/ontology/ontoems/OntoEMS.owl
[personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[py4jps]: https://pypi.org/project/py4jps/#description
[Stack Manager]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager
[spin up the stack]: https://github.com/cambridge-cares/TheWorldAvatar/blob/main/Deploy/stacks/dynamic/stack-manager/README.md
[Stack-Clients]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-clients
[Stack Manager]: https://github.com/TheWorldAvatar/stack/tree/main/stack-manager
[spin up the stack]: https://github.com/TheWorldAvatar/stack/tree/main/stack-manager/README.md
[Stack-Clients]: https://github.com/TheWorldAvatar/stack/tree/main/stack-clients
[Upload SSH key]: https://docs.digitalocean.com/products/droplets/how-to/add-ssh-keys/to-existing-droplet/
[VSCode via SSH]: https://code.visualstudio.com/docs/remote/ssh
[TheWorldAvatar]: https://github.com/cambridge-cares/TheWorldAvatar
Expand Down
8 changes: 4 additions & 4 deletions Agents/AndroidStatusAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Because DTVF can only send request instead of taking in any, logging the status
<img src="./resources/usecase_assist_visualisation.png" width="60%" HEIGHT="60%" alt="AndroidStatusAgent in visualisation use case">

# 1. Setup
This agent is designed to run in stack, which is spun up by [Stack Manager](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager).
This agent is designed to run in stack, which is spun up by [Stack Manager](https://github.com/TheWorldAvatar/stack/tree/main/stack-manager).
A successful setup will result in 9 containers:
- 8 [default containers](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager#spinning-up-a-stack)
- 8 [default containers](https://github.com/TheWorldAvatar/stack/tree/main/stack-manager#spinning-up-a-stack)
- AndroidStatusAgent

## 1.1 Config BMSQueryAgent in Stack
Expand Down Expand Up @@ -58,10 +58,10 @@ config/
|_ <STACK NAME>.json
```

More information about adding custom containers to the stack can be found [here](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager#adding-custom-containers).
More information about adding custom containers to the stack can be found [here](https://github.com/TheWorldAvatar/stack/tree/main/stack-manager#adding-custom-containers).

## 1.2 Spin Up Stack
Follow these [steps](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager#spinning-up-a-stack) to spin up the stack.
Follow these [steps](https://github.com/TheWorldAvatar/stack/tree/main/stack-manager#spinning-up-a-stack) to spin up the stack.

# 2. Usage
This agent support both POST and GET requests.
Expand Down
4 changes: 2 additions & 2 deletions Agents/AssetManagerAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The agent also handles the instantiation of purchase documents such as purchase
Currently the agent is designed specifically to handle assets of CARES. The agent is designed to handle assets on 2 different locations, CARES office and the Research Wing.
Hence the agent relies on inputting the information regarding locations into 2 namespaces: the `lab` and `office` namespace in the knowledge graph. Assets on other locations are put into the `office` namespace as default, where their location will only be recorded as a literal.

As this agent is designed to work together with the asset management app, the app requires a check whether the asset has some sort of timeseries attached to its concept when retrieved (for example, a fumehood’s air consumption). This timeseries is commonly contained in the `bms` namespace and will be used as default for this search, since currently the agent is designed specifically to handle assets of CARES. The details of this timeseries search on retrieve can be read further at [/retrieve](#--retrieve).
As this agent is designed to work together with the asset management app, the app requires a check whether the asset has some sort of timeseries attached to its concept when retrieved (for example, a fumehood’s air consumption). This timeseries is commonly contained in the `bms` namespace and will be used as default for this search, since currently the agent is designed specifically to handle assets of CARES. The details of this timeseries search on retrieve can be read further at [/retrieve](#retrieval).



Expand Down Expand Up @@ -67,7 +67,7 @@ Update the following files in the `./config` folder:

- `/ontologyMap.properties`: A map of the asset type and their IRIs. Refer to the available values in [AssetClass](#instantiation)

- `/tsSearch.properties`: Parameters of asset timeseries data search on retrieve. The details of this timeseries search on retrieve can be read further at [/retrieve](#--retrieve).
- `/tsSearch.properties`: Parameters of asset timeseries data search on retrieve. The details of this timeseries search on retrieve can be read further at [/retrieve](#retrieval).
- `depth`: Search depth for looking for asset timeseries existence
- `predicate`: Triple's predicate used to detect if an asset have a timeseries or not. An array of IRI (please use the full IRI, don't use prefixes) separated by a comma (`,`).

Expand Down
14 changes: 7 additions & 7 deletions Agents/AverageSquareMetrePriceAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,16 +251,16 @@ Markus Hofmeister (mh807@cam.ac.uk), March 2023

<!-- TWA github -->
[CMCL Docker registry wiki page]: https://github.com/cambridge-cares/TheWorldAvatar/wiki/Docker%3A-Image-registry
[Common stack scripts]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/common-scripts
[Derivation Agent]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_BASE_LIB/python_derivation_agent
[Derivation Agent configuration]: https://github.com/cambridge-cares/TheWorldAvatar/blob/main/JPS_BASE_LIB/python_derivation_agent/pyderivationagent/conf/agent_conf.py
[Common stack scripts]: https://github.com/TheWorldAvatar/stack/tree/main/common-scripts
[Derivation Agent]: https://github.com/TheWorldAvatar/baselib/tree/main/python_derivation_agent
[Derivation Agent configuration]: https://github.com/TheWorldAvatar/baselib/tree/main/python_derivation_agent/pyderivationagent/conf/agent_conf.py
[EPC Agent]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Agents/EnergyPerformanceCertificateAgent
[JPS_BASE_LIB]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_BASE_LIB
[JPS_BASE_LIB]: https://github.com/TheWorldAvatar/baselib/tree/main
[OntoBuiltEnv]: http://www.theworldavatar.com/ontology/ontobuiltenv/OntoBuiltEnv.owl
[HM Property Sales Agent]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Agents/HMLandRegistryAgent
[spin up the stack]: https://github.com/cambridge-cares/TheWorldAvatar/blob/main/Deploy/stacks/dynamic/stack-manager/README.md#spinning-up-a-stack
[Stack Manager]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-manager
[Stack-Clients]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Deploy/stacks/dynamic/stack-clients
[spin up the stack]: https://github.com/TheWorldAvatar/stack/tree/main/stack-manager/README.md#spinning-up-a-stack
[Stack Manager]: https://github.com/TheWorldAvatar/stack/tree/main/stack-manager
[Stack-Clients]: https://github.com/TheWorldAvatar/stack/tree/main/stack-clients
[The World Avatar]: https://github.com/cambridge-cares/TheWorldAvatar

<!-- data sources -->
Expand Down
2 changes: 1 addition & 1 deletion Agents/BMSBacnetAgent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This agent automatically runs the update job periodically once deployed and does

[config file]: ./config/config.py

[TimeSeriesClient]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_BASE_LIB/src/main/java/uk/ac/cam/cares/jps/base/timeseries
[TimeSeriesClient]: https://github.com/TheWorldAvatar/baselib/tree/main/src/main/java/uk/ac/cam/cares/jps/base/timeseries

[BMSQueryAgent]: https://github.com/cambridge-cares/TheWorldAvatar/tree/main/Agents/BMSQueryAgent

Expand Down
4 changes: 2 additions & 2 deletions Agents/BMSInstantiationAgent/README.MD
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# BMS Instantiation Agent

This agent is designed to instantiate devices found in Building Management System (BMS) based on [OntoDevice](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_Ontology/ontology/ontodevice), [OntoBMS](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_Ontology/ontology/ontobms) and [OntoCAPE](https://github.com/cambridge-cares/TheWorldAvatar/tree/main/JPS_Ontology/ontology/ontocape).
This agent is designed to instantiate devices found in Building Management System (BMS) based on [OntoDevice](https://github.com/TheWorldAvatar/ontology/tree/main/ontology/ontodevice), [OntoBMS](https://github.com/TheWorldAvatar/ontology/tree/main/ontology/ontobms) and [OntoCAPE](https://github.com/TheWorldAvatar/ontology/tree/main/ontology/ontocape).

The agent mainly uses the [remote store client](https://github.com/cambridge-cares/TheWorldAvatar/blob/main/JPS_BASE_LIB/src/main/java/uk/ac/cam/cares/jps/base/query/RemoteStoreClient.java) from the JPS_BASE_LIB to interact with the knowledge graph.
The agent mainly uses the [remote store client](https://github.com/TheWorldAvatar/baselib/tree/main/src/main/java/uk/ac/cam/cares/jps/base/query/RemoteStoreClient.java) from the JPS_BASE_LIB to interact with the knowledge graph.

## Usage
This part of the README describes the usage of the agent. The module itself can be packaged into an executable war, deployed as a web servlet on tomcat. Sending the appropriate request to the correct URL will initiate the agent. Since it uses the remote store client to interact with the knowledge graph , the knowledge graph will be required to be set-up beforehand.
Expand Down
Loading