The documentation is principally generated from the Java source code. The standard entry for those used to reading Java class documentation is jdoc/index.html. I personally prefer to start with the full no-frames class tree at jdoc/overview-tree.html.
The user documentation is in jdoc/uk/me/chiandh/Sputnik/SputnikUI.html. The astronomical background is described in the classes or even methods where they are relevant for the programmer.
As this is all quite hard to chew, there is also a tutorial in doc/tutorial.html to get you started using Sputnik for real.
Go to http://www.chiandh.me.uk/soft and take it from there.
Sputnik is written in Java and you need a Java Runtime Environment (JRE) - version 1.6 or later - to run the application. http://java.sun.com is a good source for a JRE for Linux, Windows or MacOS. Sputnik needs the JLine package (even if you decide not to use it). Download this from http://jline.sourceforge.net and copy the jline-<version>.jar file to become jline.jar in the directory tree of your JRE, and there in the directory ./lib/ext/. Your Linux distribution may already contain packages for OpenJDK or Jline, ready to install without much pain. For example, if you run Debian lenny you can simply
aptitude install openjdk-6-jre libjline-java ln -s /usr/share/java/jline-0.9.94.jar \ /usr/lib/jvm/java-6-openjdk/jre/lib/ext/
Apart from that you only need the Sputnik.jar file. To run the application invoke the JRE, e.g.
java -jar /path/to/Sputnik.jar --jline
The documentation is online at
You can also obtain the
Sputnik-doc.tgz file and unpack it in
your own space. The starting point is the ReadMe.html file at the top.
The Java source code is available in the
Sputnik-source.tgz file. This does not include binaries or
documentation. To see what to do with the source code, read the top of the
uk/me/chiandh/Sputnik/SputnikUI.java source file ("Source maintenance and
Copyright: © 2002-2012 Horst Meyerdierks.
This programme is free software; you can redistribute it and/or modify it under the terms of the GNU General Public Licence as published by the Free Software Foundation; either version 2 of the Licence, or (at your option) any later version.
This programme is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public Licence for more details.
You should have received a copy of the GNU General Public Licence along with this programme; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Author: Horst Meyerdierks, http://www.chiandh.me.uk