Firesong will generate a file called .Firesong.out (note the period at the start of the file name!), which is hidden by default in most GUI-based file managers. This is potentially very confusing to users.
Instead of simply changing the initial argument in this example (as well as the second example in the README), I would recommend improving the FIRESONG code itself to handle these file paths better (perhaps by using os.path.join() instead of string concatenation). That’s because '.' is such a common shorthand that people would likely use it even if it wasn’t given in an example.
[As part of the JOSS review.]
When using this sample code from the README file
Firesong will generate a file called
.Firesong.out
(note the period at the start of the file name!), which is hidden by default in most GUI-based file managers. This is potentially very confusing to users.Instead of simply changing the initial argument in this example (as well as the second example in the README), I would recommend improving the FIRESONG code itself to handle these file paths better (perhaps by using
os.path.join()
instead of string concatenation). That’s because'.'
is such a common shorthand that people would likely use it even if it wasn’t given in an example.