Docstoc

ReleaseNotes

Document Sample
ReleaseNotes Powered By Docstoc
					Laser Mission
                                  Release Notes
                                     December 4, 2011

                                 Brian Hallesy
                               Garett Shulman
                                 James Bailey
                                 Neal Robbins
                              Brandon Shelton
    CSCI 4308-4318. Software Engineering Project 1 & 2
                     Department of Computer Science
                    University of Colorado at Boulder
                                          2009-2010

                                       Sponsored by
                                   Michael Eisenberg

                            Craft Technologies Group
                                        Boulder, CO
                                                TABLE OF CONTENTS

1.  INTRODUCTION ................................................................................................................ 1
2.  LASER MISSION INSTALLATION ...................................................................................... 2
  2.1. Software and Hardware Requirements ........................................................................ 2
    2.1.1. Development Environment .................................................................................... 2
    2.1.2. Software Runtime Environment ............................................................................ 2
    2.1.3. Hardware Runtime Environment ........................................................................... 2
  2.2. Loading the Laser Mission Source ............................................................................... 3
  2.3. User Documentation .................................................................................................... 4
3. A BRIEF TOUR OF THE LASER MISSION SOURCE ........................................................ 5
  3.1. Laser Mission Source Code Organization .................................................................... 5
  3.2. Known Problems .......................................................................................................... 7
4. SUMMARY ......................................................................................................................... 8
5. REFERENCES ................................................................................................................... 9




                                                                                                                                    ii
                                            TABLE OF FIGURES

Figure 1. Conceptual Overview of the Laser Mission System ................................................... 1
Figure 3. Laser Mission Source Directory Structure ................................................................. 5




                                                                                                                    iii
1.   INTRODUCTION
Laser Mission is an application intended to work with the existing Science On a Sphere software
developed by NOAA.

A conceptual diagram of the overall system is presented below in Figure 1.




                  Figure 1. Conceptual Overview of the Laser Mission System

This document, Laser Mission Release Notes, is intended to be read by the person responsible
for installing the Laser Mission system, as well as by the person responsible for continuing
development and maintenance of the software. It provides installation instructions, a very high
level view of the implementation and a list of useful references.




                                                                                             1
2.       LASER MISSION INSTALLATION
The Laser Mission release includes a printed form of all Laser Mission documentation, along
with a Laser Mission distribution disc (CD-R). Installing Laser Mission on a Science On a
Sphere installation and a tablet is a very simple process. It involves the following steps:
     1. Determining if you have the proper hardware and software environment.
     2. Loading the Laser Mission source from the distribution disc.
     3. Building and installing the Laser Mission run time files.
     4. Making the Laser Mission user documentation available to the users.

Each of these steps is described below.

2.1. Software and Hardware Requirements

Laser Mission has a number of components which can be run on multiple systems. The
command interpreter and animator portion of the system must run on a “server” machine where
SoS is installed. The GUI can then be run on any machine which contains its required libraries,
and connect with the server machine through a socket.

2.1.1. Development Environment

The development environment consists of an existing code base which incorporates the
following:

        C, Python, OpenGL - Using same versions as Software Runtime Environment
        C OpenGL sphere emulator

2.1.2. Software Runtime Environment

Laser Mission executes correctly on a platform having the following software runtime
environment:

        Server running Red Hat Linux v5 [RED HAT 07]
        OpenGL 3.2 [KHRONOS 09]
        Python 2.5 [PSF 06]
        Python Imaging Library 1.1.5 [PSF 05]
        Science on the Sphere (in order to display animations on a sphere)
        SOIL (Simple OpenGL Imaging Library) [LONESOCK 08]

2.1.3. Hardware Runtime Environment

Laser Mission executes correctly on a platform having the following hardware runtime
environment:



                                                                                             2
         The interpreter must run on the same hardware as Science On a Sphere
         The user interface can run on any separate piece of hardware, or the same hardware as
          the interpreter.

2.2. Loading the Laser Mission Source

Laser Mission is distributed as a tar(1) file on a single CD-R disc. Alternatively, it can be
downloaded from the online code base at lasermission.googlecode.com. Approximately 1.2MB
of disk space will be required to load the source files. In addition, there will need to be available
disk space to contain the images generated for creating the SoS animations. Drawing a simple
line 360 degrees around the circle requires 5 MB of images, so longer and more complex
animations would conceivably require space on the order of gigabytes 1. The source can be
used directly to run the system on a server, and may also be modified by a development team if
there is interest.

Perform the following steps to load the Laser Mission source files:
      1. Change to the directory in which you want to place the Laser Mission source. All Laser
         Mission source will be placed under a directory named lasermission in this directory.
         Make sure you have write permission in this directory.
      2. Place the distribution disc in an appropriate drive and untar it with the command

                 tar xpvf devicepath/lasermission.tar
          where devicepath is replaced by the path name for your drive. The files should be
          extracted without any errors, and you should find a directory named lasermission in your
          current directory.

Laser Mission is written in Python, and so, further building and installing is unnecessary. In
order to run the system, the TurtleInterpreter.py file should be run on the same server as the
SoS software. The GUI can then be run using the gui.py file from any machine, so long as it is
configured to connect to the IP address of the server machine.




1
    This number is for the specified development environment. It may vary for other platforms.

                                                                                                   3
2.3. User Documentation

