Manifest

[d2hydro]

Regarding my latest comment: https://github.com/Deltares/Ribasim/issues/960#issuecomment-1945681068 some thoughts, assumption and a sollution we can experiment with in this repo.

Thoughts and assumptions:

• Ribasim Python is to be kept as clean as possible; no support for anything not used directly for the Julia core. I think that is wise.
• Users want to keep important data, not used in computation, "tied" to their project. See: https://github.com/Deltares/Ribasim/issues/960#issuecomment-1945648881
• Users want to find the toml-file, read it with the correct version of Ribasim (Python/CLI) and ore external sotftwar (e.g. HydroConsult)

Sollution: We write a manifest.json With 3 blocks (see example below):

• ribasim: register of all files/specifics uses by Ribsim (python), including the version. So anybody can pick up the model with any software and the correct Ribsim-CLI
• extra_layers: layers outside ribasim, but with clear meaning; Area are the areas mentioned here: https://github.com/Deltares/Ribasim/issues/960#issuecomment-1945681068 and should have a column node_id. We may, or may not` check if the node_ids correspont with the Node layer
• extra_data: all other files that you can "tie" to the model by referencing the file and giving a discription

{
    "ribasim": {
        "database": "database.gpkg",
        "results_dir": "results",
        "toml": "lhm.toml",
        "version": "0.7.0",
    },
    "extra_layers":{
        "Area": {"file": "project_data.gpkg", "layer": "area"}
}
    "extra_data": [
    "file": "readme.md", "description": "Logbestand modellering",
    "file": "kunstwerken.xlsx", "description": "instellingen kunstwerken zoals afgesproken met Rijkswaterstaat"
    ]
    }

[d2hydro]

After discussion, this is the status:

• Ribasim will support a Basin / area table with node_id and geometry (MutiPolygon, Polygon) column https://github.com/Deltares/Ribasim/issues/960
• Ribasim will write (and update) the ribasim_version in the TOML
• A registry of extra_data is at modellers responsibility