{"id":14065829,"url":"https://github.com/smart-data-models/data-models","last_synced_at":"2025-07-29T21:33:58.006Z","repository":{"id":37333718,"uuid":"184056900","full_name":"smart-data-models/data-models","owner":"smart-data-models","description":"Data Models in common use based on real world use-cases. These definitions underpin a digital market of interoperable and replicable smart solutions.","archived":false,"fork":false,"pushed_at":"2024-10-29T09:08:17.000Z","size":127115,"stargazers_count":114,"open_issues_count":1,"forks_count":56,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-10-29T10:58:26.426Z","etag":null,"topics":["data-models","fiware","interoperability","iot","ngsi-ld","reference-architecture","schema","tmforum"],"latest_commit_sha":null,"homepage":"https://smartdatamodels.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smart-data-models.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":"governance/README.md","roadmap":"roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-29T11:17:57.000Z","updated_at":"2024-10-29T09:08:21.000Z","dependencies_parsed_at":"2024-02-21T03:45:39.968Z","dependency_job_id":"f5c6a490-db68-4244-8485-760265dde160","html_url":"https://github.com/smart-data-models/data-models","commit_stats":{"total_commits":118267,"total_committers":17,"mean_commits":6956.882352941177,"dds":0.2258364548014239,"last_synced_commit":"a714cae6f6d5f3facb767f73dbeec61f1d6fd133"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smart-data-models%2Fdata-models","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smart-data-models%2Fdata-models/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smart-data-models%2Fdata-models/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smart-data-models%2Fdata-models/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smart-data-models","download_url":"https://codeload.github.com/smart-data-models/data-models/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228052622,"owners_count":17862103,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-models","fiware","interoperability","iot","ngsi-ld","reference-architecture","schema","tmforum"],"created_at":"2024-08-13T07:04:45.345Z","updated_at":"2024-12-04T05:31:05.682Z","avatar_url":"https://github.com/smart-data-models.png","language":"Python","funding_links":[],"categories":["Python","Interoperability and Digital Infrastructure"],"sub_categories":[],"readme":"# Smart Data Models\n\nAn Umbrella Repository for collecting Data Models based on real world use-cases\n\nThe availability of widely adopted (de-facto standard) information models is key\nfor creating a global digital single market of interoperable and replicable\n(portable) smart solutions in multiple domains (smart cities, smart agrifood, \nsmart utilities, smart industry, …). Such models provide an essential\nelement in the common technical ground needed for standards-based open\ninnovation and procurement.\n\nData Models play a crucial role because they define the **harmonised\nrepresentation formats and semantics** that will be used by applications both to\nconsume and to publish data.\n\n\u003c!--\n[![Status badge](https://img.shields.io/badge/status-draft-red.svg)](RELEASE_NOTES)\n[![Build badge](https://img.shields.io/travis/smart-data-models/data-models.svg \"Travis build status\")](https://travis-ci.org/smart-data-models/data-models/)\n[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)\n--\u003e\n\n| :mega: [Latest news](https://smartdatamodels.org/) | :dart: [Roadmap](roadmap.md) | :closed_book: [Manifesto](MANIFESTO.md) | :inbox_tray: [eMail](mailto:info@smartdatamodels.org) | :wave: [Contact Us](http://smartdata-models.org/index.php/submit-an-issue-2/) |\n| -------------------------------------------------- | ---------------------------- | --------------------------------------- |------------------------------------------------------------ | ----------------------------------------------------------------------------- |\n\n**Note: This Repository does not accept Pull Requests concerning Data Models.\nPull Requests concerning Data Models shall be made against the corresponding\nsubject Repository where the data model is located**\n\n## Full list of Data Models\n\nA full list of the data models in machine-readable JSON format can be found in the file\n[official_list_data_models.json](https://github.com/smart-data-models/data-models/blob/master/specs/AllSubjects/official_list_data_models.json).\nFurther details on the available subjects, properties and their descriptions can be found via the [search tool](https://smartdatamodels.org/index.php/ddbb-of-properties-descriptions/)\n\n## Application Domains\n\nThere are new data models in progress for the following application domains (sectors):\n\n-   [Cross Sector](https://github.com/smart-data-models/CrossSector)\n-   [Smart Agrifood](https://github.com/smart-data-models/SmartAgrifood)\n-   [Smart Cities](https://github.com/smart-data-models/SmartCities)\n-   [Smart Energy](https://github.com/smart-data-models/SmartEnergy)\n-   [Smart Environment](https://github.com/smart-data-models/SmartEnvironment)\n-   [Smart Sensoring](https://github.com/smart-data-models/Smart-Sensoring)\n-   [Smart Water](https://github.com/smart-data-models/SmartWater)\n-   [Smart Destination](https://github.com/smart-data-models/SmartDestination) \n-   [Smart Aeronautics](https://github.com/smart-data-models/SmartAeronautics) \n-   [Smart Robotics](https://github.com/smart-data-models/SmartRobotics)\n-   [Smart Health](https://github.com/smart-data-models/SmartHealth)\n-   [Smart Manufacturing](https://github.com/smart-data-models/SmartManufacturing) \n-   [Smart Logistics](https://github.com/smart-data-models/SmartLogistics) (Just opened)\n\n\nA frontend [web page](http://smartdatamodels.org/) provides global updates on the Smart data models.  \nAdditionally there is a repository for drafting data models named [incubated](https://github.com/smart-data-models/incubated/tree/master) where anybody\n(under request) can draft data models that later can submit by PR or any other method. This repo is always open to collaboration.\n\n## Who are we?\n\nThe **FIWARE Foundation** **IUDX**, **TM Forum** and **OASC** and others, are leading \na joint collaboration program to support the adoption of a reference architecture \nand compatible common data models that underpin a digital market of interoperable and\nreplicable smart solutions in multiple sectors, starting with smart cities.\n\nThe Reference Architecture and Data Models use the ETSI NGSI API and TM Forum\nOpen APIs for interoperability and scalability of smart solutions. The FIWARE\nContext Broker technology, implementing the ETSI NGSI APIs (**NGSI v2 and\nNGSI-LD**), provides the basis for breaking information silos in organizations\naiming at becoming smart. Actually, it enables a real-time (or close to real\ntime, i.e., right-time) view and foundation for the development of governance\nsystems at global organization level. Examples of such organizations include\ncities, factories, hospitals, airports, farms, etc.\n\nCombined with [TM Forum Open APIs](https://www.tmforum.org/open-apis/), data \npublication platforms can support organizations to realise the potential of \nreal-time (or right-time) open data, easing development of innovative solutions \nby third parties. In addition, organizations can evolve their current data sharing \npolicies towards a vision which, shared with other organizations, brings support \nto a Data Economy. This way, the proposed Reference Architecture is ready to \nsolve the needs of organizations today while future-proofing for \ntomorrow’s requirements.\n\nThis GitHub organization structure contains **JSON Schemas and documentation**\non Smart Data Models for different Smart Domains. The following repositories are available:\n\n-   [data-models repository](https://github.com/smart-data-models/data-models) which is an umbrella repository that contains all the\n    Data Models from different verticals (e.g., Parking, Street lighting, etc.).\n    _This Repository only admit Pull Requests for templates and general documentation and \n    not for data models._\n\n-   For each Domain (industrial sector) there is a Repository containing as submodules the link to the \n    Subjects containing all the Data Models related. And some other shared elements for all the domain.\n\n-   For each Vertical(Subject) there is a Repository containing the Data Models related\n    to that vertical. _These repositories do admit pull requests regardign data models_.\n\n## General Principles\n\n-   **Driven-by-implementation approach**: Specifications will be considered\n    stable as soon as enough end user organizations (i.e., cities) have\n    validated them in practice.\n\n-   **Open-closed**. Breaking changes to already approved specs are not allowed.\n    Instead, new versions shall deprecate attributes, add new attributes, extend\n    enumerations, etc.\n\n-   **Public and royalty-free** nature of specifications. Data Model Licensing\n    mode. Preferred [Creative Commons by Attribution 4.0](https://creativecommons.org/licenses/by/4.0/)\n\n-   **Open contribution**. Contributions open to anybody (not only members),\n    while final decision making corresponds to the administrators of the domains and Subjects. Steerin board could opposed to some contributions if it does not meet coding guidelines.\n   \n\n## Lifecycle\n\nSpecifications evolve over time through versions generated by the contributors in the communities \nof every Subject. A minimum of a version each year is recommended. The parameter schemaVersion in \nthe schema denotes the version.\n\nThe way to handle new Data Models is administrated by the different subjects and domains:\n\n- Steering board (currently, FIWARE foundation, IUDX, OASC and TMForum) will check for the consistency and updating of the different data models in this group of repositories. This sterring board will grow in coming dates.\n\n\n## How to contribute\n\nContributions should come in the form of **pull requests** made against the corresponding Vertical Data Model repository.\nAn [introductory presentation](http://bit.ly/contribution_manual) about it.\n\nAs an alternative it is also possible to request a [new data model](http://smartdatamodels.org/index.php/submit-an-issue-2/) \nchoose option **new data model** in the dropdown list.\n\nA Data Model will contain the following artefacts in this structure:\n\n-   `dataModel/`\n  -   `README.md`: Pointing to the schema, the specifications in different formats and languages, etc \ninformation **This README.md is generated automatically**\n  -   `schema.json`: The JSON Schema definition. It includes in the description of every property the type of property, the model, the valid values and some other elements according to the [contribution manual](https://bit.ly/contribution_manual)\n  -    `notes.yaml`: Optional. File for customizing the specification of the data model.\n  -    `LICENSE.md`. [Templated document](https://github.com/smart-data-models/data-models/blob/master/templates/LICENCE.md) with the text of the license default CC-BY 4.0\n    -   `schemaDTDL.json`: The export of JSON Schema definition into [langauge DTDL](https://docs.microsoft.com/en-us/azure/digital-twins/concepts-models). \n   -  `/doc`. This directory contains the specifications of the data model in the different languages. They are generated automatically out of the json schema. \n   -  `/examples`. This directory contains the examples for the different versions of NGSI standard and different formats. \n               Example: [schema.json of WeatherObserved](https://github.com/smart-data-models/dataModel.Weather/blob/master/WeatherObserved/schema.json)\n    -   `example.json`: a JSON example file key values of NGSI v2\n               Example: [example.json of WeatherObserved](https://github.com/smart-data-models/dataModel.Weather/blob/master/WeatherObserved/examples/example.json)\n    -   `example-normalized.json`: An example file in NGSI v2 normalized format\n               Example: [example-normalized.json of WeatherObserved](https://github.com/smart-data-models/dataModel.Weather/blob/master/WeatherObserved/examples/example-normalized.json)\n    -   `example.jsonld`: a JSON example file key values of NGSI LD\n               Example: [example.json of WeatherObserved](https://github.com/smart-data-models/dataModel.Weather/blob/master/WeatherObserved/examples/example.jsonld)\n    -   `example-normalized.jsonld`: A JSON example file in **NGSI-LD** normalized format\n               Example: [example-normalized-ld.jsonld of WeatherObserved](https://github.com/smart-data-models/dataModel.Weather/blob/master/WeatherObserved/example-normalized.jsonld)\n  -    `ADOPTERS.yaml`. [Templated document](https://github.com/smart-data-models/data-models/blob/master/templates/dataModel/ADOPTERS.yaml) with references a actual adoption of the data model.\n               \nOther files automatically generated                   \n  -    `examplexxx.csv`: Automatically generated examples of the data model exported to csv format and located in the `/examples` directory\n  -    `model.yaml`: Automatically generated model exported from schema.json. Only descriptions are completed manually (if not set in schema). Located in the root directory.        \n  -    `swagger.yaml`: Automatically generated opbject to be visualized in [swagger editor](https://swagger.lab.fiware.org/?url=https://raw.githubusercontent.com/smart-data-models/dataModel.WaterNetworkManagement/master/Valve/swagger.yaml). Located in the root directory.\n\nTo facilitate contributions and their validation, we developed:\n- [json schema validator](https://smartdatamodels.org/index.php/data-models-contribution-api/) for validating that the documented properties are complete and compliant with the [contribution manual](https://bit.ly/contribution_manual)\n\nTo achieve a better performance, we need to break down silo’s of data, \nensuring that artificial intelligence can be applied across aggregated datasets \nand to ensure that individual citizen experience can be optimized across \ndifferent services.\n\nTo achieve this, TM Forum and FIWARE launched this initiative, later IUDX adn OASC has joined it which seeks to \nharmonize data models across Smart applications. Other organizations are pending to join.\n\nBy agreeing across different communities, the common definition of smart\ndata models, this will empower innovators and companies to develop solutions\nthat adhere to this common definition and ultimately help enable\ninteroperability of services.\n\n## @context\n\nA @context is necessary when using this data models under a linked data paradigm.\n\nEvery subject (repository for a group of data models) has a file in the root named _context.jsonld_ with the reference context.\nIt is true that there is another _context.jsonld_ in the directory of this README.md file. It is obsolete and it is there only for historical reasons.\nIn case that you need to merge several @context from different subjects you can use this service in the [front page](https://smartdatamodels.org):\n\nHome -\u003e Tools -\u003e [Subjects' @context merger (last option)](https://smartdatamodels.org/index.php/generate-a-local-context-based-on-smart-data-models-iris/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmart-data-models%2Fdata-models","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmart-data-models%2Fdata-models","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmart-data-models%2Fdata-models/lists"}