Skip to content

Commit 7116292

Browse files
authored
docs(models): update models api docs (#209)
Update docs to reflect #207
1 parent 366df8a commit 7116292

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

docs/md/models.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,27 @@ pprint(list(models.get_models())[:5])
1414
```
1515

1616
```
17-
['example/ex-gwe-ates',
18-
'example/ex-gwe-barends/mf6gwe',
19-
'example/ex-gwe-barends/mf6gwf',
20-
'example/ex-gwe-danckwerts',
21-
'example/ex-gwe-geotherm/mf6gwe']
17+
['mf6/example/ex-gwe-ates',
18+
'mf6/example/ex-gwe-barends/mf6gwe',
19+
'mf6/example/ex-gwe-barends/mf6gwf',
20+
'mf6/example/ex-gwe-danckwerts',
21+
'mf6/example/ex-gwe-geotherm/mf6gwe']
2222
```
2323

24+
### Model names
25+
2426
Model names follow a hierarchical addressing scheme.
2527

26-
The leading prefix identifies where the model came from. Currently three prefixes are in use:
28+
The leading part identifies the kind of model, e.g. `mf6`, `mf2005`, etc. Subsequent parts may be used to classify the model.
29+
30+
Currently the following prefixes are in use:
2731

28-
- `example/...`: example models in https://github.com/MODFLOW-ORG/modflow6-examples
29-
- `test/...`: test models in https://github.com/MODFLOW-ORG/modflow6-testmodels
32+
- `mf6/example/...`: mf6 example models in https://github.com/MODFLOW-ORG/modflow6-examples
33+
- `mf6/test/...`: mf6 test models in https://github.com/MODFLOW-ORG/modflow6-testmodels
34+
- `mf6/large/...`: large mf6 test models in https://github.com/MODFLOW-ORG/modflow6-largetestmodels
3035
- `mf2005/...`: mf2005 models in https://github.com/MODFLOW-ORG/modflow6-testmodels
31-
- `large/...`: large test models in https://github.com/MODFLOW-ORG/modflow6-largetestmodels
3236

33-
The remaining path parts reflect the relative location of the model within the source repository.
37+
The remaining parts may reflect the relative location of the model within the source repository.
3438

3539
**Note**: until this module stabilizes, model naming conventions may change without notice.
3640

0 commit comments

Comments
 (0)