| 1 | ============================================================================================ |
|---|
| 2 | The OASISGUI is an application of the software OPENTEA developped at CERFACS in the CFD group |
|---|
| 3 | by Antoine Dauptain. |
|---|
| 4 | Below are the instructions to run oasisgui to create the configuration file namcouple of |
|---|
| 5 | OASIS3-MCT on a Linux computer. |
|---|
| 6 | ============================================================================================ |
|---|
| 7 | In the directory oasisgui you have different directories: |
|---|
| 8 | - examples_xml_namcouple : two examples of xml files and their corresponding namcouple files |
|---|
| 9 | - opentea: sources of the software |
|---|
| 10 | - library: applications developped using OPENTEA (typically OASIS3-MCT application) |
|---|
| 11 | - XDRpy: main generic python tools for OPENTEA interface |
|---|
| 12 | and you have different files: |
|---|
| 13 | - gittag: reference under git repository |
|---|
| 14 | - myconfig.xml: my configuration file |
|---|
| 15 | - README: explanations |
|---|
| 16 | |
|---|
| 17 | |
|---|
| 18 | #### |
|---|
| 19 | If you use a MAC to log on the X11 terminal where the GUI will be executed, you must |
|---|
| 20 | modify the X11/OSX Focus correction putting <focusCorrection value="1"/> in |
|---|
| 21 | your configuration "myconfig.xml" file. |
|---|
| 22 | You can also use the menu "Config" directly in the software to modify the file |
|---|
| 23 | "myconfig.xml" but the new parameters will be activated only after closing and re-launching the GUI. |
|---|
| 24 | |
|---|
| 25 | #### |
|---|
| 26 | Before launching opentea, you must make sure that wish (based on tcl/tk version 8.5 or later) and |
|---|
| 27 | Python (version 2.6 or later) are installed on your platform and that they are configured to run opentea. |
|---|
| 28 | - to have the version of Python : >python -V |
|---|
| 29 | - to have the version of tcl/tk : >echo "puts [info tclversion]" | tclsh |
|---|
| 30 | |
|---|
| 31 | Your PYTHONPATH must include the $dir/oasis3-mct/util/oasisgui/XDRpy directory |
|---|
| 32 | ("dir" is the repository where is located oasis3-mct on your computer): |
|---|
| 33 | In your .cshrc you must add : |
|---|
| 34 | ---------------------------------------------------------- |
|---|
| 35 | setenv OASISGUIHOME $dir/oasis3-mct/util/oasisgui |
|---|
| 36 | if ($?PYTHONPATH) then |
|---|
| 37 | setenv PYTHONPATH $OASISGUIHOME/XDRpy:$PYTHONPATH |
|---|
| 38 | else |
|---|
| 39 | setenv PYTHONPATH $OASISGUIHOME/XDRpy |
|---|
| 40 | endif |
|---|
| 41 | ---------------------------------------------------------- |
|---|
| 42 | In your .bashrc you must add : |
|---|
| 43 | ---------------------------------------------------------- |
|---|
| 44 | export OASISGUIHOME=$dir/oasis3-mct/util/oasisgui |
|---|
| 45 | if [ "x${PYTHONPATH}" == "x" ] |
|---|
| 46 | then |
|---|
| 47 | export PYTHONPATH=$OASISGUIHOME/XDRpy |
|---|
| 48 | else |
|---|
| 49 | export PYTHONPATH=$OASISGUIHOME/XDRpy:$PYTHONPATH |
|---|
| 50 | fi |
|---|
| 51 | ---------------------------------------------------------- |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | #### |
|---|
| 55 | To be able to launch easily opentea using the command wish, you should also create the |
|---|
| 56 | alias "oasisgui" to launch the software: |
|---|
| 57 | --------------------------------------------- |
|---|
| 58 | in ksh : |
|---|
| 59 | alias oasisgui 'wish $OASISGUIHOME/opentea/opentea.tcl -config $OASISGUIHOME/myconfig.xml -code oasis3-mct &' |
|---|
| 60 | --------------------------------------------- |
|---|
| 61 | in bash : |
|---|
| 62 | alias oasisgui='wish $OASISGUIHOME/opentea/opentea.tcl -config $OASISGUIHOME/myconfig.xml -code oasis3-mct &' |
|---|
| 63 | --------------------------------------------- |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | ##### |
|---|
| 67 | Once you have launch oasisgui, you must fill up the different tabs from the left |
|---|
| 68 | to the right. Each window must be validated (button "process" on the bottom on the |
|---|
| 69 | right in the window). |
|---|
| 70 | An orange bullet in the tab means that no information was stored yet in the window, |
|---|
| 71 | a red bullet in the tab means that there is an error in the window and a green bullet |
|---|
| 72 | in the tab means that the data entered in the window has been processed and is correct. |
|---|
| 73 | Some documentation about the meaning of the variables is available in the different windows, |
|---|
| 74 | by clicking on the different blue bullets ("Learn more"). |
|---|
| 75 | Validated data are progressively stored in an xml file when filling the GUI. This file |
|---|
| 76 | must be explicitely saved when leaving the GUI (you will be automatically asked for this). |
|---|
| 77 | Once you saved your xml data, you can reload your xml file using the (File/Load as new) menu at |
|---|
| 78 | the left top of the GUI. Do not use the (File/Load as part) menu. |
|---|
| 79 | The configuration file namcouple of OASIS3-MCT will be saved, when ALL THE TABS will |
|---|
| 80 | be validated, in the repository where you saved your xml file, in a subdirectory named |
|---|
| 81 | after your xml file. |
|---|
