Latex Project Report Template

Hi,

I have made an Unofficial BE Project Report Template in latex for Pune University - PICT College.

Note :
1) For BTech CSE NIT Calicut Template, & Bharati Vidyapeeth’s College of Engineering for Women, Pune University Latex Template, check the references below.

2) This template is for preliminary report. If you are looking for Final BE Project Report check this post.

To use it in an easy way, you can go to this site. It's an online latex web application. Although I did it on my Fedora KDE 15 Desktop, but many people don't have Linux or the software, so this will work no matter what OS you have as long as you have the net connection.

1. Go to this site.
2. Sign up for an Account by clicking on Sign up on top right.
3. Choose Free account.
4. Enter all details and ready your account.
5. Once you are done, Select New Project
6. Choose the name project
7. Go to my Github repo here and download the repo as a zip file.
8. Once you have downloaded the file.Go back to the Scribtex and click upload file.
9. Select the file and select check box - This is a zip file and should be extracted
10. Upload the file.
11. Once uploaded, you will see a new folder being created with something like firesofmay-Latex-Template-XXXXX - rename that folder by hovering over it to project.
12. Above is a very important step Since I have added the path as project/file.tex in all the files, hence the change is required.
13. Go to settings of your project and in compiler settings enter project/report.  
14. report.tex is the main file (like main function in a c program). So we are telling the web app this is the file to start with.
15. Click save. Select Files, select project folder, you should see all the files being uploaded. It has one README file, one jpg (pict-logo.jpg) and a few tex files.

Now Modify the files as you need to for your report.
Few Notes :-

% is an equivalent to // in C i.e. % is a comment specifier till the end of line.

I have added comments to make it easy to understand what is going on.

\\ is an equivalent to \n in C. Note at some places you can't add \n just like that.

Start with report.tex file
report.tex includes these files in this order

1. title page - First Page- title.tex
2. cover page - Second Page - cover.tex
3. Index Page - Automatically Generated
4. List of Figures - Automatically Generated
5. Introduction page - Intro to your project - introduction.tex
6. Literature Survey page - All your IEEE survey - literature-survey.tex
7. Project Statement page - Problem Statement, Explanantion - project-statement.tex
8. System Requirements page - Use Case, DFD, Activity Diagram - sys-req.tex
9. Scheduling and Planning page - Your plans - planning.tex
10. References page - Your References - ref.tex

You can modify and add anything anywhere you like in above files.

report.tex does not need any modification in start. But read it to get an idea of what is going on. Once done reading report.tex, start with files in the above order and modify them and save them and continue with the next file.

Once you are done, Either go to main project folder and select "View as PDF" or goto any file and click on compile. It will generate the PDF file for you.

Iterate over your work, and your latex report should be ready in no time! :)

Note : It generates a clickable Table of contents and list of figures, references which is highlighted sometimes. but when you do print preview, it is not printed with a highlighted view, so don't worry if you see that, else ignore this tip.

Please Read the Documentation of Latex here or you can download the book from here. It's a free book by wiki community.

Major part of the latex has been done in this template, but every project has its own requirement, so modify as it suits you.

I don't know many things in latex myself. So instead of asking me, Google it, Read The documentation, or ask at the #latex IRC channel, that's how I have been able to figure out my problems and create this template for you guys :).

Also, note that to add more pictures, upload the file and update the picture place holders.

Also if you see something like this:-

\fontsize{12.6468mm}{1mm} \textbf{Project Group No - <<Group Number Here>>}\\[2cm]

Here, <<>> is a place holder for you to remove and add your own content.

So if your group number is lets say 21, it will become

\fontsize{12.6468mm}{1mm} \textbf{Project Group No - 21}\\[2cm]

Note Remove the << and >> also!!!

You'll see <<Some text>> at many places in tex files.
I have added them for you to know here's a place to start modifying!!

\\[2cm] means give newline and the next line has a gap of 2cm.

Use the documentation to search for exactly what you need.

NOTE FOR THOSE WHO ARE USING THIS TEMPLATE OFFLINE:-
Also, if you are going to use this inside a desktop environment let's say Linux and use the latex tool on your OS instead of this site, you have to update all  the paths specified from project/file to file

