ubaldus commited on
Commit
31487b3
·
verified ·
1 Parent(s): 4646e01

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -26
README.md CHANGED
@@ -4,55 +4,56 @@ language:
4
  - en
5
  tags:
6
  - wikidata
 
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).
 
4
  - en
5
  tags:
6
  - wikidata
7
+ - wikipedia
8
  - cronotopia
9
  - openstreetmap
10
+ - geospatial
11
+ - history
12
  pretty_name: Cronotopia
13
  ---
14
 
15
+ # Cronotopia Preprocessed Database
16
 
17
+ This repository hosts preprocessed database distributions for [Cronotopia](https://github.com/eja/cronotopia), an offline-first spatio-temporal search engine and vector map server.
18
 
19
+ The database is distributed as a seekable Zstandard-compressed SQLite file (`cronotopia.db.zst`), enabling direct read-only execution without extracting to disk.
20
 
21
+ ## Contents
22
 
23
+ The unified database bundles:
24
 
25
+ * **Historical Entities & Events:** Geospatial coordinates, dates, and claims extracted from Wikidata.
26
+ * **Knowledge Base:** Full-text Wikipedia article sections indexed with SQLite FTS5.
27
+ * **Vector Embeddings & ANN Index:** Semantic embeddings and clustered Matryoshka ANN index.
28
+ * **Vector Map Tiles:** Base map tiles (OpenStreetMap / MVT) stored internally for offline map rendering.
29
 
30
+ ## Quick Start
31
 
32
+ ### 1. Download the Database
 
 
 
 
 
33
 
34
+ ```bash
35
+ wget https://huggingface.co/datasets/eja/cronotopia/resolve/main/cronotopia.db.zst
36
+ ```
37
 
38
+ ### 2. Run with Cronotopia
39
 
40
+ Cronotopia can mount and serve the `.zst` database directly with zero disk decompression:
41
 
42
  ```bash
43
+ ./cronotopia --db cronotopia.db.zst
 
44
  ```
45
 
46
+ The web interface will be available at `http://localhost:35248`.
47
 
48
+ *(Optional)* If you plan to run batch modifications, further ingestion, or AI sync, decompress it first:
49
 
50
  ```bash
51
+ ./cronotopia --db cronotopia.db.zst --decompress
52
+ ./cronotopia --db cronotopia.db
53
  ```
54
 
55
+ ---
56
 
57
+ ## Documentation & Source Code
58
 
59
+ For binary downloads, source compilation, ingestion pipelines, REST APIs, and Model Context Protocol (MCP) tool integration, visit the [Cronotopia GitHub repository](https://github.com/eja/cronotopia).