template project report

8/2/2019 Template Project Report

1/28

WRITE YOUR PROJECT TITLE HERE

STUDENT NAME 1

STUDENT NAME 2

STUDENT NAME 3

July 2006

Department of Electrical Engineering

COMSATS INSTITUTE OF INFORMATION TECHNOLOGYLAHORE PAKISTAN

Font: Impact

Size: 24

Font: Times

Size: 16

Font: Arial

Size: 14


2/28

Submission Form for Final-Year

PROJECT REPORT

PROJECT IDNUMBER OF

MEMBERS

TITLE

SUPERVISOR NAME TERNAL / EXTERNAL

MEMBER NAME REG. NO. EMAIL ADDRESS

CHECKLIST:

Number of pages in this report

I/We have enclosed the soft-copy of this document along-with thecodes and scripts created by myself/ourselves

YES / NO

My/Our supervisor has attested the attached document YES / NO

I/We confirm to state that this project is free from any type of

plagiarism and misuse of copyrighted materialYES / NO

MEMBERS SIGNATURES

Supervisors Signature

Note 1: This paper must be signed by your supervisorNote 2: The soft-copies of your project report, source codes, schematics, and executables should be delivered in a CD

COMSATS Institute of Information Technology, Lahore Campus Department of Electrical Engineering


3/28

This work, entitled Insert Project Title Here has been approved for the

award of

Bachelors in Electrical Engineering

Date

External Examiner:

Head of Department:

Department of Electrical EngineeringCOMSATS INSTITUTE OF INFORMATION TECHNOLOGY

LAHORE PAKISTAN


4/28

Declaration

No portion of the work referred to in the dissertation has been submitted in support of an

application for another degree or qualification of this or any other university/institute or

other institution of learning.

MEMBERS SIGNATURES

ii


5/28

Acknowledgements

It is usual to thank those individuals who have provided particularly useful assistance, technical or otherwise, during your project.

Your supervisor will obviously be pleased to be acknowledged as he or she will have invested quite a lot of time overseeing your

progress.

In the name of God, the most kind and most merciful

I would like to thank who kept backing me up in all the times,

both financially and morally

I would also like to thank for his guidance and encouraging me to

work hard and smart. I have found him very helpful while discussing the optimization issues in

this dissertation work. His critical comments on my work have certainly made me think of new

ideas and techniques in the fields of optimization and software simulation.

I am grateful to the God Almighty who provides all the resources of every kind to us, so that we

make their proper use for the benefit of mankind. May He keep providing us with all the

resources, and the guidance to keep helping the humanity.

iii


6/28

Abstract

The abstract is a very brief summary of the report's contents. It should be about half a page long. Somebody unfamiliar with your

project should have a good idea of what it's about having read the abstract alone and will know whether it will be of interest to them.

iv


7/28

Table of contents

WRITE YOUR PROJECT TITLE HERE.....................................................................................................I

I

DECLARATION..............................................................................................................................................II

ACKNOWLEDGEMENTS...........................................................................................................................III

ABSTRACT.....................................................................................................................................................IV

TABLE OF CONTENTS................................................................................................................................V

TABLE OF FIGURES...................................................................................................................................VI

1 INTRODUCTION ...........................................................................................................................................1

2 LITERATURE REVIEW ..............................................................................................................................3

3 REQUIREMENTS SPECIFICATION ........................................................................................................4

4 PROJECT DESIGN ........................................................................................................................................7

5 IMPLEMENTATION ..................................................................................................................................10

6 EVALUATION ..............................................................................................................................................11

7 CONCLUSIONS & FUTURE WORK .......................................................................................................14

REFERENCES ................................................................................................................................................15

APPENDIX A: HDL OR C SOURCE CODE .............................................................................................17

APPENDIX B: HARDWARE SCHEMATICS ..........................................................................................18

APPENDIX C: LIST OF COMPONENTS .................................................................................................19

APPENDIX D: PROJECT TIMELINE ......................................................................................................20

v


8/28

Table of Figures

FIGURE 2-1 AN EXAMPLE OF INSERTING FIGURE INTO YOUR PROJECT................................3

FIGURE 3-2 FUNCTIONAL REQUIREMENTS NUMBERING..............................................................4

FIGURE 4-3 EXAMPLE FIGURE FOR PROTOTYPE APPLICATION................................................7

FIGURE 4-4 ARCHITECTURE OVERVIEW DIAGRAM........................................................................8