If something needs to be fixed, please let me know by leaving a message on my github account

Hope it helps.
Enjoy :)

References :-
I have used this guy's template and modified it to suit Pune Universities Latex Template.Thanks Kartik :)

Update 2: Kartik added a link back to this post on his blog post :)

Update 3: Avani Shah of Bharati Vidyapeeth’s College of Engineering for Women, Pune University also made a Latex template which is tailor made for her college. Here's the link.

Note - I am not responsible if your guide does not accept your report for any reason. Please consult your Guide before you use this template ;)

HTTP, Web Scraping and Python - Part 2

In Part 1, I talked about User Agents. Today we'll try to see what I said, is it actually true? i.e. Do servers really see that user agent value? Do they really identify you with it?


Last time we proposed this as a hypothesis, today we'll see if it's a fact or not? ;)

We'll do a little experiment. For this You'll need firefox. So swtich to firefox, if you haven't.

Now, Go to this url. It's an addon which allows you to switch User Agents. Just download and restart firefox.

Oye. Stop. Go and download that Plugin before you move on! Such a lazy person you are! :) Just kidding ;) (but you'll really learn a lot more if you do this)

Now Go to 

Tools > Default User Agent > Edit User Agents.

Select New > New User Agents.

Now fill in random crap in each text field. Yes you heard me. Fill all crap!! Utter nonsense, or write poetry.  At least Change the User Agent field.


Okay. Done? Select Okay. Okay.
Now go again to 
Tools > Default User Agent > And select the user agent you made.


Okay Done?


Now go back to this same page. Notice anything above? It says :- "To try the thousands of add-ons available here, download Mozilla Firefox, a fast, free way to surf the Web!"

Huh?? Download Firefox? But I am in firefox!!! :)
Okay cool.


Now go again to 

Tools > {Your User Agent Name} > And select the default user agent.

Now reload the Page again. Bam! That Banner is gone!!


It shows that the value of the User Agent String does matter, and that servers do read that value to identify who you are! Why is this important to know you'll see in the later part of the series...

Hence, Proved! :)

PS - This Idea came from a problem I had. From past few months my firefox was not being recognized by my gmail and it always use to go to default basic mode rather than standard mode. I tried googling for it, but I didn't understand what was going on, or what to search for! It was a weird problem! I knew about User Agents but it was all theory!! :) No practicals about it, hence it never clicked me, my user agent might be a problem!

While writting the part 1, i noticed the header value of User Agent String which was some rubbish and it just struck me!! I set it back to default and everything was fine again :)

Moral Of this Post - Don't just believe what You read anywhere, no matter who says it, try it out on your own and really test it before you believe it! Ask questions! Challenge what you learn! Learn the same thing in different ways. And you'll get awesome everyday :)

Have Fun! :)

References :-

• Add-On
• Switching Agents in other browsers
• Resetting User Agents in firefox

HTTP, Web Scraping and Python - Part 1

Today we'll see what is this Web Scraping. We'll also learn HTTP protocol but I promise i'll make it more hands on rather than all jargon which you can read online anyway :)

So what is this HTTP thing?

Simply put, it's how our computers (Clients) Talk to Big Computers (Servers) and get the cool stuff done for us.

So when you go to wiki and open a link, internally HTTP requests are made and that gets your page to your screen via browser.


Let's check how its done.
Goto this page and it loads up a wiki page. But what really happened? Here's a sample HTTP request that was made...

----------Request From Client to Server----------

GET /wiki/Python_(programming_language) HTTP/1.1
Host: en.wikipedia.org
User-Agent: Mozilla/5.0 (X11; Linux i686; rv:7.0.1) Gecko/20100101 Firefox/7.0.1
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-us,en;q=0.5
Accept-Encoding: gzip, deflate
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
Connection: keep-alive
Referer: http://en.wikipedia.org/wiki/Python
Cookie: clicktracking-session=QgVKVqIpsfsgsgszgvwBCASkSOdw2O; mediaWiki.user.bucket:ext.articleFeedback-tracking=8%3Aignore; mediaWiki.user.bucket:ext.articleFeedback-options=8%3Ashow

----------End of Request From Client to Server----------

----------Response From Server to Client----------

