Skip to content

Development Guidelines

subokita edited this page Jul 17, 2014 · 1 revision
  • Try to keep codes clean, simple and readable. Richard Feynman once said that for any topic to be considered as properly understood, it must be explainable to and understable by college freshmen.
  • It's 2014, variables named like dxdylam can be quickly and easily renamed in the scope to dx_dy_div_lambda. Keep it readable
  • Make it run correctly first, optimization can come later.
  • Object oriented, it's okay to take some performance hit, for the sake of readability and ease of extension.
  • PrettyPrinter.py, can be used to generate small amount of the boiler codes, and also to pretty print data members, and some of the functions. Use it to create clean organised code

To be elaborated

Clone this wiki locally