FIGURE 5-5 EXAMPLE FIGURE FOR USER INTERFACE ................................................................11

vi


9/28

1 Introduction

This is one of the most important components of the report. It should begin with a clear statement of what the project is about so that

the nature and scope of the project can be understood by a lay reader. It should summarize everything you set out to achieve, provide a

clear summary of the project's background, relevance and main contributions. The introduction should set the scene for the project and

should provide the reader with a summary of the key things to look out for in the remainder of the report.

The introduction itself should be largely non-technical. It is sometimes useful to state the main objectives of the project as part of the introduction. Concentrate on the big issues, e.g. the main questions (scientific or otherwise) that the project setsout to answer.

The main goal of the project is to investigate

The research includes devising possible improvements in

The project includes development of hardware to

The project includes development of software to

Chapter2 covers the background material and literature reviewed to understand the intricacies

of

Chapter3 then specifies the lists of extracted requirements for the project development. These

requirements are categorized into several groups on the basis of their functionality.

Requirements are also prioritized to explain their importance and enable the user to sift them

according to his needs.

Chapter 4 describes the design formulated for the successful execution of the suggested

techniques. The design explains the architecture of In the end, this chapter gives detailed

information for each module, explaining their critical methods and properties required forsuccessful execution.

Chapter5 explains the approach taken and issues confronted while implementing the intended

goals. It explains the temporal stages experienced while implementing the design, and also the

key functions that needs special consideration from the viewpoint of implementation. In the end,

the author has explained the user-interface of the implemented program, and the details of each

command how it is handled and used.

1


10/28

The testing and evaluation of the developed hardware and software is discussed in Chapter 6. It

explains the testing procedure followed and then the various types of tests executed on the

application to confirm its proper functioning and meeting the acceptance criteria. The results of

these tests are summarized in the end, with possible results concluded from these tests.

In the end, we briefly present the conclusions from this project and also the possible future

improvements and additions for better design/implementation and investigation of .

2


11/28

2 Literature Review

The background section of the report should set the project into context by relating it to existing published work which

you read at the start of the project when your approach and methods were being considered. There are usually many

ways of solving a given problem, and you shouldn't just pick one at random. Describe and evaluate as many alternative

approaches as possible.

The background section can be included as part of the introduction but is usually better as a separate chapter, especially

if the project involved significant amount of prior research. The published work may be in the form of research papers,

articles, text books, technical manuals, or even existing software or hardware of which you have had hands-on

experience.

Figure 2-1 An Example of inserting Figure into your project

WARNING: Avoid plagiarism

If you take another person's work as your own and do not cite your sources of

information you are being dishonest; in other words you are cheating. When referring to

other pieces of work, cite the sources where they are referred to or used, rather than justlisting them at the end.

3


12/28

3 Requirements Specification

The Non-functional and Functional Requirements are categorized into various groups based on relations and objective

of requirements. Each requirement is assigned an ID which is numbered as shown in Figure 3-2.

Figure 3-2 Functional Requirements Numbering

The Requirement code consists of three parts separated by minus sign i.e. -, the three parts are explained below:

Requirement Type: This is a two letter code explaining the type of requirement. It contains one of the

following two values:

FR - Functional Requirement

NR - Non-Functional Requirement

Group Index: This is a serial number assigned to the group with unique value. This is placed in the middle

of Requirement ID.

Requirement Index: This is a serial number assigned to the requirement, and has unique value inside its

own group. It is placed at the end of Requirement ID.

Moreover, all the requirements are given priority scale from 1 to 3. Requirements with priority value 1 must be

implemented with full functionality. Priority value 2 is intended to be implemented with a secondary importance.However, priority value 3 is applied to the requirements that maybe skipped in favour of completing the project in time.

3.1 Non-functional Requirements

3.1.1 Product requirements

ID Priority Details

NR-01-001 1 Platform:NR-01-002 1 Language:

NR-01-003 1 Compiler:NR-01-004 1 Usability:NR-01-005 2 Portability:NR-01-006 2 Space:NR-01-007 1 Machine:

3.1.2 Organisational requirements

ID Priority Details

NR-02-001 1 Delivery: The system development process and deliverable documents

shall conform to the process and deliverables defined in the document

CIIT-CE-02H Degree Project Students Handbook.NR-02-002 1 Standard: The standard of the final product shall be of undergraduate

FR 00 000

RequirementIndexRequirement Type

Group Index

4


13/28

level or above.

