Commit 5f1821fd57bb141d294d366e5617ede3a527a08c

Authored by Jean-Pierre Auclair
1 parent 6a7e91d1
Exists in master

Added notes from the code automation session

Showing 1 changed file with 36 additions and 1 deletions   Show diff stats
README.md
... ... @@ -138,4 +138,39 @@ Git manages:
138 138  
139 139 References:
140 140 - Pro Git
141   -- Git From The Bottom Up
142 141 \ No newline at end of file
  142 +- Git From The Bottom Up
  143 +
  144 +## Code Automation
  145 +
  146 +Computers are good for tedious, error-prone, complicated and/or repetitive tasks.
  147 +
  148 +Applicable to:
  149 +- Version control
  150 +- Back ups
  151 +- Model management
  152 +- Visualization
  153 +- Code
  154 +- Manuscripts
  155 +- Pre/Post-processing tools
  156 +
  157 +Assignement: Create a note repository, host, share and write down after each session
  158 +
  159 +**Your most important collaborators are your past and future selves**
  160 +
  161 +Separate code repo from:
  162 +- Big binary files (Version control software would just make a copy)
  163 +- Source code (to update model source code more easily/differentiate files that have been changed)
  164 +
  165 +**History is messy. It's better to see the whole history than to see a pretty history.**
  166 +
  167 +Readme files are important for new users and collaborators, including your future self.
  168 +
  169 +Use scripts, not GUIs, to automate
  170 +
  171 +Jupyter notebooks are great for demonstration and documentation
  172 +
  173 +`tree` shows ASCII art of a directory tree (https://www.phys.ocean.dal.ca/~jpaucl/pmwiki.php/Bash/Tree)
  174 +
  175 +More info at: https://bitbucket.org/douglatornell/uqar-winter-school
  176 +
  177 +Exercise: Basic code automation: Using python, write a script that handles arguments, creates directories and moves/renames files.
143 178 \ No newline at end of file
... ...