diff options
Diffstat (limited to 'tbc/static')
| -rw-r--r-- | tbc/static/templates/guidelines.html | 33 | ||||
| -rw-r--r-- | tbc/static/templates/how.html | 6 |
2 files changed, 24 insertions, 15 deletions
diff --git a/tbc/static/templates/guidelines.html b/tbc/static/templates/guidelines.html index 8555b44..6d283b4 100644 --- a/tbc/static/templates/guidelines.html +++ b/tbc/static/templates/guidelines.html @@ -1,14 +1,23 @@ -<h4>Guidelines for Coding</h4> <ul> - <li>Strictly use Python 2.7.X version for coding</li> - <li>IPython Notebook version 1.1.0 or higher should be used (which supports user input)</li> - <li>Each chapter should be an individual IPython Notebook</li> - <li>Do not copy problem statement from the Textbook in the code (write it in your own words)</li> - <li>Round-off the final answers according to the textbook</li> - <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> - <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> - <li>All the plots must be named and have appropriate labels on its axes</li> - <li>The symbols used in the code should be same as those being used in the textbook</li> - <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.)</li> - <li>Material of any kind (pdf of book or image of a certain page) will not be provided to the participant. It is the participant's responsibility to arrange for the same.</li> + <li>Strictly use Python 2.7.X version for coding + <li>IPython Notebook version 1.1.0 or higher should be used (which supports user input) + <li>Each chapter should be an individual IPython Notebook + <li>A notebook should start with Chapter number followed by chapter name which should be in font size of ‘heading 1’ available in IPytho Notebook + <li>The above point should be followed by a cell which consists of Example number and the page number which should be in font size of ‘heading 2’ available in IPytho Notebook + <li>Same variables should be used in the codes as given in the textbook. In few cases, if this point doesn’t hold true, then the contributor may use any variable of his/her choice but an appropriate comment is necessary giving a description of the quantity. + <li>Libraries must be imported in all examples. Import specific libraries only and avoid import *. + <li>Round-off the final answers according to the textbook + <li>All the calculations must be performed 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 plots/graphs should not open in a separate window; rather they should be a part of the output. A command ‘%pylab inline’ does the work. + <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.) + <li>The codes should follow the naming convention as given below, for example, For chapter number 4, the file name must be chapter4.ipynb + <li>The codes will not be approved if the naming convention is not followed as instructed. + <li>If the textbook contains error in calculations/results, mention the same as a comment at the end. + <li>Do not include problem statement/text from the book in the code. + <li>All the outputs must be displayed in appropriate format (along with units mentioned). + <li>Material of any kind (pdf of book or image of a certain page) will not be provided to the participant. It is the participant's responsibility to arrange for the same. </ul> diff --git a/tbc/static/templates/how.html b/tbc/static/templates/how.html index 2dcf5c0..a235f6a 100644 --- a/tbc/static/templates/how.html +++ b/tbc/static/templates/how.html @@ -14,7 +14,7 @@ <ol> <li>Make sure that the <b>proposed book has at least 60 solved examples</b> which can be coded in Python. <li><b>Exclude theoretical examples</b> such as derivations or problems which have no scope of computation. - <li>The examples must be intricate with proper usage of libraries and scientific tools and not just calculations. Please have a look at this book. + <li>The examples must be intricate with proper usage of libraries and scientific tools and not just calculations. Please have a look at <a href="http://tbc-python.fossee.in/book-details/318/" target="_blank">this book</a>. </ol> <li>Reviewer will review the proposed books & select the appropriate one. Contributor at this stage will be asked to <a href="http://tbc-python.fossee.in/submit-sample">submit sample IPython notebook</a> i.e. solved examples from any one chapter as an IPython Notebook. Kindly refer to the <a href="http://tbc-python.fossee.in/sample-notebook/" target="_blank">Sample IPython Notebook</a>.</a> Please follow proper naming conventions while uploading the sample notebook. Ex.: Chapter 4: Principles of Steady-State Heat Transfer. <li>Reviewer will review the sample notebook and if not satisfied, the contributor will be notified to make necessary corrections and send the sample notebook again. @@ -23,5 +23,5 @@ <li>Once the contributor finishes coding all the solved examples of the book, the codes can be submitted <a href="http://tbc-python.fossee.in/confirm-book-details">here</a>. Please follow naming conventions while uploading the book. Ex.: Chapter 4: Principles of Steady-State Heat Transfer. <li>The review of the book will typically take approximately 25 working days to finish & the contributor will be notified if ther are any corrections required. Each time the codes are submitted, it will be queued up with other review requests and will result in subsequent delays. When no more corrections are required, the book is termed as completed and the contributor will be notified to fill the <a herf="http://tbc-python.fossee.in/internship-forms/">Internship Forms</a> <li>Duly filled internship forms have to be submitted at address mentioned here. Honorarium will be processed only after the forms are received. - - Note: The Submit Book(OLD) is the link for only those contributors who had proposed books earlier through mail and now are uploading for publishing. + <li><b>Note: The Submit Book(OLD) is the link for only those contributors who had proposed books earlier through mail and now are uploading for publishing.</b> +</ul> |