HomeCoding Guidelines

Coding Guidelines

Follow the below mentioned guidelines strictly. Failure to do so might result in rejection of your work.

  1. You should use any of the following FOSS – OR Tools like Scilab, Python, SimPy, GLPK etc.,
  2. The code should follow the naming convention as given below, the codes will not be approved if the naming convention is not followed as instructed. For example, 3rd solved example from chapter 1 (Example 1.3) should be represented by code named as Ex1_3.For textbooks using python/simpy codes use ipython notebook, Save all the codes in each chapter as separate notebook. The first line of each notebook should specify the textbook title, chapter number, and chapter title. Previous line of each example code should be the example number (Example 1.3).
  3. Do not submit separate codes for various sub problems of a particular solved examples. For example, only a single code Ex5_4.sce (containing answers to all 3 subparts) should be submitted instead of submitting 3 separate codes Ex5_4_a.sce, Ex5_4_b.sce and Ex5_4_c.sce.
  4. The dependencies on other codes/functions (if any) should be mentioned as a comment clearly before starting the code.
  5. If the textbook contains error in calculations/results, mention the same as a comment at the end.
  6. Please do not include problem statement/text from the book in the code.
  7. All the outputs must be displayed in appropriate format (along with units mentioned).
  8. Appropriate comments should be put up, which will make the code easily understandable. The comments should help in highlighting the flow of logic being used.
  9. The plots must have appropriate labels on its axes.
  10. Once you have completed the coding, mail us at or_tbc [at] fossee [dot] in with complete details including your name and alloted book.