BONSAMURAIS / reproducibility

Work space for the reproducibility working group for BONSAI hackathon2019
0 stars 0 forks source link

Monitor source management practices of other working groups #7

Open bkuczenski opened 5 years ago

bkuczenski commented 5 years ago

On the front of "technical reproducibility", we want to ensure that the code we write is operable on other people's machines. For that, in the absence of a clear standard we are adopting a subset of these ten simple rules for making research software more robust.

There is a handy summary of these in a checklist which I have added to the repo here.

For the hackathon we need to select a subset of these rules and review the work of the other groups to ensure they are compliant. We can attain compliance either by nudging other participants, or by doing the work ourselves. TBD.

mfastudillo commented 5 years ago

the rules make sense to me. About documenting code. I think each function should have also a basic documentation. (what it is supossed to do, what are the arguments and expected outputs).