Skip to content

Suggested directory structure

Here is a suggested structure for the DRUM model repo:

tld
  |
  |- drum
  |    |- requirements.txt [IMPORTANT -- list package dependencies...kivy componenents, etc]
  |    |- setup.py
  |    |- drum.py
  |    |- sim
  |    |- inference
  |    `- gui
  |- data
  |- tests
  `- doc

Git branches should be used for adding new features. Suggested branches are:

  • master [full working code]
  • testing [branch for testing integration of sim, inference, and gui code prior to merging into master]
  • simulation [sim code working]
  • inference [fitting code working]
  • gui [graphical user interface working]

Chris

Edited by Chris Jewell