Files
mercator_data_generator/README.md

53 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Mercator Test data generator
Small tool to generate test data for Mercator, a spatial index.
## Mercator: Spatial Index
**Mercator** is a spatial *volumetric* index for the [Human Brain Project](http://www.humanbrainproject.eu). It is a component of the [Knowledge Graph](http://www.humanbrainproject.eu/en/explore-the-brain/search/) service, which provides the spatial anchoring for the metadata registered as well as processes the volumetric queries.
It is build on top of the Iron Sea database toolkit.
## Iron Sea: Database Toolkit
**Iron Sea** provides a set of database engine bricks, which can be combined and applied on arbitrary data structures.
Unlike a traditional database, it does not assume a specific physical structure for the tables nor the records, but relies on the developper to provide a set of extractor functions which are used by the specific indices provided.
This enables the index implementations to be agnostic from the underlying data structure, and re-used.
## Requirements
### Software
* Rust: https://www.rust-lang.org
## Quick start
Checkout the dependencies in the parent folder:
* mercator_db
* ironsea_index
* ironsea_store
* ironsea_table
* ironsea_index_hashmap
* ironsea_index_sfc_dbc
* ironsea_table_vector
This tool takes as arguments a list of number of features to generate.
One thousand (1000) positions are generated per feature. For each number
provided a dataset will be generated under:
* `number`k.spaces.json -- The reference spaces for that dataset
* `number`k.objects.json -- The objects randomly generated (`number` features, each with 1000 positions.)
Example to create 3 datasets, of 1, 10 and 100 features respectively:
```sh
cargo run --release -- 1 10 100
```
## Acknowledgements
This open source software code was developed in part or in whole in the
Human Brain Project, funded from the European Unions Horizon 2020
Framework Programme for Research and Innovation under the Specific Grant
Agreement No. 785907 (Human Brain Project SGA2).