### Code-Saturne 1.3.1, Stand-alone binary package ###
###         J.Cugnoni, www.caelinux.com            ###

Introduction
------------

Code-Saturne is an industrial-level Finite Volume CFD code developed by EDF (France) and is distributed in GPL licence.To learn more about Code-Saturne, please visit EDF R&D website at :
http://rd.edf.com/107008i/EDF.fr/Research-and-Development/downloads/Code-Saturne.html

This package contains the sources & binaries of Code-Saturne 1.3.1 and its dependencies. The code has been built on CAELinux 2007 and configured to run right after unpacking in /opt/saturne; no additionnal configuration / re-build should be required. The package also contains the sources of Code-Saturne and its dependent libraries as well as the configuration files, so it should not be too complicated to recompile the whole code on your own platform if necessary (look in the INSTALL directory for more info).
Download links

This binary package can be downloaded from here:

http://www.caelinux.com/downloads/stable/saturne-1.3.1/saturne-1.3.1.tar.bz2   


Installation of the package
---------------------------

If you are running CAELinux 2007, all pre-prequisite should be already installed.

For other distributions, the required libraries / packages are described here after (some dependencies might be missing):

Requirements:
 gcc, g77, gfortran (version used here 3.3.6), GNU make and binutils, autoconf.
 a working installation of python with TkInter/Tix
 libXML2 library (shared + devel)

Installation:

 1. Decompress the archive in /opt (package stored initially in /tmp):

  cp /tmp/saturne.tar.bz2 /opt

  cd /opt

  bunzip2 /tmp/saturne.tar.bz2

  tar xvf /tmp/saturne.tar

 2. That's it!! Start learning / testing the code!!


Getting started
----------------

You should now start learning how to use Code-Saturne by reading its documentation. Before using any of the Code-Saturne executable, you will absolutelly need to define its environment variables. This can be done simply by "sourcing" the file named "cs_profile" (link in /opt/saturne). The documentation can be easilly accessed through the command "info_cs".

Here is an example on how to open the documentation from a terminal (please use the CAE Console in CAELinux):

 . /opt/saturne/cs_profile       

     (this defines the environment, note the space between . and /opt...)

 info_cs     

     (will list the table of content of the doc)

 info_cs tutorial &

     (opens the Tutorial document)
 
Now we can start a new CASE STUDY: 

 . /opt/saturne/cs_profile        

  cd  /tmp

  cree_sat -etude STUDY1 CASE1

Copy  the mesh in the 'MAILLAGE' sub directory of the STUDY

  cp /tmp/MyMesh.med  STUDY1/MAILLAGE 

Then we open the GUI to setup the simulation:  

  cd STUDY1/CASE1/DATA

  ./SaturneGUI

if you receive an error like this one:

  "Unable to display a Tk window.
  Please check your display environment."

you will need  to define the TIX_LIBRARY environment variable
for example like this in CAELinux 2007 (already defined when runned from CAE Console)

  export TIX_LIBRARY=/usr/share/tix8.1
 

Additionnally, a video tutorial will be published soon on CAELinux Wiki (www.caelinux.org).