Skip to content

docs(models): update models api docs #209

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.

Sign up for GitHub

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

Merged
wpbonelli merged 1 commit into from
Apr 22, 2025
Merged

docs(models): update models api docs #209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions docs/md/models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down