Procedure and Cheklist

Procedure

 

  1. The codes to be reviewed have already been checked for syntax related errors.
  2. You are required to verify the results of ALL the submitted codes by comparing the outputs (given in the log file) with the actual solution from the textbook.
  3. You need to ensure that the codes and/or the results meet the quality standards as per the checklist.
  4. The verification should not take more than a week for every review of the assigned TBC.
  5. After the review is completed the review comments should be submitted here. We have provided a template for your reference while reviewing the books.
  6. You may need to carry out subsequent reviews (not more than 4 per textbook companion) in order to complete the verification after the codes have been corrected by the intern.

 

Honorarium

 

  1. Reviewers who successfully finish the textbook companion review as per the specified procedure will be awarded an honorarium of ₹ 2000/- for each book.

 

 

Checklist

 

  1. The codes should follow the naming convention as given below,
    For example, 3rd solved problem from chapter 1 (Example 1.3) should be represented by code named as Ex1_3.sce.
  2. The codes should not be submitted  as subproblems.
    For example, only a single code Ex5_4.sce (having  3 subparts) should be submitted instead of submitting 3 separate codes Ex5_4_a.sce, Ex5_4_b.sce and Ex5_4_c.sce for the 3 subparts.
  3. The dependencies on other codes/functions (if any) should be mentioned as a comment clearly before starting the code.
  4. If the textbook contains error in calculations/results, it should be mentioned as a comment at the end.
  5. Below convention for naming file should be followed
    (a) Use of .sce extension for main files
    (b) Use of .sci extension for dependency
  6. Problem statement/text from the book, should not be included in the code.
  7. Appropriate comments should be written, which will make the code easily understandable.
    For example, the equation like R = V/I can have comment as "Ohm's Law" along with it.
    The comments should help in highlighting the flow of logic being used.
  8. All the plots must have appropriate labels on its axes.
  9. The symbols used in the code should be same as those being used in the textbook.
  10. Check for using correct formulae while using in-built functions (For example, the angles must be converted to degree (or radians) before calculating the sine or cosine etc).
  11. Check for the typographical errors.
  12. No examples with numerical solutions should be skipped.
  13. Make a check whether textbook has examples solved in Matlab and report to us.
  14. Check if the output of the codes is generated by logical statements and by using Scilab functions instead of simply printing the results from the book as output (ensure that the answers are not hard coded).
    For example,

    Code 1:
    radius = 7; \\ radius of circle in cm
    area = %pi*(radius)^2; \\ calculation of area of circle in cm^2
    disp (area, “The area of the given circle is = %f cm^2”)

    Code 2:
    radius = 7
    printf (“The area of the given circle is 184 cm^2.”)

    Here Code 1 is a valid code and should be approved, however Code 2 simply displays the output without any logical calculations and hence should not be approved.
     

  15. There might be slight error in the results generated by Scilab code when compared to the answers given in the textbook. This error is caused by rounding off answers in the intermediate steps. The errors up to +/- 1% of the output can be ignored and the output can be considered as correct.
    For example, if the answer given in the textbook is 100 cm then any answer between 99 cm to 101 cm can be considered as correct.