Copy simulation_inputs | add docs #261
Conversation
docs/source/workloadConfig.rst
Outdated
| simulation_outputs | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
| A list of simulation output files to copy after running firesim. Each path | ||
| should be absolute with respect to the `sim_slot_*` directory. |
There was a problem hiding this comment.
- Nit: FireSim instead of firesim.
- I think this documentation exposed something I didn't see before. Right now sim. inputs are from the marshal root directory. However, I think there might be cases in the future where things are taken from the
workdir(relative to theworkdir). I think a good extension of this would be to enable inputs from multiple sources: 1. relative to the marshal root directory 2. relative to theworkdir3. absolute path to anywhere. To DRY this out there can be a shared func that takes list of locations to look for, list of files to find (both absolute and relative) and returns the absolute paths of all files. Then you can take the output of this function to pass into some copy loop (and/or error).
There was a problem hiding this comment.
- Nit: We should probably have a new section/header of the docs with simulator-specific flags.
There was a problem hiding this comment.
Do you think the workdir thing will be okay in cases when the user specifies a filename & there are multiple files within the search scope with the same name?
There was a problem hiding this comment.
I think if there are multiple files then there should be an error instead of silently resolving to a specific file.
There was a problem hiding this comment.
I'll get back to this a bit later :)
There was a problem hiding this comment.
My impression of the path thing is that the user should know & specify the path marshal should search for each input file. So instead of searching for random locations, shouldn't we group each input file by the base path we want to search for?
Something like this?
"simulation_inputs" : {
"marshal" : [ "input1", "input2"],
"workload" : [ "input3", "input4"]
}
There was a problem hiding this comment.
I think this adds more verboseness to the file than needed.
Maybe we can simplify this to be... search in:
- image dir that is generated for the workload
- work dir that is specified
- absolute paths
Why do you need access to the top-level marshal dir?
There was a problem hiding this comment.
I don't need access to the top-level marshal dir. Rather, I thought it would be cleaner to explicitly specify where to copy files from & for consistency in the above example. I guess, I kind of don't like the idea of searching for files for a set of relative paths. I think absolute paths would be great though. I guess I can search through those structures though :)
Address comments on #260.
simulation_inputsinto the workload slot directory.