HTTP/1.0 200 OK
Date: Mon, 10 Oct 2011 12:44:46 GMT
Server: Apache
X-Content-Type-Options: nosniff
Cache-Control: private, s-maxage=0, max-age=0, must-revalidate
Content-Language: en
Vary: Accept-Encoding,Cookie
Last-Modified: Sun, 09 Oct 2011 05:01:32 GMT
Content-Encoding: gzip
Content-Length: 47407
Content-Type: text/html; charset=UTF-8
Age: 10932
X-Cache: HIT from sq66.wikimedia.org, MISS from sq65.wikimedia.org
X-Cache-Lookup: HIT from sq66.wikimedia.org:3128, MISS from sq65.wikimedia.org:80
Connection: keep-alive

----------End of Response From Server to Client----------

I have highlighted the important part of the request and response.

HTTP has several kinds of request out of which one is GET request. 

That's why we had this line below :-
GET /wiki/Python_(programming_language) HTTP/1.1




It says "Oye  you Big Computer (Server) GET me this python page whose address is /wiki/Python_(programming_language) and I am talking in language HTTP whose version is 1.1 and the website that i want is mentioned in Host Parameter (Below)"
Host: en.wikipedia.org 

You ever wondered how the websites know what browser you are using, what operating system you are using....? What happens is, when your browser makes a request, it adds to the request what is called as headers (Even the host parameter is part of header), One of the parameter - User Agent, specifies where the request is coming from. So here I am using Linux with Firefox version 7.0.1 (keeping it simple here)

User-Agent: Mozilla/5.0 (X11; Linux i686; rv:7.0.1) Gecko/20100101 Firefox/7.0.1 

I'll cover other things later in request (Cookies and stuff). In response we get

HTTP/1.0 200 OK
Server: Apache


Above simply means "Hey...Nice to see you again....Everything is fine :), i have done my job and btw I am Apache" 

(Ignore if you don't know what is apache)

So Let's fire this up in python and see how we can do this on our own....

Note Anything in the line (except the first line) with a # is a comment. I have made it Bold+Italic to highlight it. 

-----------http_Get_Request_1.py---------------  

#!/usr/bin/env python

#Python library for making HTTP connections/Requests
import httplib

#make connection with the host using http protocol with port 80
connection = httplib.HTTPConnection("en.wikipedia.org",80)

#make a GET request for the resource mentioned
connection.request("GET", "/wiki/Hello_world")

#Get the response and save it resp
resp = connection.getresponse()

#Print the Response and see the textual description of it
print resp.status, resp.reason

#Save the data
data = resp.read()

#write the html data to file
page = open("file.html", "w")
page.write(data)
page.close()

#Close the HTTP Connection

connection.close()

-------End of http_Get_Request_1.py--------------- 



If you run the above code you should get something like this
 
mankaj $ python http_Get_Request_1.py
200 OK
mankaj $ ls
file.html  http_Get_Request_1.py
mankaj $



You can see that you got a new file called file.html. If you open that file you can see that web page. Notice that pictures are missing. Does it give you any clue of how requests are made internally?? Any ideas???

All the requests are not made in one Go! It fetches the skeleton of the web page, and as it encounters (the browser) new links, it makes a seperate request for each picture. You might have known this, but now you saw it yourself :)

Let's wrap it up with one thing you might be wondering! How the hell I saw that HTTP request and response ?? :)

There is something called as LiveHTTPHeader . It's a Firefox Plugin which allows you to see What is happening Internally. (Other browsers might have something like this, just google for it). Just download it. and Restart your Firefox browser. Go to that wiki page. Once you are there. Go to Tools >  Live HTTP Headers. And reload the page. You can see all the requests made. Go to the top and you can see the first request made and later internal requests made to load the whole of page. Don't get confused. It's just to give you a taste of what is about to come in the next set of tutorials :)

Have Fun!! :)

Update : Read Part 2 here

References :-

• Atul Alex Cherian's Script (which I modified and used)
• Siddhant's PyCon Slides
• HTTP Definitive Guide (Amazing Book)
• Python For Newbies Video Series (Good if you don't know python at all!!)

Simple App on Google App Engine using Python

Hi,
Today we'll try to make a simple App on Google App Engine in Python which just says 'YourName Rulz!!' and we'll upload it on Google App Engine :)

