I am creating this issue under the label "Help Wanted" because I am not sure what to put it under, but I want to suggest some documentation changes. I could handle these changes myself, I just would need to be pointed to documentation highlighting how to update docs.
From personal experience experimenting with JSON simulation configurations with SST, the following changes would enhance both clarity and ease-of-use for any future SST user.
- For the JSON Simulation Configuration doc: adding an example on how to output JSON configuration files with SST by using the flags
--output-json and --parallel-output=true. I am envisioning a single rank example and then a multiple rank example that explains how --parallel-output works for both runs with multiple ranks and possibly runs with multiple threads.
- Another good highlight would be to specify when during the lifecycle of an SST simulation is the JSON outputted. Is it between init and setup, after setup before the simulation, or after the simulation ends?
- For the How to Run SST doc: updating the
sst --help snippet to better reflect the current --help output. For example, in the doc the option --parallel-output is missing.
- For the
SST_ELI_DOCUMENT_PARAMS doc: the optional default_value parameter is misleading as it makes it seem that the macro will automatically add a default value to component. A note should be added that the default value needs to be handled by the component author as specified in the comments of the following basic parameter examples: basic_params.h and basic_params.cc.
I am creating this issue under the label "Help Wanted" because I am not sure what to put it under, but I want to suggest some documentation changes. I could handle these changes myself, I just would need to be pointed to documentation highlighting how to update docs.
From personal experience experimenting with JSON simulation configurations with SST, the following changes would enhance both clarity and ease-of-use for any future SST user.
--output-jsonand--parallel-output=true. I am envisioning a single rank example and then a multiple rank example that explains how--parallel-outputworks for both runs with multiple ranks and possibly runs with multiple threads.sst --helpsnippet to better reflect the current--helpoutput. For example, in the doc the option--parallel-outputis missing.SST_ELI_DOCUMENT_PARAMSdoc: the optionaldefault_valueparameter is misleading as it makes it seem that the macro will automatically add a default value to component. A note should be added that the default value needs to be handled by the component author as specified in the comments of the following basic parameter examples:basic_params.handbasic_params.cc.