Set up FAIR Data Point
Use FAIR Data Point (FDP) to publish GDI metadata in a standardised RDF format that can be harvested by the User Portal.
The operational FDP setup is maintained outside this repository:
- Follow the starter-kit deployment guide to deploy FDP and connect the instance to the User Portal.
- Use the GDI metadata repository to update SHACL shapes on an FDP instance.
- Use the GDI metadata documentation as the source of truth for the current metadata model, field obligations, guidance notes, and controlled vocabularies.
Deploy FDP
Deploy FDP by following the FAIR Data Point section of the starter-kit deployment guide. That guide covers the FDP Docker Compose setup, default accounts, production deployment references, Kubernetes resources, and the information that must be shared so the User Portal can harvest the FDP instance.
Update SHACL shapes
The GDI SHACL shapes are maintained in the gdi-metadata repository. Do not update the FDP metadata schemas manually in the FDP UI unless you are explicitly testing a local draft.
Use the automated schema tool from gdi-metadata to publish the current shapes:
-
Open
schema-tool/.env. -
Set
FDP_HOSTto the FDP instance that should receive the update. -
Set
FDP_USERandFDP_PWDto credentials for an FDP admin user. -
From
schema-tool/, run:docker compose up
The tool uses schema-tool/Properties.yaml to combine the shape files, define parent-child relations, and publish the intended shapes to FDP.
Metadata model
The current GDI metadata model is documented in gdi-metadata/Documentation:
gdi-metadata-overview.mddescribes the class hierarchy, namespaces, and validation approach.Metadata_submission.csvis the field-by-field submission guide, including obligation level, cardinality, guidance notes, and example values.choicelist.csvlists controlled vocabulary values used by enumerated fields.
Onboard metadata
Automate large-scale metadata uploads using the SeMPyRO Jupyter notebook. Clone the SeMPyRO repository and run the notebook:
hatch run docs:jupyter lab
Use the Usage_example_GDI.ipynb notebook as an example for submitting GDI metadata to FDP.
After setting up FAIR Data Point:
- Configure metadata schemas: Define CKAN dataset fields and validation rules
- Manage data and services: Configure harvesters to import FDP metadata
- Monitor and maintain the system: Set up ongoing monitoring and maintenance