Guidelines for Coding
All the guidelines should be followed without fail for timely acceptance of code and award of internship. Failure to do so might result in rejection of your work.
- Strictly use Scilab-5.4 and above for coding.
- Please ensure that there are no Matlab codes in the proposed book.
- The codes submitted by the contributors should not have Matlab codes.
- If Matlab codes are found in your submitted work, during any stage of the TBC review, the intern-ship allotted will be cancelled. Honorarium and certificate will not be provided in such cases.
- The codes 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 problem from chapter 1 (Example 1.3) should be represented by code named as Ex1_3.sce.
- 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.
- The dependencies on other codes/functions (if any) should be mentioned as a comment clearly before starting the code.
- If the textbook contains error in calculations/results, mention the same as a comment at the end.
- If the degree of error is less than +/- 2 then "The answers vary due to round off error" must be mentioned as a comment.
- If the degree of error is more than +/- 2 then "The answer provided in the textbook is wrong" must be mentioned as a comment.
- Follow the convention mentioned below for uploading files:
(a) Use .sce extension for main files
(b) Use .sci extension for dependency
- Do not include problem statement/text from the book in the code.
- All the outputs must be displayed in appropriate format (along with units mentioned).
- 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. For example, the equation like R = V/I can have comment as "Ohm's Law" along with it.
- All the plots must have appropriate labels on its axes.
- The symbols used in the code should be same as those being used in the textbook.
- 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).
- Once you have completed coding, mail us at firstname.lastname@example.org with complete details including your name and allotted book.