StarView Admin Document

Purpose

This document is intended for someone that is charged with modifying or understanding the starview code.

Notes

• This project was developed using the Eclipse IDE.
• For documentation of the source code please see the javadoc generated documentation located at http://starview.sf.net/docs

Build System

The code can be compiled by Eclipse or the ANT build tool. There are four ANT targets.

compile - will compile the source into .class fies and put them in the build/ directory

dist - creates the dist/ directory and builds two jar files.

clean - removes the dist/ and build/ directories

javadoc - creates the java documentation

StarView Command Line

The command line tool is used to generate an image file based on the following inputs:

--outputFile filename.png

--saodb SAODatabaseFIle

--date YYYY-MM-DD HH:MM:SS

--longitude ###.#### (in degrees)

--latitude ##.#### (in degrees)

--azimuthCenter ##.#### (in degrees)

--altitudeCenter ##.##### (in degrees)

--width ### (pixil width of image

--height ##3 (pixil height of image)

--imageArcWidth ##.### (number of arc degrees of width for image)

[--metafile <filename>]

The command line tool is ran by executing the following command:

java -jar dist/StarView.jar [command line parameters]

StarView Planetarium

The planetarium was developed for use when testing and debugging. It must be ran from a graphical environment. It can be started with the following command:

java -jar dist/Planetarium.jar

Non Source File information

Planetarium.mf : Used in creating Planetarium.jar

StarView.mf : Used in creating Starview.jar

allthree : A catalog of three conselations

build.xml : ANT build file

cepheus : A catalog of the cepheus conselation

sao : A place holder for the entire SAO catalog

ursamajor : A catalog of the ursa major conselation

ursaminor : A catalog of the ursa minor conselation