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

Add preprocessing sections to the different driver docs #41

Open
Huite opened this issue Feb 6, 2024 · 0 comments
Open

Add preprocessing sections to the different driver docs #41

Huite opened this issue Feb 6, 2024 · 0 comments

Comments

@Huite
Copy link
Contributor

Huite commented Feb 6, 2024

The current MetaMod coupler documentation section mentions:

  • Configuration
  • Technical reference
  • Example

I think it makes a lot of sense to have another section called "preprocessing". This is obviously relevant to most users, as they will be quite involved with the spatial coupling logic (making sure models align for example).

Such a document should introduce the primod package, explain the requirements before a model can be coupled in terms of its schematization and concepts, mention how the automatic definition is exchanges is done (based on spatial locations), as well as mention the relevant components of all models. A full example is not required, but for readability, some duplication might be desirable.

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

1 participant