Add/fix missing property descriptions

smart-data-models / dataModel.WaterDistributionManagementEPANET

Data models for describing a water distribution infrastructure, also compatible with EPANET simulation tool

Other

15 stars 18 forks source link

Add/fix missing property descriptions #19

Closed csweetapple closed 3 years ago

csweetapple commented 3 years ago

Add tag description in spec.md for Curve.
Correct tag description in spec.md for Pattern.
Remove demandCategory from Reservoir schema (since EPANET only allows demands to be specified for junctions)
Remove emitterCoefficient from Reservoir schema (since EPANET only allows emitters to be specified for junctions)
Remove baseDemand from Tank schema (baseDemand should be a sub-property of demandCategory, which isn't (and shouldn't) be present for tanks)
Add bulkReactionCofficient description in spec.md for Tank
Add initialQuality description in spec.md for Tank
Add minLevel description in spec.md for Tank.
Correct type description in spec.md for Tank, Valve, Reservoir, Pump and Pattern
Correct location description in spec.md for Tank, Valve, Reservoir, Pump and Pipe

csweetapple commented 3 years ago

With respect to the missing demandeCategory definition noted for the Junction model, there is only one occurrence of demandeCategory present in the code and that's in the junction model.yaml - in the Junction schema it is already correctly named demandCategory and this is defined in the corresponding spec.md. Will the model.yaml be updated/corrected automatically?

albertoabellagarcia commented 3 years ago

Source category has 5 mandatory properties, it means that a payload without these properties cannot be considered. It limits quite much of its use. Can this be reconsidered?

Regarding units cannot be simplified all these?. As far as I understand it is 'only' the E91 code, the reference to CEFACT and the example

Attribute unit: All units are accepted in CEFACT code
- Attribute unit Example: 1/day
- CEFACT unitCode: E91

csweetapple commented 3 years ago

Source category has 5 mandatory properties, it means that a payload without these properties cannot be considered. It limits quite much of its use. Can this be reconsidered?

Are you referring here to the definition of sourceCategory in WaterNetworkManagement-schema.json, which has

        "required": [
            "type",
            "value",
            "sourceType",
            "sourceQuality",
            "sourcePattern"
        ]

To be EPANET compatible, it is essential that every source as a sourceType (CONCEN, MASS, FLOWPACED, or SETPOINT) and sourceQaulity defined. sourcePattern should be optional.

Note also that sourceCategory itself is an optional property (of junctions, tanks and reservoirs).