Window To The Stars
*******************

*************************************************************
        >>> PLEASE NOTE <<<

These instructions are for Window to the Stars version 1.0.

YOU PROBABLY WANT VERSION 2.0
which you can get from
https://r-izzard.surrey.ac.uk/window.html#get

*************************************************************












Automatic Installation
**********************

First, try to install automatically. 

You can find an installation script for Debian-like Linux (e.g. Ubuntu, Mint, Debian) on the WTTS website. 
To install on Ubuntu, Mint, Debian etc., try the following commands:

-----

wget http://www.ast.cam.ac.uk/~rgi/code/wtts/linux_installer
chmod +x linux_installer
./linux_installer

-----

You can find an installation script for Unix-like systems on the WTTS website. This is used by the above linux_installer script. You can run it manually and assume installation in default locations with:

-----
wget http://www.ast.cam.ac.uk/~rgi/code/wtts/linux_installer
chmod +x ./installer
./installer local
-----

If you wish to have more control over the installation directory locations, run './installer' instead.

Once installed you can just execute the command 'wtts' or '~/bin/wtts'. (You may need to alter your PATH, and I always assume you are using the bash shell.)

Please see below for more information on packages you require to install manually.


System and development packages
-------------------------------

You will require Perl, GTK, gnuplot, ghostscript and a FORTRAN compiler (e.g. gfortran or Intel's ifort) to be installed along with some development packages such as cmake and make.

To install from packages, you often have to install the development packages on your system, e.g. xyz-devel. You will certainly, on Ubuntu, require

glib2-devel
Gtk2-devel


Perl Packages
-------------

There are many ways to install the appropriate Perl packages. 

* System wide Perl packages
---------------------------

One way is by system-wide packages. This assumes that all the packages you need are available on your system. This will not be true, but you can install many modules this way.

cpanminus is the recommended way to install packages on your system. Please see 
http://search.cpan.org/dist/App-cpanminus/lib/App/cpanminus.pm
or install cpanminus as a system package (called 'cpanminus' on Debian/Ubuntu/Mint).

* Locally installed Perl packages
---------------------------------

You should use cpanminus (known as cpanm) to install packages locally. The (linux_)installation script will try to do this automatically.

If you have Perlbrew installed (http://perlbrew.pl/) then the installation script allows Perlbrew to manage your packages. If you do not, it will try to install the local::lib package.

* Perl package list
-------------------

The required packages currently include the following:

   1 ExtUtils::PkgConfig   ftp://ftp.cpan.org/pub/CPAN/authors/id/X/XA/XAOC/ExtUtils-PkgConfig-1.15.tar.gz,
    2 ExtUtils::Depends   ftp://ftp.cpan.org/pub/CPAN/authors/id/X/XA/XAOC/ExtUtils-Depends-0.308.tar.gz,
    3 Glib   ftp://ftp.cpan.org/pub/CPAN/authors/id/X/XA/XAOC/Glib-1.305.tar.gz,
    4 Gtk2   ftp://ftp.cpan.org/pub/CPAN/authors/id/X/XA/XAOC/Gtk2-1.2491.tar.gz,
    5 Gtk2::Ex::NoShrink   http://www.cpan.org/authors/id/K/KR/KRYDE/Gtk2-Ex-NoShrink-4.tar.gz,
    
    6.0 File::Tail   ftp://ftp.cpan.org/pub/CPAN/authors/id/M/MG/MGRABNAR/File-Tail-0.99.3.tar.gz,
    6.1 File::Copy   ,
    6.2 File::Basename   ,
    
    7 Time::HiRes   ftp://ftp.cpan.org/pub/CPAN/authors/id/Z/ZE/ZEFRAM/Time-HiRes-1.9726.tar.gz,
    
    8 Math::Trig   ftp://ftp.cpan.org/pub/CPAN/authors/id/Z/ZE/ZEFRAM/Math-Complex-1.59.tar.gz,

    9 Compress::Zlib   ftp://ftp.cpan.org/pub/CPAN/authors/id/P/PM/PMQS/IO-Compress-2.064.tar.gz,
    10 File::Path   ftp://ftp.cpan.org/pub/CPAN/authors/id/D/DL/DLAND/File-Path-2.09.tar.gz,
    10.1 File::Which   ftp://ftp.cpan.org/pub/CPAN/authors/id/A/AD/ADAMK/File-Which-1.09.tar.gz,
    11 Archive::Zip   ftp://ftp.cpan.org/pub/CPAN/authors/id/P/PH/PHRED/Archive-Zip-1.37.tar.gz,
    12 Proc::ProcessTable   ftp://ftp.cpan.org/pub/CPAN/authors/id/J/JW/JWB/Proc-ProcessTable-0.50.tar.gz,
    13 Unix::Processors   ftp://ftp.cpan.org/pub/CPAN/authors/id/W/WS/WSNYDER/Unix-Processors-2.042.tar.gz,
    14 Config::General   ftp://ftp.cpan.org/pub/CPAN/authors/id/T/TL/TLINDEN/Config-General-2.56.tar.gz,
    
    15 Sys::Info::Base   ftp://ftp.cpan.org/pub/CPAN/authors/id/B/BU/BURAK/Sys-Info-Base-0.7803.tar.gz,
    15.1 Test::Sys::Info   ftp://ftp.cpan.org/pub/CPAN/authors/id/B/BU/BURAK/Test-Sys-Info-0.20.tar.gz,
    15.2 Sys::Info::Driver::Linux   ftp://ftp.cpan.org/pub/CPAN/authors/id/B/BU/BURAK/Sys-Info-Driver-Linux-0.7903.tar.gz
    15.3 Convert::Binary::C   ftp://ftp.cpan.org/pub/CPAN/authors/id/M/MH/MHX/Convert-Binary-C-0.76.tar.gz,
    15.4 Sys::Info   ftp://ftp.cpan.org/pub/CPAN/authors/id/B/BU/BURAK/Sys-Info-0.78.tar.gz,
    
    16 Carp   ftp://ftp.cpan.org/pub/CPAN/authors/id/Z/ZE/ZEFRAM/Carp-1.3301.tar.gz,

    19 rob_misc   http://www.ast.cam.ac.uk/~rgi/code/wtts/rob_misc-0.09.tar.gz,
    20 STARS   http://www.ast.cam.ac.uk/~rgi/code/wtts/STARS-0.39.tar.gz,


NOTE: if you are using Mac OSX, replace 15.2 with 

     15.2 Sys::Info::Driver::OSX   ftp://ftp.cpan.org/pub/CPAN/authors/id/B/BU/BURAK/Sys-Info-Driver-OSX-0.7958.tar.gz

------------------------------------------------------------

The following information is out of date.  It is left here for future reference and to help you if you are in trouble.



Manual Installation guide (for V0.09 upward)
********************************************
 
You require: GTK (2.4 at least), Perl, Perl-GTK2, the Perl File module (for Tail, Copy, and Basename) and the stuff in the downloads directory, gnuplot (4.0), Image Magick (for animation saving via convert), (Gnu?) sed, ghostscript.

I have these packages (and their dependencies) installed (Redhat Enterprise Linux 4.0) with updates from http://atrpms.net (see the end of this file for details)

perl-5.8.5-24
perl-Gtk2-1.102-1.2
perl-File-Tail-0.99.3-1.2
gnuplot-4.0.0-4
ImageMagick-6.2.2.0-3
sed-4.1.2-4
ghostscript-7.07-33

NB Redhat/Fedora's gnuplot is crippled, as it cannot handle PNGs properly. Use the postscript images instead of PNG.

Follow these instructions for immediate gratification:

0) Install the following Perl modules 

perl-Glib
perl-Gtk2

preferably versions 1.120 and 1.121 respectively, also

perl-File-Tail (make sure this is AT LEAST 0.99.3, earlier are buggy)

You can get these from CPAN (www.cpan.org) ... Evert had to install the following perl modules from CPAN on his machine:

ExtUtils-Depends-0.205
ExtUtils-PkgConfig-1.07
File-Tail-0.99.3
Glib-1.102
Gtk2-1.102

You should get the LATEST versions of these (esp. File-Tail!).

1) Get Evert's STARS package (TWIN.zip), unzip it in some directory (say ~/stars). I am not responsbile for this package! :) But it does have some necessary files (notably "wrong.png", "noimage.png" and "variable_help") 

