Good Programming Hints

Things you should remember to do…

  • If you make a plot with depth.  Depth should be on the y-axis increasing going down.
  • If you are showing a correlation
    • put in the correlation line and the statistics
    • make the graph square or close to square
  • Add markdown to all your notebooks.  Use different headings to make it look good.
  • Once you are done debugging remove any extra print statements to make the code streamlined.
  • add comments to your code.
  • Add your name to your notebooks in markdown.  Plus add the assignment.
  • Good programming is hard work.  Work hard and you can do it.
  • With hard work and diligence you can do it!
  • For every figure you need a figure caption.  Then for every figure you need to describe the result in markdown. I will post sample figure captions.
  • Every Axis needs a title and a unit.  A figure without units is useless.
  • When handing in an ipython notebook make it nice.  Get rid of boxes you don’t need. Combine boxes into one to make it work well.  It should be easy for you to re-run an ipython notebook.  Do not leave lots of not needed code cells around after you have it working.

Leave a Reply