3.1.3 External requirements

ID Priority Details

NR-03-001 3 Security: This is a degree project having no strict security

requirements.NR-03-002 1 Ethical: The application will not use any type of un-ethical electronic

material while project development and execution.NR-03-003 1 Legislative: The application shall not use any private or confidential

data, or network information that may infringe copyrights and/or

confidentiality of any personnel not directly involved in this product.NR-03-004 3 Safety:

3.2 Functional Requirements

3.2.1 Category 1

The application is intended to ...

ID Priority Details

FR-01-001FR-01-002

FR-01-003FR-01-004FR-01-005FR-01-006

3.2.2 Category 2

The application is intended to generate Following requirements should be met under given

priorities:

ID Priority DetailsFR-02-001FR-02-002FR-02-003FR-02-004FR-02-005FR-02-006FR-02-007

3.2.3 Category 3

5


14/28

ID Priority Details

FR-03-001FR-03-002FR-03-003FR-03-004

3.2.4 Category 4

ID Priority Details

FR-04-001FR-04-002FR-04-003FR-04-004FR-04-005

6


15/28

4 Project Design

4.1 Methodology

A very basic prototype was developed

Figure 4-3 Example Figure for Prototype Application

The prototype was helpful in shown in Figure 4-3.

7


16/28

4.2 Architecture Overview

The design of the intended product is explained graphically with the help of a diagram shown in

Figure 4-4. The diagram explains the overall interactions of the modules and their placements.

Figure 4-4 Architecture Overview Diagram

4.3 Design Description

Following are the modules constituting the product to be developed. Please note that we are

documenting only the salient properties and methods of each module to keep the description

simple and more readable.

Network

Path FinderInterface

Network Decomposer

Path FinderImplementers

NetworkSerialization

NetworkEditing

NetworkGenerationEvent

Handlers

Graphical UserInterface

(GUI)

NodesObjects

NodesLinks

NodesNodes

Zones(Partition)

Zones(Partition)

Zones(Partitions)

8


17/28

4.3.1 Module 1

Description: This module is the

Details:

Add details here

4.3.2 Module 2


Details:

Add details here

4.3.3 Module 3


Details:

Add details here

9


18/28

5 Implementation

We have implemented the suggested design using

5.1 Development Stages

Following were the discrete phases we have experienced incrementally to realize our product in

the given time:

5.1.1

We started the project by creating a

5.1.2

The next step followed was to

5.1.3

As we already described, some of the modules were critically depending on other modules and

could not be unit-tested without communicating to them properly. Hence, we needed to writedown

5.1.4 System Integration

The next step followed was to

5.2 Key ComponentsFollowing are the key components that need special attention from developers viewpoint. We

are not intending to present the code in this discussion, rather the hardware and software

components are explained using state-charts and pseudo-code, and are critically discussed. The

importance of key components with their implementation is elaborated. Moreover, we explain

the approaches taken, along with their advantages and/or limitations.

5.2.1

We have implemented

10


19/28

5.2.2

5.3 User Interface

User Interface is an extremely important consideration for any project that requires human-

machine interaction. However, this project doesnt require human machine interaction and

therefore the product runs solely in the background without any user input. Besides this fact, we

have introduced an option to display the current status, orientation, and power production from

the requested solar panels. The user interface is

5.3.1

Figure 5-5 Example Figure for User Interface

5.3.2

6 Evaluation

We have focussed on thorough testing through-out the design and implementation phase. While

testing the

11


20/28

6.1 Unit Testing

Each module in the application was tested while being developed to confirm its adherence to the

related requirements. This testing was

6.2 Function Testing

After integrating the system, testing was done on a

6.2.1 Testing Requirements < A, B, C>

Requirement

Tested CYCLE 1 CYCLE 2

FINAL

STATUS DETAILS (if any)

FR-02-001 Ok Ok Ok FR-02-002 Ok Ok Ok FR-02-003 Failed Ok Ok FR-02-004 Ok Ok Ok Test for

Failed Ok Ok Test for FR-02-005 Ok Ok Ok

Failed Ok Ok FR-02-006 Ok Ok Ok FR-02-007 Ok Ok Ok

Failed Failed Failed Test for

This part of Requirement is foundinvalid

Failed Ok Ok Test for

6.2.2 Testing Requirements < A, B, C>

Requirement

TestedCYCLE 1 CYCLE 2

FINAL

STATUSDETAILS (if any)