Follow the instructions in README to build TWIN.

2) Get the STARS_perl_module.zip and rob_misc_perl_module.zip, make two directories (stars_perl and rob_misc_perl), copy the zip files to their respective directories, unzip them, then do the usual Perl module install:

perl Makefile.PL
make
(as root) make install 

If you don't have root access, try reading the section below "Installing perl modules locally".

3) Copy stars.perlscript to ~/stars and rename it to stars.pl (I had to change the extension because the web server didn't like it... but you can change it back). You may have to do a "chmod 744 stars.pl" (or similar) to make it executable.

4) Run stars.pl - it should just work! If not, check the location of Perl is /usr/bin/perl (if it's not, edit the first line of stars.pl to match your Perl executable location). 

If you cannot make it work, try running "stars.pl vb=1" to turn on verbose mode and let me know what it says.

To change the prefix of stellar evolution files from 'window_to_the_stars' to something else, edit $runname in the script (or use "stars.pl runname=...").

Cached files are stored in /tmp/window_to_the_stars, so make sure /tmp exists (and is a local disk, otherwise everything will be slow). I have never used a system without /tmp/, even my ipod has it..!

A config file (~/.window_to_the_stars) will be put in your home directory, this just stores the Misc tab settings and is quite harmless.

Note the bugs file! Changes are in CHANGES (look here for hints if something breaks, it might be something I fixed recently but is not really fixed).

Rob Izzard, 25/12/2005 (merry christmas!)
Updated 26/01/2006 (V0.04), 03/03/2006 (V0.07), 30/04/2006 (V0.09)

************************************************************

Installing perl modules locally
*******************************

In .bashrc I have this:

# rob's perl libraries                                                          
export PERL5LIB=$HOME/lib/perl/lib/perl5/site_perl/5.8.5                        

which is my local perl directory (I have a lib, etc,  etc. in my home directory for local installs, you just need to create the directory structure - note that 5.8.5 is my perl version) then, in my install script I have

PREFIX=$HOME/lib/perl
cd <path to module stuff>
perl Makefile.PL PREFIX=$PREFIX

which installs in the correct place (same as PERL5LIB) - things might go wrong with a new Perl version, but nothing a few softlinks or quick rebuilds won't fix.
