Update documentation to use new operation.with_directives decorator #128
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
b-butler
requested review from
atravitz and
Tobias-Dwyer
and removed request for
a team
12 tasks
|
@atravitz and @Tobias-Dwyer will you guys have time to look at this sometime next week? We just merged glotzerlab/signac-flow#502 and this goes with that. |
kidrahahjo
approved these changes
May 21, 2021
bdice
requested changes
May 21, 2021
Co-authored-by: Bradley Dice <[email protected]>
bdice
requested changes
Jun 8, 2021
Comment on lines
261
to
266
| .. code-block:: python | ||
|
|
||
| @FlowProject.operation | ||
| @FlowProject.operation.with_directives({"np": 2}) | ||
| @flow.cmd | ||
| @flow.directives(np=2) | ||
| def hello_mpi(job): | ||
| return "mpiexec -n 2 mpi_program {job.ws}/input_file.txt" |
There was a problem hiding this comment.
Is this example still useful, or should we recommend the user to use the nranks directive and adapt the command to remove mpiexec?
There was a problem hiding this comment.
This whole section on MPI is out of date and actually would likely not work given the submit -> run -> exec model. However, I don't know if it is in scope to modify this in this PR.
@kidrahahjo Did you want to make this PR? Thanks! |
bdice
approved these changes
Jun 9, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This changes the documentation to use the
FlowProject.operation.with_directivesdecorator overflow.directives. This is to teach a more coherent syntax withFlowGroupEntry.with_directives.Motivation and Context
Is the corresponding documentation PR for glotzerlab/signac-flow#502.
Checklist: