README - JedAI-spatial for three-dimensional Geospatial Interlinking

The following README will guide you through the whole process of Geospatial Interlinking using jedAI-spatial.

💡 Tip: If you want to learn more about jedAI-spatial read the docs here.

Input

For all key attributes in JSON, exactly one file path must be provided.

Attributes	Info	Value Type	Required
source	csv tsv GeoJSON JSONRDF rdfformat	list	✔
target	csv tsv GeoJSON JSONRDF rdfformat	list	✔

{
	"inputs" :
		"source": [
      "d5e730ba..."
    ],
    "target": [
      "cb37e262..."
    ],
}

Parameters

Concering input, additional info must be provided.

Attributes	Info	Value Type	Required
source	Provide info for source dataset to be processed correctly	source_object	✔
target	Provide info for target dataset to be processed correctly	target_object	✔
algorithm	GIA.nt RADON Plane Sweep (List) Plane Sweep (Strips) PBSM (List) PBSM (Strips) R-Tree Quad Tree CR-Tree Strip Sweep Strip STR Sweep		✔

source/target

Attributes of keys: source, target

Attributes	Info	Value Type	Required
data_tpye	csv tsv geojson jsonrdf rdf	string	✔
geo_index	Index of the geometry	int	✔ if csv or tsv
attributes_first_row	true/false if input dataset contains attributes at the first row	bool	✔ if csv or tsv
prefix_RDF	Prefix of the RDF triples	string	✔ if rdf

Input Examples

"parameters" : {
  "source" : {
      "data_type" : "csv",
      "geo_index": 0,
      "attributes_first_row" : true         
  },
  "target" : {
      "data_type" : "csv",
      "geo_index": 0,
      "attributes_first_row" : true         
  },
  "algorithm": "R-Tree"                
  },       

Output

For all key attributes in JSON, exactly one file path must be provided.

Attributes	Info	Value Type	Required
metrics	Creates a file with the metrics in .json format	path
pairs	Creates a ntriples file with the pairs that were matched .nt format	path

"outputs": {
    "metrics" : {
      "url":"s3://klms-bucket/jedai-spatial/output_metrics.json"
    },
    "pairs" :{
      "url": "s3://klms-bucket/jedai-spatial/output_pairs.nt"
    }
}