HD-Map Asset Example

This repo serves as a reference for onboarding an HD-Map asset into the data space of ENVITED and can be used as a template for other dataspaces as well. It contains a fully described and consistent example of an HD-Map asset and an manifest.json - file.

A complete asset in a specific domain includes the data itself and all necessary files for describing, evaluating, and visualizing the dataset.

The asset has a specific following folder structure and the sample can be downloaded here in this repo from the lastest release (asset.zip).

Repo Structure

The Repo has the following structure:

📁 .github -> github workflows

📁 asset -> contains the asset

📁 shacls-and-ontologies -> contains all SHACLs and ontologies needed for onboarding and registering datasets, including semantic and syntactic validation of the provided metadata. It also includes the current released versions.

📄 CONTRIBUTING.md -> contributing guidelines

📄 README.md -> documentation of the Repo and the asset

Asset Folder Structure

📁 asset

• 📄 README.md (defines asset folder structure)
• 📄 ..more.. (see folder)

Shacls and Ontologies Folder Structure

📁 shacls-and-ontologies

• 📁 ontology-management-base

  • 📁 general
  • 📁 georeference
  • 📁 gx
  • 📁 hdmap
  • 📁 manifest
  • 📁 marketplace-info

• 📁 used-shacls

  • 📄 domainMetadata_shacl.ttl
  • 📄 manifest_shacl.ttl

Legend

• 📁 folderName: A folder in the repo.
• 📄 assetName: A file in the repo.
• (optional) : This file or folder is optional and can be added or omitted as needed.

FAQ:

How can I easily create a manifest file?

• Preparation : Ensure you have the SHACL file downloaded. The provided SHACL file defines the structure and constraints for the manifest.

• Access the Web Tool : Open the SD Creation Wizard in your web browser.

• Upload the SHACL - File : Click the button to upload your SHACL file. The tool will analyze the file and extract the relevant information.

• Configuration : After uploading, you may be prompted to enter additional information or configurations. This could include specifying contexts, IDs, or other metadata.

• Generate Manifest : The tool will generate a manifest file based on the provided SHACL file and your input. Review the generated data and make any necessary adjustments.

• Download : Once you are satisfied with the generated manifest, you can download it and use it in your project.

Which roles can I define for access management?

• owner : The owner has full access to the asset and its associated files. This role includes permissions to download the asset.

• registeredUser : A registered user has access to certain files and data within the asset but can't download the asset.

• publicUser : A public user has only viewing rights to certain files or metadata.

Which SCHAL - Files are used to generate the domainMetadata.json ?

-You need to use from Ontology Management Base Repository following SHACL - files: gx_shacl, general_shacl, georeference_shacl and hdmap_asset_shacl.

How does the onboarding of an asset via the ENVITED dataspace work?

Usage

1. Read the README.md - file.
2. Download the lastest asset.zip - file release.
3. Explore the provided data files and documentation.
4. Create the same folder and file structure for your asset, along with an appropriate domainMetadata.json - file and manifest.json - file.
5. Zip your fills to an asset.zip - file.
6. You are now ready to upload asset.zip - file and start registration of your asset.