Add overview of extensions

ImperialCollegeLondon / wsi

WSIMOD is a software for simulating water quality and quantity

https://imperialcollegelondon.github.io/wsi/

BSD 3-Clause "New" or "Revised" License

13 stars 2 forks source link

Add overview of extensions #120

Closed dalonsoa closed 1 week ago

dalonsoa commented 4 weeks ago

Initial attempt at adding an overview of the ways of extending WSIMOD, covering briefly:

Overrides: @barneydobson , I haven't found any example on how these are used. The apply_overrides functions are not even called anywhere.
Patches: Here I also explain extension files and point people to the reference.
Subclasses: Brief description. It will be good to have a minimal working example that actually is meaningful. @liuly12 , maybe you can bring something to the table?

barneydobson commented 3 weeks ago

Hmm it seems that Node level apply_overrides are extensively tested (e.g.,) - but yes maybe not the one in Model

dalonsoa commented 3 weeks ago

Oh, they do have tests - all of the node and arc ones - but when creating a model and running a simulation, I don't see when or how the apply_overrides are called. As far as I can tell, it is an unused feature.

barneydobson commented 3 weeks ago

Ah OK - I can do that in a new issue today

dalonsoa commented 2 weeks ago

I've extended the document with more details on the overrides and also added orchestration - the orchestration file is just a placeholder to be filled by someone else!

To be honest, I'm still not entirely sure why/when to use overrides. If someone can provide a sentence or two to add to the docs, that would be helpful.