To get what I am saying, goto this page and check it out :)


That's what we are going to make today. Isn't that cool! You are about to write your name in history! Well on the web and as long as the sever lasts but it still rocks! :)

Once you are done with this tutorial, you can try and solve this activity at reliscore - 
Google AppEngine using Python to see how much you really understood :)

Now what is Google App Engine? Simply, its a way to deploy your web apps and let google's infrastucture do all the hard work for you! It will do all the cloud computing *cool* stuff for you!

So Let's get started.

Go to this url and download the app engine for your OS. I am using Fedora 15 KDE for it. And I recommend you do start using linux if you haven't. Here's a link to my friend's blog post on Getting Started with linux . Its a tutorial for the absolute newbies.

Okay Back to the game. So now that you have downloaded it. For Windows/Mac please check the installations note.

For linux you just have to unzip the folder somewhere, lets say /home/yourusername/workspace/gapp

Fire up your terminals and move into the directory using cd command.
just in case you don't know



$ cd /home/yourusername/workspace/gapp


create a new directory called hello
and inside that directory
write a file called hello.py
and in that file
write these contents


------------hello.py------------
print 'Content-Type: text/plain'
print ''
print 'yourname Rulz'
------------X--X---------------


save it.
Note1 : Make sure you have an empty line After Content-Type else you will have issues.

Note2: Replace yourname with YOUR name :p ... Incase you haven't figured that out ;)

open another file and call it app.yaml
and write these contents

------------app.yaml------------
application: helloworld
version: 1
runtime: python
api_version: 1

handlers:
- url: /.*
  script: hello.py
------------X--X---------------





Note: Make sure url and script are aligned. I had issues when they were not aligned.

Basically, this is like the app configuration file. Simply put, this tells that the application name is helloworld (we will change this later, why we will see that), the version is 1, you are using python as a language. And the handlers just says simply right now is that whatever sub url you give, all will be handled by the script hello.py given by us. If you don't get it, its okay...

and save it.

to test it run this command

$ /home/yourusername/gapp/dev_appserver.py /homeyourusername/hello/ 

(Note: You don't need to give full path, but to keep it simple and universal, I am writing full path. You can write it whatever way you like as long as its correct.)

Once it works, open your favourite browser and check it aout! :)


http://localhost:8080/




Ta ra! :)

"Hey, but thats not deployed on the web" you say! Aye. That's Next ;)

Okay go to this site and login with your google account.

Once you are done, choose create application. Choose a nice "Application Identifier" as thats what you will be sharing it with others. In my case it was firesofmay

Fill in the Application title and let other things be default and click "Create Application".

Now go back to the hello folder and open up the app.yaml file and modify the
"application: helloworld" to whatever your application identifier was. In my case it was
"application: firesofmay"

Once you are done issue this command :)


$ /home/yourusername/workspace/gapp/appcfg.py update /home/yourusername/workspace/helloworld/




If you have done everything correctly you should see something like this as output...

-------------------------
Application: firesofmay; version: 1
Host: appengine.google.com

Starting update of app: firesofmay, version: 1
Scanning files on local disk.
Cloning 2 application files.
Compilation starting.
Compilation completed.
Starting deployment.
Checking if deployment succeeded.
Deployment successful.
Checking if updated app version is serving.
Will check again in 1 seconds.
Checking if updated app version is serving.
Will check again in 1 seconds.
Checking if updated app version is serving.
Completed update of app: firesofmay, version: 1
-------------------------

Open up your URL and check it out... isn't that super cool!! :)
It's time for you to go to your facebook and post some cool stuff online and show it off to your friends!

Here are the references :-

• Google App Engine - Intro
• Google App Engine - Basics
• Google App Engine - Hello
• Google App Engine - Uploading
• Google's Python Class
• Google AppEngine using Python - Problem Challenge @ Reliscore

I want to thank Navin Kabra, for being a great support and starting such a cool website - reliscore for programmers like you and me who love coding real world problems. And its a Kick Ass Website for those who wanna show off and get job for it too ;) Now Go and sharpen your coding skills on that website.

Cya :)