Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API reference does not mention the parameter quantities (grootheden) #106

Open
Huite opened this issue Jan 11, 2024 · 3 comments
Open

API reference does not mention the parameter quantities (grootheden) #106

Huite opened this issue Jan 11, 2024 · 3 comments

Comments

@Huite
Copy link
Contributor

Huite commented Jan 11, 2024

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.

@mbakker7
Copy link
Owner

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

@Huite
Copy link
Contributor Author

Huite commented Feb 9, 2024

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.

@mbakker7
Copy link
Owner

mbakker7 commented Feb 9, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants