Welcome to CS101 Project (2015): Numerical Integration solution¶
This documentation is an example of an automatically generated documentation for a Python programming project.
Todo
Conclude this index page!
Todo
Explain a little bit how it was created.
Contents:¶
Readme¶
This Python 2 project gives an (almost) complete solution for the CS101 programming project, subject #5, about Numerical integration. This project took place at Mahindra Ecole Centrale in April 2015.
Inside this directory, you will find two Python files (integrals.py and tests.py).
Other files¶
Please read:
- INSTALL.txt for details about using or installing these files,
- the report, Numerical_Integration__Project_CS101_2015.pdf, gives more details about the Python programs, and theoretical explanations about the algorithms we decided to implement, and more small things.
- AUTHORS.txt gives a complete list of authors,
- TODO.txt gives details about un-finished tasks, if you want to conclude the project yourself.
- LICENSE.txt for details about the license under which this project is publicly released,
—
About this file¶
It quickly explains what your project was about. It should sum up in a few lines what was the task, and how you solved it.
Imagine that someone downloaded your project and want to understand it, well then this file should be as helpful as possible (while not being too long or verbous). It should be the starting point for a new user.
How to use this project¶
This project does not require any extra modules. It needs Python 2 (v2.7 or more recent).
Each of the 2 programs can be executed directly from the command line environnement, either with python or with ipython, or within Spyder (or any IDE). They should work out-of-the-box, without any user interaction.
—
About this file¶
It quickly explains how to use your project. Any required modules/packages have to be specified here, and if one of your program expect an input from a user, please say it so here.
Imagine that someone downloaded your project and want to use it, well then this file should be as helpful as possible (while not being too long or verbous).
License¶
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE Version 2.1, April 2015
Copyright (C) 2015 Lilian Besson <lilian.besson at crans dot org>
Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.
“DO WHAT THE FUCK YOU WANT TO PUBLIC” LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
- You just DO WHAT THE FUCK YOU WANT TO.
Things to do for this project¶
This project is entirely concluded, there is nothing else to do.
—
About this file¶
In case that some part of your project is not done (not completed yet), you can explain here what still has to be done.
Imagine that some other team would have to work on your project, and conclude it, well then this file should be as helpful for them as possible (while not being too long or verbous).
Authors¶
Lilian Besson, 14XJ00999, lilian.besson at crans dot org
—
About this file¶
It has to contain a list, line by line, of each member of your team, following this format: Name, Roll#, email ID. Adding your name and personal information in this file is like signing numerically: it proved that you participated.
Documentation for the integrals module¶
This module integrals defines all the integration functions required for the project. Below is included an auto-generated documentation (from the docstrings present in the source file).
—
Documentation for the tests script¶
This script tests tests all the integration functions required for the project (written in integrals.html). Below is included an auto-generated documentation (from the docstrings present in the source file).
—
Indices and tables¶
Copyrights¶
Lilian Besson, 2015.