Re:Simple rules for documenting scientific software
by petschge on Saturday December 22, 2018 @05:42PM
(#18742912)
There is a wide difference between code that is pretty and code that is careful and written in a way that will not lead you astray. And if you don't know or don't care to make that distinction I am not interested in your opinion.
Re:Simple rules for documenting scientific software
by akiselev on Saturday December 22, 2018 @06:42PM
(#18743190)
> Articulating your thoughts into a sane logical structure (aka code), with sane names and motivation examples and conceptual units, saves you time even in the short run.
If you think he or she is only talking about pretty code, you don't understand the distinction to begin with.
Re:Simple rules for documenting scientific software
by chrisweekly on Saturday December 22, 2018 @07:33PM
(#18743505)
SOTA -- State of the Art?
I do hear this sentiment often: "Hey dudes, it's just a prototype! Why waste time making it pretty? Who cares? We're doing SCIENCE here!"
But prototypes (and beginnings in general) are precisely the time to be extra careful. Wrong turns and self-delusion are costlier, not cheaper, when you're the one paving the road for others.
In research, there are many ways to lead yourself astray, due to the inherent chaos of novelty, even without software bugs completely flipping the outcome. The idea that writing shitty code somehow "saves time" and is only worthwhile for the "17th javascript framework" has to go.
Articulating your thoughts into a sane logical structure (aka code), with sane names and motivation examples and conceptual units, saves you time even in the short run. Never mind 5 years. It also helps you avoid publishing unreliable, brittle, "SOTA" nonsense… of which there's sadly so much.