search

People-Places-Solutions / floodmodeller-api

The Flood Modeller Python API is a free and open-source python package which provides a bridge between Flood Modeller and the python programming language to extend the capabilities of Flood Modeller in automated workflows
https://api.floodmodeller.com/api/
Other
38 stars 15 forks source link

Hydrology+ support #116

Closed joe-pierce closed 1 month ago

joe-pierce commented 4 months ago

We want to support the new hydrology+ features with the API. This initially will come in 3 parts:

  1. Supporting reading the CSV export from H+ project with a simpler interface (i.e. not just pandas.read)
  2. Support using boundary inputs from the H+ csv export in IEF and XML2D classes. (likely already would be 'supported' but need to see what can be done to make the UX a little nicer, i.e. having a single class to represent the H+ data and RPs/scenarios etc.)
  3. Support a read-only connection to the H+ SQL Express database (locally stored), allowing for users to query however they want. Initially this can be very basic and just a case of well documenting the database structure to allow for direct SQL queries, but if deemed useful we can set it up using an ORM to make it nicer to work with. Either direct connect or maybe dump into a temp sqlite embedded db?