|
1 | | -# 🌊 GIFIS: Generalized Immersive Flood Information System Specification |
| 1 | +# 📑 GIFIS Specification — Interactive Table of Contents |
2 | 2 |
|
3 | | -An open standard for immersive, interoperable flood information systems. |
| 3 | +Below you can explore each schema in the GIFIS Specification. |
| 4 | +Click on a section to expand details. |
4 | 5 |
|
5 | 6 | --- |
6 | 7 |
|
7 | | -## 📖 About GIFIS |
| 8 | +<details> |
| 9 | + <summary><b>🌐 <span style="color:#005fcb">1. Core Schema</span></b></summary> |
8 | 10 |
|
9 | | -The **Generalized Immersive Flood Information System (GIFIS) Specification** defines a structured and extensible data model for representing, validating, and publishing hydrologic and geospatial datasets in immersive environments (VR/AR/MR). |
| 11 | + Defines the **base structure** all GIFIS objects inherit from. |
10 | 12 |
|
11 | | -It provides JSON Schema–based profiles for core entities such as **locations**, **events**, **alerts**, and **flood maps**. |
| 13 | + **Key Fields:** |
| 14 | + - `id` → Unique identifier (`loc-123`, `evt-456`) |
| 15 | + - `specVersion` → Namespace + version (`gifis-core@1.0`) |
| 16 | + - `schemaRef` → Canonical schema URL |
| 17 | + - `metadata` → Creator, license, provenance |
| 18 | + - `updatedAt` → Timestamp |
| 19 | + |
| 20 | + 📄 File: [`core.schema.json`](spec/gifis-core/1.0/core.schema.json) |
| 21 | + |
| 22 | +</details> |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +<details> |
| 27 | + <summary><b>📍 <span style="color:#005fcb">2. Location Schema</span></b></summary> |
| 28 | + |
| 29 | + Represents **geographic locations** where hydrologic or meteorological events occur. |
| 30 | + |
| 31 | + **Includes:** |
| 32 | + - `geometry` → GeoJSON / 3D Tiles reference |
| 33 | + - `properties` → Name, type, region, etc. |
| 34 | + - Extends **Core Schema** |
| 35 | + |
| 36 | + 📄 File: [`location.schema.json`](spec/gifis-core/1.0/location/location.schema.json) |
| 37 | + |
| 38 | +</details> |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +<details> |
| 43 | + <summary><b>📅 <span style="color:#005fcb">3. Event Schema</span></b></summary> |
| 44 | + |
| 45 | + Describes **flood-related events** such as rainfall, discharge, or inundation. |
| 46 | + |
| 47 | + **Includes:** |
| 48 | + - `eventType` → (rainfall, flood, storm surge…) |
| 49 | + - `timeRange` → Start / End time |
| 50 | + - `locationRef` → Link to Location object |
| 51 | + - Extends **Core Schema** |
| 52 | + |
| 53 | + 📄 File: [`event.schema.json`](spec/gifis-core/1.0/events/event.schema.json) |
| 54 | + |
| 55 | +</details> |
12 | 56 |
|
13 | 57 | --- |
14 | 58 |
|
15 | | -## 🔑 Core Features |
| 59 | +<details> |
| 60 | + <summary><b>🚨 <span style="color:#005fcb">4. Alert Schema</span></b></summary> |
| 61 | + |
| 62 | + Represents **hazard alerts** tied to floods or hydrologic events. |
16 | 63 |
|
17 | | -- ✅ JSON Schema–driven validation for consistency and interoperability |
18 | | -- 🌍 Support for geospatial formats (GeoJSON, 3D Tiles, glTF) |
19 | | -- 🧾 Standardized metadata for hydrologic, meteorological, and sensor data |
20 | | -- 🚨 Integration with alerting systems and flood forecast models |
21 | | -- 🕶️ Designed for real-time immersive visualization (VR/AR/MR) |
| 64 | + **Includes:** |
| 65 | + - `alertType` → Flood Watch / Flood Warning / Advisory |
| 66 | + - `severity` → Minor / Moderate / Major |
| 67 | + - `area` → Linked Location(s) or bounding geometry |
| 68 | + - `issuedAt` & `expiresAt` → Validity window |
| 69 | + |
| 70 | + 📄 File: [`alert.schema.json`](spec/gifis-core/1.0/alerts/alert.schema.json) |
| 71 | + |
| 72 | +</details> |
22 | 73 |
|
23 | 74 | --- |
24 | 75 |
|
25 | | -## 🚀 Getting Started |
| 76 | +<details> |
| 77 | + <summary><b>🗺️ <span style="color:#005fcb">5. Flood Map Schema</span></b></summary> |
| 78 | + |
| 79 | + Defines **geospatial flood map overlays** for immersive visualization. |
| 80 | + |
| 81 | + **Includes:** |
| 82 | + - `geometry` → Polygon / Raster reference (GeoJSON, TIFF) |
| 83 | + - `properties` → Depth, extent, classification |
| 84 | + - `timestamp` → When the map applies |
| 85 | + - Extends **Core Schema** |
| 86 | + |
| 87 | + 📄 File: [`floodmap.schema.json`](spec/gifis-core/1.0/floodmap/floodmap.schema.json) |
26 | 88 |
|
27 | | -1. Clone the repository: |
28 | | - ```bash |
29 | | - git clone https://github.com/uihilab/GIFIS.git |
| 89 | +</details> |
0 commit comments