summaryrefslogtreecommitdiff
path: root/tbc/static/templates/guidelines.html
diff options
context:
space:
mode:
authorhardythe12014-02-17 14:26:10 +0530
committerhardythe12014-02-17 14:26:10 +0530
commit1ee18ffe1a565be635a403dedf520380834f17fb (patch)
tree4e0432ffb6bfcc1e924f76b6f3fc3b1dd3a1b6ce /tbc/static/templates/guidelines.html
parent31fcbed913904e9331e21c55ff2dc9ca80831537 (diff)
downloadPython-TBC-Interface-1ee18ffe1a565be635a403dedf520380834f17fb.tar.gz
Python-TBC-Interface-1ee18ffe1a565be635a403dedf520380834f17fb.tar.bz2
Python-TBC-Interface-1ee18ffe1a565be635a403dedf520380834f17fb.zip
changing About TBC according to the new write up
Diffstat (limited to 'tbc/static/templates/guidelines.html')
-rw-r--r--tbc/static/templates/guidelines.html12
1 files changed, 12 insertions, 0 deletions
diff --git a/tbc/static/templates/guidelines.html b/tbc/static/templates/guidelines.html
new file mode 100644
index 0000000..5b97bf1
--- /dev/null
+++ b/tbc/static/templates/guidelines.html
@@ -0,0 +1,12 @@
+<ul>
+ <li>Strictly use Python 2.7.X version for coding
+ <li>IPython Notebook version 1.1.0 should be used (which supports user input)
+ <li>Each chapter should be an individual IPython Notebook
+ <li>Do not copy problem statement from the Textbook in the code (write it in your own words)
+ <li>Round-off the final answers according to the textbook
+ <li>Do not use reference Figures/Diagrams given in the book anywhere in your code. All the outputs must be displayed in appropriate format (along with units mentioned)
+ <li>Appropriate comments should be put, 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.
+ <li>All the plots must be named and have appropriate labels on its axes
+ <li>The symbols used in the code should be same as those being used in the textbook
+ <li>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.)
+</ul>