Several pieces of documentation are available to the Laser Mission user. These are:
      Laser Mission Tutorial Poster
      Laser Mission In-Program Help Page

The Laser Mission Tutorial Poster is a simple, easy-to-read poster which provides basic
information about the system to users.

The Laser Mission In-Program Help Page is a screen which can be brought up while the
program is running. It contains a listing of all of the commands available in the GUI with
descriptions of what they do, as well as example programs that users can refer to.

The Laser Mission documentation is provided online as part of the source hierarchy. The
documentation, found under the doc subtree of the Laser Mission source hierarchy, can be
easily viewed with any web browser. As well as the poster, admin documentation is also
provided, and may be of interest. The help page can be viewed simply through running the
program and accessing it in the GUI.




                                                                                        4
3.   A BRIEF TOUR OF THE LASER MISSION SOURCE
This section describes the organization of the Laser Mission source code and documentation,
and mentions known problems with the system.

3.1. Laser Mission Source Code Organization

To understand the Laser Mission implementation, it is first necessary to understand the
organization of its source code. The Laser Mission source directory structure is shown in Figure
2 below.




                      Figure 2. Laser Mission Source Directory Structure




                                                                                              5
A brief overview of the organization of the source files is given here.

  docs         files and subdirectories for papers and presentations pertaining to laser mission

                  ebook               ebook for Laser Mission

                  misc                miscellaneous documents such as diagrams

                  papers              subdirectories for each paper written for the Laser
                                      Mission project.

                                       design                source for design specification

                                       documentation         source for user and admin
                                                             documentation

                                       releasenotes          source for release notes

                                       requirements          source      for     requirements
                                                             specification

                                       testplan              source for the test plan

                                       tutorial              source for user tutorials

                  src                 source for PDF version of the source code

  source       files and subdirectories for the source code of laser mission

                  Emulation           source for the sphere emulator

                  GOS                 source files for both GOS code and laser mission
                                      code



                  OpenGL              source files necessary for the sphere emulator


Comments within each file describe in more detail the purpose and content of the particular file.
The documentation contained within the source hierarchy itself should provide the most up-to-
date and complete assistance to the developer responsible for the Laser Mission software.




                                                                                                   6
3.2. Known Problems

There are several minor problems that are known to exist in this release of Laser Mission:
      Certain conditions will result in the sphere getting completely painted with the color
       assigned to a moving turtle. The most common cause was when the turtle was passing
       over the north or south poles, and the distortion caused the turtle to fill outside of the
       polygon it was drawing. Another case seemed to be when long animations were running
       and the turtle was moving over previously drawn lines.
      The interpreter does not consistently release the socket it binds to, resulting in that
       socket being unavailable until the timeout of 5 minutes or so passes. The timeout cannot
       be avoided without restarting the computer.
      If commands are typed manually into the text box in the GUI, the undo and redo buttons
       may not behave correctly.
      There is a graphical issue on the options page in the GUI, where only one radio button
       appears checked.
      The GUI does not contain syntax checking, so commands entered directly into the text
       box may result in unexpected output if they are mistyped, etc.




                                                                                               7
4.   SUMMARY
This document has provided installation instructions, as well as a very high level view of the
implementation. Together with the content of the release itself, developers should be able to
easily continue with development and maintenance of the Laser Mission system.




                                                                                            8
5.   REFERENCES
There are a number of documents related to this paper that are useful for further reading.

[MIT 80]

Abelson, Harold, and Andrea DiSessa. Turtle Geometry: The Computer as a Medium for
Exploring Mathematics. MIT, 1980. Print.

[SOS 09]

NOAA Science on a Sphere. NOAA. Web. 1 Nov. 2009. < http://sos.noaa.gov/>.

[SOSDOC 09]

SOS: Documentation. NOAA. Web. 1 Nov. 2009. <http://sos.noaa.gov/docs/>.

[SOSACP 09]

Automation Protocol. NOAA. Web. 1 Nov. 2009. <http://sos.noaa.gov/docs/automation.html>.

[LONESOCK 08]

SOIL. Web. 06 Nov. 2009. <http://lonesock.net/soil.html>.

[RED HAT 98]

RPM. Web. 06 Nov. 2009. <http://rpm.org/>.

[RED HAT 07]

Enterprise Linux-Open Source Application for Servers and Desktops built on Linux. Web. 13
Nov. 2009. <http://www.redhat.com/rhel/>.

[FEURZIG, PAPERT 67]

Feurzeig, Wally, and Seymour Papert. "Logo." ODP - Open Directory Project. Web. 09 Nov.
2009. <http://www.dmoz.org/Computers/Programming/Languages/Lisp/Logo//>.

[MACFERRIN 08]

MacFerrin, Mike. "Geometry on the Sphere."                YouTube.    Web.    09    Nov.     2009.
<http://www.youtube.com/watch?v=RqvMtp88Leo>.

[KHRONOS 09]

OpenGL - The Industry Standard for High Performance Graphics. Web. 13 Nov. 2009.
<http://www.opengl.org/>.




                                                                                                9
[PSF 06]

Python Programming Language            --   Official   Website.   Web.   13    Nov.    2009.
<http://www.python.org/>.

[PSF 05]

Python Imaging Library (PIL). Web. 13 Nov. 2009. <http://www.pythonware.com/products/pil/>.




                                                                                          10

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:2
posted:12/4/2011
language:English
pages:13