Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Big redesign to make self learning resource #152

Open
drvinceknight opened this issue Apr 20, 2020 · 2 comments
Open

Big redesign to make self learning resource #152

drvinceknight opened this issue Apr 20, 2020 · 2 comments

Comments

@drvinceknight
Copy link
Owner

drvinceknight commented Apr 20, 2020

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
Copy link
Owner Author

@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
Copy link
Owner Author

drvinceknight commented Apr 20, 2020

Also include a list of other resources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant