- changed status to resolved
Patch property inputs in example scripts
Issue #3
resolved
I really like seeing how the input files are constructed in the test scripts, along with running the code and plotting the results. However, I am ambivalent about the awk command that produces the input for the patch properties. On the one hand, I like that it explicitly shows how to compute and construct the patch property input. That is very practically useful, and probably how I would do it myself.
On the other hand, I have two minor complaints about this as a user looking at it for the first time:
- I find it somewhat difficult to tell at a glance what exactly the input file should look like. I found myself copying this section of the script to print out and inspect the patch property inputs. Perhaps it would be helpful to make a version of an example script that has all of the inputs pre-loaded?
- The awk command is written to be compact rather than explanatory. I think for the example scripts, run*.sh, it would be great to make the operations inside the awk command more readable. For example, you could set each variable on its own line, add some comments for what the variables are, note what each block of code or calculation is doing, etc. In fact, by doing this, it might preclude my previous suggestion.
Comments (1)
-
repo owner - Log in to comment
fix
#3; add documentation in 3d tutorials→ <<cset 209dae4e8083>>