JOSS paper (#34)

* Create paper.md

* Create paper.bib

* Create joss.yml

* Ignore paper and other md files

* set paper path

* Add references

* add paper content

* fix citation

* ignore joss workflow

* add name for workflow

* include workflow

* Update paper.md

* remove extra line breaks

* Update joss.yml

* add authors

* improve intro

* improve related work

* update thing directory section

* improve use case

* fixing minor grammatic and clarity problems

* Define things, and move related work to the end

* remove component names

* grammarly fixes

* update title, add tags

* fix related work

* move json-ld to top. Minor fixes

* improve to json-ld reasoning

* break related work into two paragraphs

* remove redundant citation name

* updated the link for discovery survey paper

* move survey sentence to first paragraph

* define TD above

* fix gost article name

* fix syntax

* auto generated w3c references

* fix w3c names

* fix w3c references

* w3c fix string

* w3c url fix

* w3c url fix (2)

Co-authored-by: Shreekantha Devasya <[email protected]>

.github/workflows/go.yml

@@ -1,6 +1,11 @@
 name: CICD
 
-on: [push, pull_request]
+on:
+  push:
+    paths-ignore:
+    - 'paper/**'
+    - '.github/workflows/joss.yml'
+    - '*.md'
 
 jobs:
 

.github/workflows/joss.yml

@@ -0,0 +1,29 @@
+name: JOSS Paper
+
+on:
+  push:
+    paths:
+    - 'paper/joss/**'
+    - '.github/workflows/joss.yml'
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper/joss/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v1
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper/joss/paper.pdf

paper/joss/paper.bib

@@ -0,0 +1,84 @@
+@article{sensorthingsSensing,
+	title        = {OGC SensorThings API Part 1: Sensing, Version 1.0.},
+	author       = {Liang, Steve and Huang, Chih-Yuan and Khalafbeigi, Tania},
+	year         = 2016,
+	publisher    = {Open Geospatial Consortium}
+}
+@article{sensorthingsTasking,
+	title        = {OGC SensorThings API Part 2 – Tasking Core},
+	author       = {Liang, Steve and Khalafbeigi, Tania and Luo, Kan},
+	year         = 2017,
+	publisher    = {Open Geospatial Consortium}
+}
+@inproceedings{neuhaus2009semantic,
+	title        = {The semantic sensor network ontology},
+	author       = {Neuhaus, Holger and Compton, Michael},
+	year         = 2009,
+	booktitle    = {AGILE workshop on challenges in geospatial data harmonisation, Hannover, Germany},
+	pages        = {1--33}
+}
+@misc{frost,
+	title        = {FROST Server},
+	author       = {van der Schaaf and H., Jacoby, M},
+	year         = 2016,
+	journal      = {GitHub repository},
+	publisher    = {GitHub},
+	url          = {https://github.com/FraunhoferIOSB/FROST-Server}
+}
+@misc{gost,
+	title        = {GOST (Go-SensorThings)},
+	author       = {Goedan},
+	year         = 2016,
+	journal      = {GitHub repository},
+	publisher    = {GitHub},
+	url          = {https://github.com/gost/server}
+}
+@misc{Thingweb,
+	title        = {Thingweb-directory},
+	author       = {Thingweb},
+	year         = 2016,
+	journal      = {GitHub repository},
+	publisher    = {GitHub},
+	url          = {https://github.com/thingweb/thingweb-directory}
+}
+@TechReport{WoTTD,
+	title        = "Web of Things (WoT) Thing Description {1.1}",
+	author       = {Kaebisch, S and Kamiya, T and McCool, M and Charpenay, V and Kovatsch, M},
+	year         = 2020,
+	month        = nov,
+	note         = "https://www.w3.org/TR/2020/WD-wot-thing-description11-20201124/",
+	type         = "{W3C} Working Draft",
+	institution  = "W3C",
+	url          = {https://www.w3.org/TR/wot-thing-description/}
+}
+@TechReport{WoTDiscovery,
+	title        = "Web of Things (WoT) Discovery",
+	author       = {Cimmino, A and McCool, M and Tavakolizadeh, F and Toumura, K},
+	year         = 2020,
+	month        = nov,
+	note         = "https://www.w3.org/TR/2020/WD-wot-discovery-20201124/",
+	type         = "{W3C} Working Draft",
+	institution  = "W3C",
+	url          = {https://www.w3.org/TR/wot-discovery/}
+}
+@inpproceedings{WoTStore2019,
+	title        = {WoT Store: Enabling Things and Applications Discovery for the W3C Web of Things},
+	author       = {L. {Sciullo} and C. {Aguzzi} and M. {Di Felice} and T. S. {Cinotti}},
+	year         = 2019,
+	booktitle    = {2019 16th IEEE Annual Consumer Communications  Networking Conference (CCNC)},
+	volume       = {},
+	number       = {},
+	pages        = {1--8},
+	doi          = {10.1109/CCNC.2019.8651786}
+}
+@article{DiscoveryCategorization2016,
+	title        = {{A Categorization of Discovery Technologies for the Internet of Things}},
+	author       = {Br{\"{o}}ring, Arne and Datta, Soumya Kanti and Bonnet, Christian},
+	year         = 2016,
+	journal      = {ACM International Conference Proceeding Series},
+	volume       = {07-09-Nove},
+	pages        = {131--139},
+	url          = {https://www.eurecom.fr/en/publication/5024/download/comsys-publi-5024.pdf},
+	keywords     = {Discovery,Internet of Things},
+	mendeley-groups = {StorageManagement,StorageManagement/Similar works}
+}

paper/joss/paper.md

@@ -0,0 +1,57 @@
+---
+title: 'Thing Directory: Simple and lightweight registry of IoT device metadata'
+tags:
+  - internet of things
+  - web of things
+  - wireless sensor networks
+  - discovery
+  - catalog
+authors:
+  - name: Farshid Tavakolizadeh
+    affiliation: 1
+  - name: Shreekantha Devasya
+    affiliation: 1
+affiliations:
+ - name: Fraunhofer Institute for Applied Information Technology, Sankt Augustin, Germany
+   index: 1
+date: 16 December 2020
+bibliography: paper.bib
+
+---
+
+# Statement of Need  
+<!-- A clear Statement of Need that illustrates the research purpose of the software. -->
+
+The fast emergence of IoT (Internet of Things) technologies has influenced scientific communities to embrace novel sources of information and their potential use in various domains. While the vast amount of sensory data is beneficial, the lack of uniform access interfaces hinders researchers from efficient exploitation. A structured, yet flexible registry is needed to model device metadata and allow exploration and interaction with such devices. In the IoT context, the Things are physical devices (e.g., sensors, actuators, gateways) or virtual ones (e.g., digital twins, proxies, aggregated data sources). An ideal metadata registry for such Things should have a flat learning curve and be easily deployable. This would allow researchers to focus less on interoperability and more on fast prototyping and data application. Registries that are based on established standards are preferred since they can incorporate metadata with many existing Things out-of-the-box. Moreover, the registry software should be lightweight, easily deployable, and free of rigid requirements to support fast prototyping across a wide range of use cases from the edge to the cloud. 
+
+# Thing Directory 
+<!-- A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience. -->
+
+Thing Directory is a searchable registry of metadata for Things. The API is based on W3C 
+Web of Things (WoT) Discovery [@WoTDiscovery], a specification for secure discovery of Things. The registry uses JSON-LD (JSON for Linked Data) encoding by default. The JSON format is human-readable and portable; the linked data support makes the data machine-interpretable. The architecture of the registry is modular with a pluggable storage backend, allowing connection to various database systems using drivers. The current implementation, backed by an embedded LevelDB storage, can be deployed on highly constrained single-board computers such as the Raspberry Pi Zero series. It has very minimal idle processing and memory footprints and can scale on demand to utilize all locally available resources. More powerful storage backends can be added to create a horizontally scalable directory in cloud environments. 
+
+The application is packaged as binary distributions, Debian packages, as well as Docker images for easy deployment on a variety of platforms. The data model of the metadata is based on W3C WoT Thing Description (TD) [@WoTTD] which is extensible by design. Thing Directory validates all inputs using a JSON-Schema, describing the data model. This makes it possible to extend the server’s structured data model and validation mechanism with no programming. The various modules of the system are provided as re-usable Go libraries which can be imported by other applications to build functionalities around Thing Descriptions.
+
+<!-- Mention (if applicable) a representative set of past or ongoing research projects using the software and recent scholarly publications enabled by it. -->
+
+
+## Use case: Assessment of Building Energy Efficiency 
+Construction companies often deal with the challenge of delivering target energy-efficient buildings, given specific budget and time constraints. Energy efficiency, as one of the key factors for renovation investments, depends on the availability of various data sources to support the renovation design and planning. These include climate data and building material along with residential comfort and energy consumption patterns. 
+
+As part of the pre-renovation activities, the construction planners deploy various sensors to collect relevant data over a period. Such sensors become part of a wireless sensor network (WSN) and expose data endpoints with the help of one or more gateways. Depending on the protocols, the endpoints require different interaction flows to securely deliver current and historical measurements. The renovation applications need to discover the sensors, their endpoints, and how to interact with them based on search criteria such as the physical location, mapping to the building model, or measurement type. 
+
+The Thing Directory supports engineers in the assessment of building energy efficiency by providing the means to collect and discover the metadata of deployed sensors in an easy and standardized way. Instances of Thing Directory have been deployed in four renovation sites (two apartments, two buildings) across Europe as registries of wireless sensors which are locally accessible over Z-Wave or WiFi. The API has been integrated into applications for profiling of resident usage of building systems, building information modeling, and process modeling and automation. Such applications query sensor metadata based on zoning and sensor types. Once discovered, the metadata provides these applications with necessary details on how to authenticate and query data. Since the Thing Directory is based on an open standard, being integrated with it adds interoperability with WSNs beyond the scope of this use case. The applications will be able to interact with the growing number of compliant WoT devices.  
+
+# Related Work 
+<!-- A list of key references, including to other software addressing related needs. -->
+
+There are multiple attempts to modeling and discovering the connected Things and their interfaces. OGC SensorThings API [@sensorthingsSensing, @sensorthingsTasking] has been a successful model for the representation of Things. Sensorthings API consists of two parts: sensing and tasking. The popular implementations of the OGC SensorThings are FROST [@frost] and GOST [@gost] which support mainly the sensing part. FROST has preliminary tasking support. These solutions focus on centralized deployments and are not suitable for a federated scenario and gateways with limited computational power. On top of that, the specification which they are based upon, enforces both metadata and observation modeling. That is not practical in IoT scenarios with heterogenous data formats and interfaces. A survey article [@DiscoveryCategorization2016] discusses and categorizes several other technologies related to discovery in the IoT field.
+
+The WoT TD [@WoTTD] covers a wide range of Things by providing the semantics to describe the textual metadata, interaction affordances, data schemas, and relations. Thingweb Directory [@Thingweb] has implemented the discovery of WoT TDs using a proprietary API which does not comply with W3C WoT Discovery [@WoTDiscovery] standard. The Thing Directory complies with both W3C WoT Discovery and W3C WoT TD.
+
+# Acknowledgement 
+<!-- Acknowledgement of any financial support. -->
+
+This work was conducted as part of the BIMERR project, a European Commission’s Horizon 2020 research and innovation program under grant agreement No 820621. The resulting software is released as part of LinkSmart, an open-source IoT prototyping platform.  
+
+# References