Skip to content

Preparation prior to JOSS submission

Broncio Aguilar Sanjuan edited this page Mar 23, 2021 · 12 revisions
  • Edit README file. Take the README.Rmd file from https://github.com/WyLyu/UPOsHam and modify it accordingly to preserve the overall format.

  • Convert Examples.ipynb notebooks to .rst files for documentation. Try nbconvert - assignees: Broncio and Victor

  • Schedule a 3-5 day sprint event with the whole group for continuous feedback and modifications to the code. Date: mid to late March.

CODE SPRINT

  • 4hrs, 5 days. Weekend in between.

March 2021

  • 23 (Morning, 9.30am),
  • 24(Afternoon, 1.30pm)
  • 25 (Morning, 9.30am)
  • 30 (Morning, 9.30am)
  • 31 (Afternoon, 1.30pm)

Outline

30min before, 30 mins by the end.

Make a list of objectives updated daily. PROCEDURE.

Split into teams to work on tasks. TESTING, DOCUMENTATION, ARTICLE WRITING - JOSS SUBMISSION (Purpose of sprint)

CHANNEL OF COMMUNICATION.

Microsoft Teams. Stay live for the 4-hr duration, available for discussions, questions, updates.

NOTES

  • The objective of the code (to be emphasised): Software produced for reproducibility of published results by members of the CHAMPS group.