polishing the run system #113
Merged
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
only works for Worker, Pre- and Postprocessor only works for very simple functions requiring no handle_config Todo: documentation / examples
Allow independent variables in the output read with numpytxt specified as f(t) vector or matrix output has to be in the output in the right order specifying the order of variables is still possible support almost all arguments for numpy.genfromtxt (e.g. different delimiter)
- new directive `autoraw` to show only docstring of class or method - all components of the run system except for the SlurmRunner - small fixes
|
I've tried documenting the components of the run system directly where their respective options are and I think this is better than the table. If we want to keep the table, we could try linking the table to the more detailed descriptions. As a side note: the detailed description from each component is pulled from the docstring, so there should be less duplicate documentation required. Here is a comparison:
|
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.
Worker,Preprocessor,Postprocessor)NumpytxtPostprocessordeveloper documentationLocalRunnerwith config optionparallel: allshould default to the number of available cores (Fix Check number of cores #29)