Big redesign to make self learning resource - Githubissues

drvinceknight / rsd

Repository for a two day workshop on research software development aimed at mathematicians

MIT License

0 stars 20 forks source link

Big redesign to make self learning resource #152

Open drvinceknight opened 4 years ago

drvinceknight commented 4 years ago

This will also allow the notes to be more comprehensive.

The syllabus will become something like:

Principles of reproducible computational research.

Discuss problems related to computational research
Discuss principles that provide solutions to the above

Using the command line

Using Python (although maybe there is no need for this chapter and can just point at other resources).

Writing software

Tools

Editors vs IDEs

What is good software?

Documentation
Modularisation
Testing (using a full testing framework)

Further concepts

Installation and packaging
Code convention testing
Type hinting
Coverage
Documentation with tools like Sphinx
Doctesting

Collaboration

Version control
Github
Continuous integration
Communication (video calling, messaging, working remotely)

Best practices with LaTeX

An appendix with other programming language tooling

drvinceknight commented 4 years ago

@geraintpalmer on slack mentioned:

semantic versioning

Should be part of installation and packaging.

citing software and citable software

Should be part of Collaboration

licenses

Further concepts

drvinceknight commented 4 years ago

Also include a list of other resources.

@geraintpalmer's Welsh language resources: https://sgiliauymchwilcyfrifiadurol.github.io
MIT's course: https://missing.csail.mit.edu