Skip to content

Project Outline

Zong Huang edited this page Dec 10, 2018 · 25 revisions

To-dos

  • Make error handling as robust and user-friendly as possible
  • Add functionality to inputs.txt that checks inputs have an unmodified git status and give friendly warning if check fails
  • Create more detailed example scripts for template
  • Have lab members test template (on different computing environments) and try to break it
  • Write README.md and add user guides where appropriate
  • Refactor tablefill and textfill

(Previous notes)

  • simplify make logging functions so log argument is passed explicitly to builders
  • errors in make.py not reported to stdout; program just stops working
  • change make.py so can be run from any directory -- just define directory root path at top

get_inputs

  • should delete any files in /input/ that are not in inputs.txt
  • create symlinks for repo files
  • use yaml paths for

setup.py

  • Install python tools
  • Set and check executables (issue warnings not errors)
  • GSLab Python version

config_global.yaml

  • program requirements

config_user.yaml

  • external storage locations

See also "MG Template Notes" in Evernote.

See also Hunt's RA manual here

Clone this wiki locally