mattkram / duality Goto Github PK

It would be an interesting use case to model the NHC marine weather forecasts. A fleet of floating wind turbines could also be modeled, and the use case of response forecast could be implemented as a test case.

https://www.nhc.noaa.gov/marine/grids.php

I would like the ability to define a class hierarchy in duality, but have the ability via utilities to export these models to DTDL and upload to a GitHub repository, which can serve as a means for model governance.

duality models are represented by Python classes, so these can be composed very flexibly, because we have access to the import mechanism. However, when we export these models to DTDL for representation in ADT or another compatible backend, we need to give each model its own unique ID, which is a DTMI string.

Right now, I duality constructs the DTMI string this way:

• prefix them all with "dtmi:"
• followed by a model-specified prefix
• followed by the class name, converted to camel_case
• followed by the version number

For example:

class MyChildModel(MyModel, model_prefix="duality:child", model_version=1):
    my_string_property: str
    my_int_property: int

has the id: "dtmi:duality:child:my_child_model;1"

There should be a way to auto-generate the prefixes via the inheritance hierarchy, so the following classes wouldn't need to manually specify their own prefixes:

class MyModel(MyBaseModel, model_prefix="duality", model_version=2):
    my_parent_property: str


class MyChildModel(MyModel, model_prefix="duality:child", model_version=1):
    my_string_property: str
    my_int_property: int

The other issue is, we need a way to structure all of the models in the inheritance hierarchy in a folder structure, so that when the DTDL JSON documents are saved to a repository, they are represented by a folder structure, instead of a flat list of files. Potentially, this should just split the DTMI id string at the : character, replacing it with a /.

For example, "dtmi:duality:child:my_child_model;1" -> dtmi/duality/child/dtmi:duality:child:my_child_model;1.json.

We may also need to normalize the filenames by replacing : and ; with underscores.