Commit ff5f4e68 authored by Andreas Freise's avatar Andreas Freise

adding new INSTALL also to develop.

parent b92a715e
......@@ -85,7 +85,7 @@ by unpacking the zip (or tar.gz) file. This will create a directory
To find more about this, please visit
http://kvasir.sr.bham.ac.uk/redmine/projects/finesse )
In addition you can download a small collection of simple example files.
In addition you can download a small collection of simple example files.
These examples should run on any system but probably you won't get any
graphical output without changing some default settings (see below).
......@@ -94,14 +94,15 @@ change into the working directory which contains all required
files (the FINESSE binary 'kat', the init file 'kat.ini' and
an interferometer input file).
If you call the program by typing `kat' on the console without any option
or filename a short message on the usage will be displayed. Using the
option `-h' a short help screen with a short syntax reference is printed
(i.e. `./kat -h' or `kat.exe -h').
If you call the program by typing `kat' on the console without any
option or filename a short message on the usage will be displayed.
Using the option `-h' a short help screen with a short syntax
reference is printed (i.e. `./kat -h' or `kat.exe -h').
If you want automatically plot the results you need to have Gnuplot
or Python installed. Furthermore you must tell FINESSE where to find the
Gnuplot or Python executable. This is done by editing the file `kat.ini'.
or Python installed. Furthermore you must tell FINESSE where to find
the Gnuplot or Python executable. This is done by editing the file
`kat.ini'.
Unix:
You can easily find the Gnuplot executable with the command
......@@ -114,35 +115,37 @@ Unix:
For any queries or problems please post us a quick message in our
forums: http://www.gwoptics.org/finesse/forums
Windows - No Cygwin already installed:
Firstly you must extract the Finesse executable to a location on
your computer (such as "C:\Program Files\") where it will be installed.
Once it has been extracted, double click the `install.bat` file.
This will bring up a command window that will setup your PATH variables
so that you can use Finesse.
Windows (no Cygwin installed):
Firstly you must move the Finesse folder Finesse1.1 to a location on
your computer (such as "C:\Program Files\"). Then double click the
`install.bat` file. Running this will bring up a command window
to update your PATH variables.
Now you must install gnuplot on your computer from http://www.gnuplot.info/.
If you have a space in the path to where wgnuplot.exe is installed you need to
note the use of ' and " to encapsulate path and GNUCOMMAND
Now you must install gnuplot on your computer
from http://www.gnuplot.info/.
Next you need to specify the path to the Gnuplot executable
in the `kat.ini' file. If you have a space in the path where
wgnuplot.exe is installed you need to use both ' and " to encapsulate
path when setting the GNUCOMMAND:
GNUCOMMAND '"C:\Program Files\gnuplot\bin\Wgnuplot.exe" --persist'
else use
else use for example:
GNUCOMMAND 'C:\gnuplot\bin\Wgnuplot.exe --persist'
Windows - Cygwin is already installed:
Windows (Cygwin is already installed):
If you already have cygwin installed it is advisable to remove
cygwin1.dll and cygpath.exe that comes with Finesse and use those
found in your cygwin bin folder as different Cygwin versions do not
play nicely together. Alternatively it may be best to build a version
of Finesse that is compatiable with your Cygwin installation. This is
easy to do and instructions can be found at:
the files cygwin1.dll and cygpath.exe from the Finesse1.1 folder
so that the files from your Cygwin installation will be used.
Alternatively it may be best to build a version of Finesse with
your Cygwin installation. This is easy to do and instructions can be
found at:
http://kvasir.sr.bham.ac.uk/redmine/projects/finesse/wiki/_Windows_
You can either install the Cygwin or standard Windows version of
Gnuplot and correctly setup the GNUCOMMAND variable as stated above
to use it
You can now install Gnuplot, either via the Cygwin installer or by
downloaded the Gnuplot binary directly. You also need to set the
GNUCOMMAND variable in the kat.ini file as described above.
You can also find other tips as well as the gnuplot installation
instructions:
......@@ -154,8 +157,6 @@ Windows - Cygwin is already installed:
Please help us fix these by posting a quick message in our forum:
http://www.gwoptics.org/finesse/forums
Now you should be able to start FINESSE with an example file
(assuming you have copied the respective files into a
working directory). E.g.:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment