From 7ca53b54adf32b114764a3193cdbf20fea69c362 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Tue, 22 Apr 2025 10:15:39 -0400 Subject: [PATCH] docs(models): update models api docs --- docs/md/models.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/md/models.md b/docs/md/models.md index be4d3cf2..f1415a00 100644 --- a/docs/md/models.md +++ b/docs/md/models.md @@ -14,23 +14,27 @@ pprint(list(models.get_models())[:5]) ``` ``` -['example/ex-gwe-ates', - 'example/ex-gwe-barends/mf6gwe', - 'example/ex-gwe-barends/mf6gwf', - 'example/ex-gwe-danckwerts', - 'example/ex-gwe-geotherm/mf6gwe'] +['mf6/example/ex-gwe-ates', + 'mf6/example/ex-gwe-barends/mf6gwe', + 'mf6/example/ex-gwe-barends/mf6gwf', + 'mf6/example/ex-gwe-danckwerts', + 'mf6/example/ex-gwe-geotherm/mf6gwe'] ``` +### Model names + Model names follow a hierarchical addressing scheme. -The leading prefix identifies where the model came from. Currently three prefixes are in use: +The leading part identifies the kind of model, e.g. `mf6`, `mf2005`, etc. Subsequent parts may be used to classify the model. + +Currently the following prefixes are in use: -- `example/...`: example models in https://github.com/MODFLOW-ORG/modflow6-examples -- `test/...`: test models in https://github.com/MODFLOW-ORG/modflow6-testmodels +- `mf6/example/...`: mf6 example models in https://github.com/MODFLOW-ORG/modflow6-examples +- `mf6/test/...`: mf6 test models in https://github.com/MODFLOW-ORG/modflow6-testmodels +- `mf6/large/...`: large mf6 test models in https://github.com/MODFLOW-ORG/modflow6-largetestmodels - `mf2005/...`: mf2005 models in https://github.com/MODFLOW-ORG/modflow6-testmodels -- `large/...`: large test models in https://github.com/MODFLOW-ORG/modflow6-largetestmodels -The remaining path parts reflect the relative location of the model within the source repository. +The remaining parts may reflect the relative location of the model within the source repository. **Note**: until this module stabilizes, model naming conventions may change without notice.