Commit 5e42d65f authored by Andreas Freise's avatar Andreas Freise

Adding info about test files to INSTALL.

parent 6dcca018
......@@ -13,11 +13,13 @@
2. Installation
3. Short Syntax Reference
3. Running your first simulation
4. Further development
4. Short syntax reference
5. Copyright and Disclaimer
5. Further development
6. Copyright and disclaimer
________________________________________________________________________
......@@ -100,7 +102,7 @@ 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
If you want to 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'.
......@@ -117,7 +119,7 @@ Unix:
forums: http://www.gwoptics.org/finesse/forums
Windows (no Cygwin installed):
Firstly you must move the Finesse folder Finesse2.0 to a location on
Firstly you must move the FINESSE folder Finesse2.0 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.
......@@ -139,7 +141,7 @@ Windows (Cygwin is already installed):
If you already have cygwin installed it is advisable to remove
the files cygwin1.dll and cygpath.exe from the Finesse2.0 folder
so that the files from your Cygwin installation will be used.
Alternatively it may be best to build a version of Finesse with
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_
......@@ -152,48 +154,102 @@ Windows (Cygwin is already installed):
instructions:
http://kvasir.sr.bham.ac.uk/redmine/projects/finesse/wiki/Hints_for_using_Finesse_on_Windows
Version 0.99.9 was the first public release of Finesse designed to
Version 0.99.9 was the first public release of FINESSE designed to
work with Cygwin rather than just Windows alone, there may still be
bugs regarding the workflow or things that just don't make sense.
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.:
./kat 3D.kat (for Unix) and
kat.exe 3D.kat (for Windows)
3. Running your first simulation
Now you should be able to start FINESSE with an example file, two
dummy example files are included in the zip file: 'test.kat' and
'test_plot.kat'. More examples can be found on the FINESSE web page:
http://www.gwoptics.org/finesse/#download
http://www.gwoptics.org/finesse/#simpleexamples
This starts FINESSE which will print some text to the console that
will look like this:
To run the first test file, open a terminal window, change into
the FINESSE directory and type:
black$ kat 3D.kat
$ ./kat test.kat
This should produce the following text output (if this does not work,
you probably have not downloaded the correct version of FINESSE):
------------------------------------------------------------------------
FINESSE 1.0 (build 0.99.9-274-g5a28eb1)
FINESSE v2.0 (build v2.0-7-gf7b41e5)
o_.-=. Frequency domain INterferomEter Simulation SoftwarE
(\'".\| 05.06.2013 http://www.gwoptics.org/finesse/
(\'".\| 17.05.2014 http://www.gwoptics.org/finesse/
.>' (_--.
_=/d ,^\ Input file 3D.kat,
~~ \)-' ' Output file 3D.out,
/ | Gnuplot file 3D.gnu
' ' Thu Jun 6 00:25:25 2013
_=/d ,^\ Input file test.kat,
~~ \)-' ' Output file test.out,
/ | Gnuplot file test.gnu
' ' Sun May 18 11:06:48 2014
------------------------------------------------------------------------
** plotting only one output (use 'multi' to plot all).
100%
'noxaxis' has been set, ignoring all other xaxis commands
--- cavity tracing
cavity cavity1:
cavity is stable! Eigenvalues:
q=489.898i, w0=12.880974mm z=0m g=-0.714286
finesse : 29.79, round-trip power loss: 0.19
opt. length: 2.4km, FSR: 124.91352kHz
FWHM: 4.1931423kHz (pole: 2.0965712kHz)
writing matlab/python/gnuplot batch files...
The second test file test_plot.kat will attempt to create graphical output.
This only works if you have Gnuplot installed and have set the path
to the Gnuplot binary correctly in the kat.ini file as described above.
To run the second example, type:
$ ./kat test_plot.kat
This should produce the following text output. In addition a Gnuplot
window with a simple plot of the cavity power as a function of cavity
tuning should appear.
------------------------------------------------------------------------
FINESSE v2.0 (build v2.0-7-gf7b41e5)
o_.-=. Frequency domain INterferomEter Simulation SoftwarE
(\'".\| 17.05.2014 http://www.gwoptics.org/finesse/
.>' (_--.
_=/d ,^\ Input file test_plot.kat,
~~ \)-' ' Output file test_plot.out,
/ | Gnuplot file test_plot.gnu
' ' Sun May 18 11:25:40 2014
------------------------------------------------------------------------
writing matlab/python/gnuplot batch files...
calling gnuplot...
FINESSE writes the calculated data into the file `3D.out' and a batch file
`3D.gnu'. Then Gnuplot is started and the data from `3D.out' is plotted
(the plot from this example was used for the cover picture for the manual).
If the graphical output fails, you can do a few tests to find out why.
- edit the test_plot.kat file, add the word 'debug' on a new line
and run the file again
- this should produce much more text output and near the end prints
the actual system call used to start Gnuplot, for example:
calling gnuplot...
(using '/usr/local/bin/gnuplot -persist test_plot.gnu')
- copy the system call (text between quotes) and try to run this from the
command window directly. If that fails you can use the command
'which gnuplot' or 'which Gnuplot' in the command window to determine
the correct path.
- with that path you should be able to start Gnuplot manually from the
command line. Once that works, use the same path for your settings
in the kat.ini file
- if the above does not help, contact us, or post a message at:
http://www.gwoptics.org/finesse/forums/
________________________________________________________________________
3. Short Syntax Reference for FINESSE 2.0 :
4. Short syntax reference for FINESSE 2.0 :
------------------------------------------------------------------------
FINESSE v2.0 - Help Screen - 17.05.2014
......@@ -265,6 +321,7 @@ ________________________________________________________________________
gauss** name component node w(z) Rc [wy(z) Rcy] - set q parameter
cav name component1 node component2 node - trace beam in cavity
startnode node - startnode of trace
lambda wavelength - overwrite wavelength
retrace [off] - re-trace beam on/off
phase 0-7 (default: 3) - change Gouy phases
(1: phi(00)=0, 2: gouy(00)=0, 4: switch ad phase)
......@@ -299,7 +356,7 @@ ________________________________________________________________________
________________________________________________________________________
4. Further development
5. Further development
With Finesse 2.0 we have completed the implementation of radiation
pressure effects and have further achieved a full implementation
......@@ -311,7 +368,10 @@ time we will continue to improve and develop the code. One
focus of our activity will be speed improvements, another the
development and integration of PyKat (www.gwoptics.org/pykat/).
5. Copyright and Disclaimer
________________________________________________________________________
6. Copyright and disclaimer
FINESSE and the accompanying documentation and the example files
have been written by:
......
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