/
Homework 2 -- Good Enough Practices

Homework 2 -- Good Enough Practices

Learning Outcomes

  • Good Enough Practices in Scientific Computing

  • Team Science: Soft skills are just as important as technical skills

  • Project organization

Good Enough Practices in Scientific Computing

Remember to finish Homework 1:

Read this paper: https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005510

  • Refer to Box 1.  Choose one sub-item under each of the following:

    • Data management

    • Software

    • Collaboration

    • Project organization

    • Keeping track of changes

    And briefly describe why the sub-item is important

    • Example:  Collaboration - Decide on communication strategies.  Most projects have more than one person involved.  Since people are often working asynchronously, it is important that there are several ways they can communicate, depending on the requirements of the discussion and the timeliness of the response.  It is important for the team to decided how to communicate so that messages aren't missed.  Common examples that are frequently used today would be Slack for most back-and-forth questions and discussion, phone calls for an in-depth conversation, and GitHub issues for tracking and commenting on software bugs, enhancements, and other requests.

  • Refer to Box 3, using any project you have done in the past (for a class, research or fun, or make one up) apply recommendations from Box 3 to it and:

    • Create this or a similar directory structure with mock-files on the command-line. 

    • Take a screenshot to turn in on your wiki page.

    • Choose a real software license and describe why you chose it

    • Create the README file for you project and take a screen shot of its contents and describe why this is an important file to have with such projects

  • Create a sub-page under this page for your homework and name it "Homework 2 - <your name>