FR-03-001 Ok Ok Ok FR-03-002 Failed Ok Ok

FR-03-003 Ok Ok Ok FR-03-004 N.A. The requirement is low-priority: Not

implemented due to time-constraints

6.3 Results

After thorough testing of system, we proceeded for investigation of our implemented techniques

for

12


21/28

6.3.1

We have compared the

6.3.2

13


22/28

7 Conclusions & Future Work

In this project, we have investigated and developed

There could be several improvements possible Some of the ideas for future development is

mentioned below:

Idea 1

Idea 2

Idea 3

14


23/28

References

[1] Ross Sherlock, Peter Mooney, Adam Winstanley & Jan Husdal, "Shortest Path Computation: AComparative Analysis",GISRUKpp 91-94, Sheffield, UK, April 2002.

[2] S. Shekhar, M. Coyle, A. Kohli, Path Computation Algorithms for Advanced TravellerInformation Systems, IEEE Computer Society, 1993.

[3] R. Jacob, M. Marathe and K. Nagel, A Computational Study of Routing Algorithms for RealisticTransportation Networks, invited paper appears in ACM J. Experimental Algorithmics, 4, Article6, 1999. http://www.jea.acm.org/1999/JacobRouting/

[4] D. Wagner, T. Willhalm and C. D. Zaroliagis; Geometric Shortest Path Containers; Universit atKarlsruhe, Fakult at f ur Informatik 2004-5, 2004.

