timml icon indicating copy to clipboard operation
timml copied to clipboard

API reference does not mention the parameter quantities (grootheden)

Open Huite opened this issue 1 year ago • 3 comments

Coming from a question that was e-mailed to me: the API reference currently does not mention what the units or quantities are. Not having units is a feature, just like MODFLOW, as some people want to compute in m/d, ft/d, m/s, etc.

However, it would be worthwhile to add the quantities like MODFLOW does in the documentation, e.g. L/T for length over time, L^3 for volumes, etc.

Huite avatar Jan 11 '24 14:01 Huite

It is indeed a good idea to add dimensions like L/T or L^3/T to the docs.

mbakker7 avatar Jan 11 '24 14:01 mbakker7

Another thing I noticed (after getting another e-mail): whether a discharge or rate is adding or removing water from the model isn't always mentioned in the docstrings. For example, the Circular Area Sink explicitly mentions that a positive value is adding water, but a well or linesinkditch discharge (or the N argument on the inhom) should also mention it. Especially since it depends on the element unlike MODFLOW, where positive is (almost?) always adding water to the model.

Huite avatar Feb 09 '24 12:02 Huite

You are correct. This would be another worthwhile addition to the doc strings.

mbakker7 avatar Feb 09 '24 12:02 mbakker7