文件列表:

.editorconfig (318, 2023-09-29)
.env.example (1714, 2023-09-29)
.pre-commit-config.yaml (94, 2023-09-29)
.reuse/ (0, 2023-09-29)
.reuse/dep5 (973, 2023-09-29)
LICENSE (34523, 2023-09-29)
LICENSES/ (0, 2023-09-29)
LICENSES/AGPL-3.0-or-later.txt (34020, 2023-09-29)
LICENSES/CC0-1.0.txt (7048, 2023-09-29)
LICENSES/MIT.txt (1078, 2023-09-29)
diagrams/ (0, 2023-09-29)
diagrams/odh-event.graphml (26385, 2023-09-29)
diagrams/odh-event.svg (28907, 2023-09-29)
diagrams/odh-food-establishment.graphml (18356, 2023-09-29)
diagrams/odh-food-establishment.png (46399, 2023-09-29)
diagrams/odh-food-establishment.svg (30330, 2023-09-29)
diagrams/odh-lodging-business.png (94940, 2023-09-29)
diagrams/odh-lodging-business.svg (64526, 2023-09-29)
diagrams/odh-lodgingBusiness and accommodation.graphml (43073, 2023-09-29)
diagrams/odh-mobility-old.graphml (87021, 2023-09-29)
diagrams/odh-sensors.graphml (53073, 2023-09-29)
diagrams/odh-sensors.png (106082, 2023-09-29)
diagrams/odh-sensors.svg (70504, 2023-09-29)
docker-compose.auth.yml (5330, 2023-09-29)
docker-compose.mobility.yml (1332, 2023-09-29)
docker-compose.public.yml (4152, 2023-09-29)
docker-compose.yml (4177, 2023-09-29)
docs/ (0, 2023-09-29)
docs/authentication.md (7124, 2023-09-29)
docs/images/ (0, 2023-09-29)
docs/images/client-configuration.png (144748, 2023-09-29)
docs/images/client-mapper-configuration.png (50184, 2023-09-29)
... ...

