ubaldus commited on
Commit
c43f6fd
·
verified ·
1 Parent(s): e863b3d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +49 -1
README.md CHANGED
@@ -7,4 +7,52 @@ tags:
7
  - cronotopia
8
  - openstreetmap
9
  pretty_name: Cronotopia
10
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  - cronotopia
8
  - openstreetmap
9
  pretty_name: Cronotopia
10
+ ---
11
+
12
+ # Cronotopia
13
+
14
+ This repository provides the preprocessed data distributions for Cronotopia, a specialized engine for the visualization and analysis of historical geospatial data.
15
+
16
+ The primary artifact is a consolidated SQLite database containing both structured historical records and vector map tiles, optimized for deployment in environments requiring total offline autonomy.
17
+
18
+ ## Resource Description
19
+
20
+ The hosted file, `cronotopia.db.gz`, is a compressed SQLite database. It serves as the unified data backend for the Cronotopia application, integrating the following components:
21
+
22
+ * **Historical Entities:** Records extracted from Wikidata, including temporal attributes (dates of birth, death, or occurrence) and geospatial coordinates.
23
+ * **Vector Tiles:** Map data stored in MVT (Mapbox Vector Tile) format within the `tiles` table, enabling local map rendering without external tile providers.
24
+
25
+ ## Technical Specifications
26
+
27
+ | Attribute | Specification |
28
+ | :--- | :--- |
29
+ | **File Format** | SQLite 3 (Gzip compressed) |
30
+ | **Primary Data Source** | Wikidata (JSON Dumps) |
31
+ | **Map Source** | OpenStreetMap (via Protomaps/MVT) |
32
+ | **Temporal Range** | Variable (spanning ancient history to the contemporary era) |
33
+
34
+ ## Implementation and Usage
35
+
36
+ To utilize this database with the Cronotopia server, follow these procedures:
37
+
38
+ ### 1. Retrieval and Extraction
39
+
40
+ Download the artifact and decompress it using standard utilities:
41
+
42
+ ```bash
43
+ wget https://huggingface.co/datasets/eja/cronotopia/resolve/main/cronotopia.db.gz
44
+ gunzip cronotopia.db.gz
45
+ ```
46
+
47
+ ### 2. Service Initialization
48
+
49
+ Execute the Cronotopia binary, directing it to the local SQLite file. This will initiate the API and the web interface.
50
+
51
+ ```bash
52
+ ./cronotopia --db cronotopia.db --web-host localhost --web-port 35248
53
+ ```
54
+
55
+ The application will be served at `http://localhost:35248`.
56
+
57
+
58
+ For further technical documentation regarding the ingestion pipeline or server configuration, refer to the [official GitHub repository](https://github.com/eja/cronotopia).