From 4e77c16c3d12e269d0544f35977aa5437bec7ffc Mon Sep 17 00:00:00 2001 From: Ovidiu Mircescu Date: Tue, 22 Apr 2014 16:14:15 +0200 Subject: [PATCH] Update documentation in "Examples" --- Examples/README.txt | 8 ++++++++ Examples/clean.sh | 2 ++ Examples/cpp1/README.txt | 12 ++---------- Examples/cpp2/README.txt | 17 +++-------------- Examples/fort1/README.txt | 20 ++------------------ Examples/fort2/README.txt | 21 +++------------------ Examples/pygui1/README.txt | 12 ++---------- Examples/pyth1/README.txt | 12 ++---------- Examples/pyth2/README.txt | 12 ++---------- Examples/test_compo.py | 2 ++ Examples/types1/README.txt | 12 ++---------- 11 files changed, 30 insertions(+), 100 deletions(-) create mode 100644 Examples/README.txt diff --git a/Examples/README.txt b/Examples/README.txt new file mode 100644 index 0000000..415d042 --- /dev/null +++ b/Examples/README.txt @@ -0,0 +1,8 @@ +Here you find examples of use of YACSGEN for every type of component. + +In order to build and test the examples, you have to: +- change the SALOME installation directory in exec.sh (SALOME_DIR) +- run "build.sh" + +Every example contains a "build.sh" script which shows you how to build and +test it. In the main directory, it builds and tests all the examples. diff --git a/Examples/clean.sh b/Examples/clean.sh index fa3620c..4908e47 100755 --- a/Examples/clean.sh +++ b/Examples/clean.sh @@ -1,4 +1,6 @@ #/bin/bash +# clean all examples + script_dir=`dirname $0` cd $script_dir diff --git a/Examples/cpp1/README.txt b/Examples/cpp1/README.txt index 6703a62..db8d590 100644 --- a/Examples/cpp1/README.txt +++ b/Examples/cpp1/README.txt @@ -1,16 +1,8 @@ A C++ component dynamically loadable ========================================= -To build this example, modify the ../context.py file -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py :: - - source - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build and test the component. You should get a SALOME module in source form (cppcompos_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module cppcompos. diff --git a/Examples/cpp2/README.txt b/Examples/cpp2/README.txt index d167aa3..eefacf6 100644 --- a/Examples/cpp2/README.txt +++ b/Examples/cpp2/README.txt @@ -1,23 +1,12 @@ A C++ standalone component (executable form) ================================================= -To build this example, modify the ../context.py file -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py :: - - source - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build and test the component. You should get a SALOME module in source form (cppcompos_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module cppcompos. - -To build the standalone component (executable named prog), execute the Makefile in the SALOME application environment:: - - ./appli/runSession make +You also get the standalone component (executable named prog). To run a coupling: diff --git a/Examples/fort1/README.txt b/Examples/fort1/README.txt index 846cd4c..57b8242 100644 --- a/Examples/fort1/README.txt +++ b/Examples/fort1/README.txt @@ -1,24 +1,8 @@ A Fortran component dynamically loadable ============================================= -To build this example, modify the ../context.py, ../makefile.inc and Makefile files -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR -3- your FORTRAN compiler - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here):: - - source - -Build the code1 et code2 libraries :: - - make - -and process components.py :: - - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build and test the component. You should get a SALOME module in source form (fcompos_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module fcompos. diff --git a/Examples/fort2/README.txt b/Examples/fort2/README.txt index ded4620..2f50e5c 100644 --- a/Examples/fort2/README.txt +++ b/Examples/fort2/README.txt @@ -1,27 +1,12 @@ A Fortran standalone component ================================= -To build this example, modify the ../context.py, ../makefile.inc and Makefile files -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR -3- your FORTRAN compiler - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here):: - - source - -and process components.py :: - - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build and test the component. You should get a SALOME module in source form (fcompos_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module fcompos. - -Build the code1 et code2 executables under the SALOME application environment:: - - ./appli/runSession make +You also get the code1 et code2 executables. To run a coupling: diff --git a/Examples/pygui1/README.txt b/Examples/pygui1/README.txt index fb47288..ee11054 100644 --- a/Examples/pygui1/README.txt +++ b/Examples/pygui1/README.txt @@ -1,16 +1,8 @@ A Python component dynamically loadable =============================================== -To build this example, modify the ../context.py file -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py :: - - source - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build the component. You should get a SALOME module in source form (pycompos_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module pycompos. diff --git a/Examples/pyth1/README.txt b/Examples/pyth1/README.txt index 0b89847..d57211f 100644 --- a/Examples/pyth1/README.txt +++ b/Examples/pyth1/README.txt @@ -1,16 +1,8 @@ A Python component dynamically loadable =============================================== -To build this example, modify the ../context.py file -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py :: - - source - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build and test the component. You should get a SALOME module in source form (pycompos_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module pycompos. diff --git a/Examples/pyth2/README.txt b/Examples/pyth2/README.txt index 88498ae..05ea69a 100644 --- a/Examples/pyth2/README.txt +++ b/Examples/pyth2/README.txt @@ -1,16 +1,8 @@ A Python standalone component (in executable form) ======================================================= -To build this example, modify the ../context.py file -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py :: - - source - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build and test the component. You should get a SALOME module in source form (pycompos_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module pycompos. diff --git a/Examples/test_compo.py b/Examples/test_compo.py index a76bed3..d006b7e 100755 --- a/Examples/test_compo.py +++ b/Examples/test_compo.py @@ -1,5 +1,7 @@ #! /usr/bin/env python # -*- coding: utf-8 -*- +# This test executes the coupling.xml schema found in the current directory +# and verifies the execution state. import unittest import os diff --git a/Examples/types1/README.txt b/Examples/types1/README.txt index 7769282..2fc0fbf 100644 --- a/Examples/types1/README.txt +++ b/Examples/types1/README.txt @@ -1,16 +1,8 @@ A test for several YACS types SALOME_TYPES and others ========================================================= -To build this example, modify the ../context.py file -to take into account your configuration. - -1- your prerequisite file -2- your KERNEL_ROOT_DIR - -Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py :: - - source - python components.py +To build this example, modify the ../exec.sh file to take into account your configuration. +Run build.sh to build and test the component. You should get a SALOME module in source form (module_SRC), its installation (install) and a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module module. -- 2.39.2