# odh-vkg Virtual Knowledge Graph (VKG) over the Open Data Hub (ODH) powered by [Ontop](https://ontop-vkg.org) and curated by [Ontopic](https://ontopic.ai). [](https://github.com/noi-techpark/odh-docs/wiki/REUSE#badges) [](https://github.com/noi-techpark/it.bz.opendatahub.sparql/actions/workflows/main.yml) **Table of contents** - [odh-vkg](#odh-vkg) - [Getting started](#getting-started) - [Prerequisites](#prerequisites) - [Source code](#source-code) - [Local deployment](#local-deployment) - [Docker environment](#docker-environment) - [Installation](#installation) - [Start and stop the containers](#start-and-stop-the-containers) - [Option 1: On the foreground](#option-1-on-the-foreground) - [Option 2: On the background](#option-2-on-the-background) - [Authentication](#authentication) - [Deployment at NOI](#deployment-at-noi) - [Database synchronization](#database-synchronization) - [Endpoints](#endpoints) - [Maintenance](#maintenance) - [Schema evolution](#schema-evolution) - [Test database images](#test-database-images) - [Information](#information) - [Support](#support) - [Contributing](#contributing) - [Documentation](#documentation) - [License](#license) - [Examples of SPARQL queries](#examples-of-sparql-queries) - [Schema](#schema) ## Getting started These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. ### Prerequisites For a ready to use Docker environment with all prerequisites already installed and prepared, you can check out the [Docker environment](#docker-environment) section. ### Source code Get a copy of the repository: ```bash git clone https://github.com/noi-techpark/odh-vkg.git ``` Change directory: ```bash cd odh-vkg/ ``` ### Local deployment 1. Create the `.env` file in which, amongst all, the SPARQL endpoint port and the PG external port (for debugging purposes) are specified * `cp .env.example .env` 3. Start the Docker container (see [the dedicated section](#Start-and-stop-the-containers)) 4. Visit the SPARQL endpoint * Now we can open the link in the browser and test some SPARQL queries * Note that synchronisation between the master and the slave takes some time. Until it is finished, some queries may return empty results. #### Docker environment For the project a Docker environment is already prepared and ready to use with all necessary prerequisites. The default Docker Compose file *(docker-compose.yml)* uses 3 containers: - A PostgreSQL DB containing a fragment of the ODH Tourism dataset - Ontop as SPARQL endpoint - Nginx as reverse proxy and cache #### Installation Install [Docker](https://docs.docker.com/install/) (with Docker Compose) locally on your machine. #### Start and stop the containers ##### Option 1: On the foreground To start the container on the foreground: ``` docker-compose pull && docker-compose up --build ``` The container is run on the foreground and can be stopped by pressing CTRL-C. ##### Option 2: On the background To start the container on the background: ``` docker-compose pull && docker-compose up --build -d ``` To stop it: ``` docker-compose down ``` #### Authentication A second Docker-compose file (`docker-compose.auth.yml`) can be used for testing access control policies. It requires a running and configurable instance of Keycloak. See https://github.com/noi-techpark/authentication-server for instructions on how to install it locally. Refer to [docs/authentication.md](docs/authentication.md) for instruction on how to configure Keycloak and the authentication proxy. ## Deployment at NOI All NOI specific infrastructure documentation and scripts can be found inside the `infrastructure` folder. See [infrastructure/README.md](infrastructure/README.md) for details. #### Database synchronization The SPARQL endpoints do not query directly the production database but slave read-only instances, which are synchronized with the master database through two sync-script with scheduled regular executions. The `mobility` sync can be found under [infrastructure/utils/mobility-sync/](infrastructure/utils/mobility-sync/), whereas the `tourism` sync is an external program handled directly from the Tourism servers. ## Endpoints - Landing page: `/` - Public SPARQL endpoint: `/sparql` - Public portal: `/portal/` - Public predefined queries: `/predefined/` - Portal with restricted access: `/restricted/` - SPARQL endpoint with restricted access: `/restricted/sparql` - Predefined queries with restricted access: `/restricted/predefined/` ## Maintenance ### Schema evolution [See the dedicated page](docs/schema-evolution.md) ### Test database images For building a newer version of the Docker image of the test database out of a fresh dump, please refer to [Tourism master](docs/test-tourism-master.md). This Docker image is published [on Docker Hub](https://hub.docker.com/r/ontopicvkg/odh-tourism-db). ## Information ### Support For support, please contact [help@opendatahub.com](mailto:help@opendatahub.com). ### Contributing If you'd like to contribute, please follow the following instructions: - Fork the repository. - Checkout a topic branch from the `main` branch. - Make sure the tests are passing. - Create a pull request against the `main` branch. ### Documentation More documentation can be found at [https://docs.opendatahub.com](https://docs.opendatahub.com). ### License The code in this project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 license. See the [LICENSE.md](LICENSE.md) file for more information. ### REUSE This project is [REUSE](https://reuse.software) compliant, more information about the usage of REUSE in NOI Techpark repositories can be found [here](https://github.com/noi-techpark/odh-docs/wiki/Guidelines-for-developers-and-licenses#guidelines-for-contributors-and-new-developers). Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The [pre-commit-config](.pre-commit-config.yaml) file in the repository root is already configured to check for REUSE compliance with help of the [pre-commit](https://pre-commit.com) tool. Install the tool by running: ```bash pip install pre-commit ``` Then install the pre-commit hook via the config file by running: ```bash pre-commit install ``` ### Examples of SPARQL queries Some examples of possible SPARQL queries can be found in the SPARQL Queries folder. You can take a look at some [data quality queries here](sparql_queries/dataquality.md) and at some [regular queries here](sparql_queries/regular.md). ### Schema The schema of the VKG can be visualized [in the dedicated page](sparql_queries/schema.md).

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：