Informatievlaanderen / VSDS-Onboarding-Example

Example on how to publish Linked Data as LDES
4 stars 6 forks source link

Onboarding Example - a Practical Guide to Publishing and Consuming a LDES

This sample project describes step by step how to publish data as LDES and how that linked data can be consumed.

Example Data Set

We start from a continuous feed of data containing the real time occupancy of park & ride locations in Ghent found here. The data is updated every couple of minutes. We will use this data set as an example because it allows us to showcase what LDES is made for: replicating a (historical) data set and synchronize updates on a continuous basis. In addition, the data set also contains geographical information which will allow us to showcase the ability to retrieve a subset of data based on geography in addition to the time axis. Because the dataset grows very rapidly, we will show how to keep storage under control. For simplicity we will start with a simple linked data model and migrate it to an official linked data vocabulary to allow ingesting another data set from the same domain found here in the same LDES.

Prerequisites

To follow along and play with the examples you will need some knowledge of Docker, Docker Compose and git. You will also need an editor such as VSCodium (or VS Code if you really insist). And obviously, you need an open mind and feel like diving into the wonderful world of linked data and RDF.

Bash

In order to run the commands in the tutorials you will to run them in a bash shell. On Windows, you need to use the Windows Subsystem for Linux. This is also needed for Docker (see later). On MacOS, you can use the standard Z shell (zsh) but you may bump into some minor syntactic issues so it is better to use a bash shell. Finally, on Linux, the bash shell is available by default.

Visual Studio Code

You can use any editor or development environment that you like to look at the source files. However, Visual Studio Code and its open source alternative VSCodium offer a few nice features, such as previewing this and other markdown files as well as to manage Docker and Git from within the environent.

Docker

To try the examples yourself, you will also need to install Docker Desktop on your Windows or MacOS. If you have a Linux system, you can either use the desktop or the server version.

Git

To download and use this repository you will need to install Git. After that you can download this repository locally by using the following (in a bash shell):

cd ~
git clone https://github.com/Informatievlaanderen/VSDS-Onboarding-Example.git

Note that the git clone command will create a directory ./VSDS-Onboarding-Example. You need to open that folder in Visual Studio Code to get started.

Where to start?

We suggest you look at the examples in the following order, but of course, feel free to skip parts if you are already familiar with some topics.

Note: before running any of the commands in the tutorials please ensure you are located at that location in your bash shell.

Tutorials for Data Publishers

Tutorials for Data Clients

Tutorials for Data Brokers