Data Format Documentation

1. Introduction

This document provides documentation on the various data formats used within the CoE Hidalgo2 research pipeline. Understanding these formats is essential for working with and interpreting the data generated by the pipeline.

2. JSON (JavaScript Object Notation)

JSON is used as the metadata format to provide essential context and information about the research data. It is a lightweight and human-readable data interchange format.

JSON Format Example:

{
  "city_name": "CityName",
  "radius_meters": 1000,
  "creation_date_time": "YYYY-MM-DDTHH:mm:ss",
  "creator_name": "John Doe",
  "gis_resolution": 1.0,
  "building_definition_level": "High",
  "total_buildings": 500,
  "total_building_faces": 2500,
  "has_vegetation": true,
  "has_mountains": false,
  "has_roads": true
}

3. MSH (Gmsh Mesh Format)

MSH files (version 4.1) are used to store mesh data generated using Gmsh, a powerful meshing tool. The MSH format is commonly used in scientific computing for representing complex geometries.

4. CSV (Comma-Separated Values) Files

CSV files are used for storing data related to solar masks and computational results. They are a tabular data format, where values are separated by commas.

The solar mask format is documented xref:.

5. FMU (Functional Mock-up Unit) Files

FMU files are used to store building energy models. FMUs are a standard format for packaging model components, making it possible to simulate and exchange models across different simulation tools.

6. Conclusion

This documentation provides an overview of the data formats used within the CoE Hidalgo2 research pipeline. Understanding these formats is crucial for effectively working with and analyzing the data generated during research activities.