Skip to content

Update docs and converter to reflect #46#50

Merged
LourensVeen merged 3 commits into
developfrom
issue_47_resource_requirements_docs
Jun 1, 2026
Merged

Update docs and converter to reflect #46#50
LourensVeen merged 3 commits into
developfrom
issue_47_resource_requirements_docs

Conversation

@LourensVeen
Copy link
Copy Markdown
Contributor

This updates the documentation to reflect #46, and also updates the converter to prepend the model name to the resources if one is available.

Addresses #47.

@LourensVeen LourensVeen requested a review from maarten-ic May 23, 2026 14:54
@LourensVeen LourensVeen self-assigned this May 23, 2026
@LourensVeen LourensVeen changed the title Issue 47 resource requirements docs Update docs and converter to reflect #46 May 23, 2026
Comment thread docs/describing_runs.rst Outdated
Comment on lines +32 to +33
Note that the component is designated by the name of the top-level model, followed by
the component name.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is a bit confusing to me. Perhaps the following is better?

Suggested change
Note that the component is designated by the name of the top-level model, followed by
the component name.
Note that the component is indicated by the name of a model, followed by
the component name inside the model.

Though I'm not sure if this is correct for submodels. E.g. if I have model A with components c1 and c2. If c2 is submodel B with components c3 and c4, then what do I need to put here for c3?

  1. B.c3 (per my suggestion)
  2. A.c3 (per your description)
  3. A.c2.c3 (nested components)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The third option is the correct one, so you always start from the top-level model and then describe the whole path. In principle option 1. could also be valid, but if that were the only way to do it then you wouldn't be able to give different resources for two different components that were each implemented by B.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a clarification, is this better?

I've kept "designate" over "indicate" because it more precisely matches the intended meaning.

@maarten-ic maarten-ic linked an issue May 26, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Collaborator

@maarten-ic maarten-ic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM!

@LourensVeen LourensVeen merged commit b95fde3 into develop Jun 1, 2026
15 checks passed
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

Successfully merging this pull request may close these issues.

Update documentation for changed resource requirements

2 participants