[5] John Taplin, Simulation Models of Traffic Flow, Proceeding of the 34th Annual Conference of theOperational Research Society of New Zealand (ORSNZ'99), Keynote Paper, University ofWaikato, Hamilton NZ, December 1999, pp 175-184.

[6] S. Pallottino e M. G. Scutell a, Shortest path algorithms in transportation models: classical andinnovative aspects, In (P. Marcotte and S. Nguyen, eds.) Equilibrium and Advanced TransportationModelling, Kluwer (1998) 245-281.

[7] Andrea Daz, Vernica Vzquez, G. Wainer. "Vehicle routing in Cell-DEVS models of urbantraffic". In Proceedings of European Simulation Simulation. Marseille, France. 2001.

[8] Rong Zhou and Eric A. Hansen, Breadth-First Heuristic Search , 14th International Conference onAutomated Planning and Scheduling (ICAPS-04) Whistler, British Columbia, Canada, 2004.

[9] Jayadev Misra, A walk over the shortest path: Dijkstra's Algorithm viewed as fixed-pointcomputation. Information Processing Letters. Volume 77, Number 2-4, pp 197-200. February2001.

[10] Matthias Schmidt, "Decomposition of a Traffic Flow Model for a Parallel Simulation", Proc. AI,Simulation and Planning in High Autonomy Systems (AIS2000), March 6-8, 2000, Tucson, USA,

pp 199-202

[11] KLD Associates Inc. (last accessed on April, 2004). http://www.kldassociates.com/

[12] Peytchev E., Bargiela A., Parallel simulation of city traffic using PADSIM, Proceedings ofModelling and Simulation Conference ESM'95, Prague, Eds. M Snorek, M Sujansky, A Verbraeck,

June 1995, ISBN 1-56555-080-3, pp. 330-334.

[13] Oscar Franzese and Shirish Joshi, Traffic Simulation Application to Plan Real-Time DistributionRoutes, Proceedings of the 2002 Winter Simulation Conference (WSC), E. Ycesan, C.-H. Chen,J. L. Snowdon, and J. M. Charnes, eds.

[14] Polly Huang and John Heidemann, Minimizing Routing State for Light-Weight NetworkSimulation, In Proceedings of the International Symposium on Modeling, Analysis and Simulationof Computer and Telecommunication Systems, p. to appear. Cincinnati, Ohio, USA, IEEE. August,2001. http://www.isi.edu/~johnh/PAPERS/Huang01b.html

[15] Yu Jiangsheng, Lecture on Single-Source Shortest Paths, Institute of Computational Linguistics,Peking University, 2003

15
http://www.shef.ac.uk/gisruk/http://www.shef.ac.uk/gisruk/http://www.shef.ac.uk/gisruk/http://www.jea.acm.org/1999/JacobRouting/http://www.informatik.uni-trier.de/~ley/db/journals/ipl/ipl77.html#Misra01http://www.informatik.uni-trier.de/~ley/db/journals/ipl/ipl77.html#Misra01http://www.doc.ntu.ac.uk/RTTS/Papers/rttg-publ16.pshttp://www.doc.ntu.ac.uk/RTTS/Papers/rttg-publ16.pshttp://www.isi.edu/~johnh/PAPERS/Huang01b.htmlhttp://www.jea.acm.org/1999/JacobRouting/http://www.informatik.uni-trier.de/~ley/db/journals/ipl/ipl77.html#Misra01http://www.doc.ntu.ac.uk/RTTS/Papers/rttg-publ16.pshttp://www.isi.edu/~johnh/PAPERS/Huang01b.htmlhttp://www.shef.ac.uk/gisruk/


24/28

[16] Baruch Awerbuch , Bonnie Berger , Lenore Cowen , David Peleg, Near-Linear Time Constructionof Sparse Neighborhood Covers, SIAM Journal on Computing, v.28 n.1, p.263-277, Feb. 1999

[17] Vittorio Astarita, Vincenzo Punzo, Vincenzo Torrieri, Calibration and Comparison Of SimulationModels For Road Network Planning: The Congested Network Of Pozzuoli, 9th Meeting of theEuro Working Group on Transportation, Bari, Italy, June 2002.

[18] M.Herty And A.Klar, Modeling, Simulation,And Optimization Of Traffic Flow Networks,SIAM Journal On Scientific ComputingVolume 25, Number 3Pp. 1066-1087

[19] Andrew V. Goldberg and Craig Silverstein, Implementation of Dijkstras Algorithm Based onMulti-Level Buckets, Technical Report 95-187, NEC Research Institute, Princeton, NJ, 1995

[20] Ariel Orda and Raphael Rom, "Shortest path and minimum-delay protocols in networks with time-dependent edge-length", Journals of the ACM, Volume 37 , Issue 3, pp 607-625, 1990,ISSN:0004-5411

[21] A. Orda and R. Rom. Shortest-path and minimum-delay algorithms in networks with time-dependent edge-length. Journal of the ACM, 37(3):607--625, 1990.

[22] Hermann Kaindl and Gerhard Kainz. Bidirectional heuristic search reconsidered. Journal ofArtificial Intelligence Research, 7:283--317, 1997.

[23] D. Wagner, T. Willhalm, C. Zaroliagis. Dynamic shortest path containers. Alberto Marchetti-Spaccamela,Proc. Algorithmic Methods and Models for Optimization of Railways (ATMOS 2003),Volume 92 ofElectronic Notes in Theoretical Computer Science, pages 65-84, 2004.

[24] P. W. Eklund, S. Kirkby, and S. Pollitt,A Dynamic Multi-source Dijkstras Algorithm for VehicleRouting, IEEE Transactions, Proceeding 1996 Australian New Zealand Conference on IntelligentInformation Systems, 18-20 November 1996, Adelaide, Australia.

[25] jvind Johansson. Graph decomposition using node labels. PhD thesis, Royal Institute ofTechnology, Stockholm, 2001.

16
http://portal.acm.org/citation.cfm?id=298544&dl=ACM&coll=portal&CFID=19896652&CFTOKEN=80928376http://portal.acm.org/citation.cfm?id=298544&dl=ACM&coll=portal&CFID=19896652&CFTOKEN=80928376http://epubs.siam.org/sam-bin/dbq/toclist/SISChttp://epubs.siam.org/sam-bin/dbq/toc/SISC/25/3http://epubs.siam.org/sam-bin/dbq/toc/SISC/25/3http://epubs.siam.org/sam-bin/dbq/toc/SISC/25/3http://portal.acm.org/citation.cfm?id=298544&dl=ACM&coll=portal&CFID=19896652&CFTOKEN=80928376http://portal.acm.org/citation.cfm?id=298544&dl=ACM&coll=portal&CFID=19896652&CFTOKEN=80928376http://epubs.siam.org/sam-bin/dbq/toclist/SISChttp://epubs.siam.org/sam-bin/dbq/toc/SISC/25/3


25/28

Appendix A: HDL or C Source Code

17


26/28

Appendix B: Hardware Schematics

18


27/28

Appendix C: List of Components

19


28/28

Appendix D: Project Timeline

DATE

PROJECT ID

TOTAL NUMBER

OF WEEKS IN

PLAN

TITLE

No.STARTING

WEEKDESCRIPTION OF MILESTONE DURATION

1

2

3

4

5

6

7

8

9

10

* You can provide Gantt chart instead of filling this form, if you like

template project report

Documents