From cf992ae21b997639fd7ec4a270a22f93667ff3c9 Mon Sep 17 00:00:00 2001 From: vsr Date: Wed, 23 Mar 2016 12:27:53 +0300 Subject: [PATCH] Copyright update: 2016 --- AUTHORS | 0 CMakeLists.txt | 2 +- ChangeLog | 0 INSTALL | 1 - NEWS | 0 README | 190 +++++++++++++++++- SalomePYLIGHTConfig.cmake.in | 2 +- adm_local/CMakeLists.txt | 2 +- adm_local/cmake_files/CMakeLists.txt | 2 +- adm_local/cmake_files/FindSalomePYLIGHT.cmake | 2 +- adm_local/unix/CMakeLists.txt | 2 +- adm_local/unix/config_files/CMakeLists.txt | 2 +- adm_local/unix/config_files/check_PYLIGHT.m4 | 2 +- bin/CMakeLists.txt | 2 +- resources/CMakeLists.txt | 2 +- resources/LightApp.xml | 2 +- resources/PYLIGHT_en.xml | 2 +- resources/SalomeApp.xml.in | 2 +- src/CMakeLists.txt | 2 +- src/PYLIGHTGUI/CMakeLists.txt | 2 +- src/PYLIGHTGUI/PYLIGHTGUI.py | 2 +- src/PYLIGHTGUI/PYLIGHT_DataModel.py | 2 +- 22 files changed, 198 insertions(+), 27 deletions(-) delete mode 100644 AUTHORS delete mode 100644 ChangeLog delete mode 100644 INSTALL delete mode 100644 NEWS diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index e69de29..0000000 diff --git a/CMakeLists.txt b/CMakeLists.txt index 4717add..33a4fdd 100755 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2015 OPEN CASCADE +# Copyright (C) 2013-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/ChangeLog b/ChangeLog deleted file mode 100644 index e69de29..0000000 diff --git a/INSTALL b/INSTALL deleted file mode 100644 index cd1fe9c..0000000 --- a/INSTALL +++ /dev/null @@ -1 +0,0 @@ -SALOME5 : PYLIGHT module (sample) diff --git a/NEWS b/NEWS deleted file mode 100644 index e69de29..0000000 diff --git a/README b/README index 669e611..fb05d33 100644 --- a/README +++ b/README @@ -1,9 +1,181 @@ -This module is a Salome example python light module. - -Installation and compilation is like every Salome modules : - mkdir build_dir - mkdir instal_dir - cd build_dir - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=instal_dir ../src_dir - make - make install \ No newline at end of file +*************************** +About SALOME PYLIGHT sample +*************************** + +SALOME PYLIGHT module presents example of a simple SALOME module, implemented +with Python, without CORBA-engine; such type of module is called "light" in +SALOME. + +This sample demonstrates a way to create a modules which have only GUI written +in Python but nevertheless can be integrated into SALOME platform. + +This sample module is a simple text file reader. Each empty line read from the +file is presented in the data tree as the beginning of new paragraph; paragraph +can be empty. Non-empty line presents a "leaf" in the data tree. + +Thus, the data tree hierarchy has tree levels: + +Root + |__ Paragraph + | |____ Text line + | |____ Text line + | |____ ... + |__ Paragraph + |__ Paragraph + | |____ Text line + | |____ ... + |__ ... + +For more information about SALOME platform please visit the SALOME web site: + + + +======= +License +======= + +SALOME platform is distributed under the GNU Lesser General Public License. +See COPYING file for more details. + +Also, additional information can be found at SALOME platform web site: + + + +============ +Installation +============ + +-------------- +Pre-requisites +-------------- + +SALOME platform relies on a set of third-party softwares; some of them are needed +at build time only, while other ones are needed in runtime also. + +For more information about the pre-requisites please visit SALOME platform web +site: + +* Check Release Notes and Software Requirements of the latest SALOME release at + + + +* Pre-requisites page at SALOME web site: + + + +Note: SALOME PYLIGHT needs SALOME KERNEL and SALOME GUI as pre-requisites. + +------------------ +Basic Installation +------------------ + +The build procedure of the SALOME platform is implemented with CMake. +In order to build the module you have to do the following actions: + +1. Set up environment for pre-requisites (see "Pre-requisites" section above). + +2. Create a build directory: + + % mkdir PYLIGHT_BUILD + +3. Configure the build procedure: + + % cd PYLIGHT_BUILD + % cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= + + where + - is either Release or Debug (default: Release); + - is a destination folder to install SALOME PYLIGHT + module (default: /usr); + - is a path to the SALOME PYLIGHT sources directory. + + Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME PYLIGHT + module will be configured for installation to the /usr directory that requires + root permissions to complete the installation. + +4. Build and install: + + % make + % make install + + This will install SALOME PYLIGHT module to the + specified to cmake command on the previous step. + +------------------- +Custom installation +------------------- + +SALOME PYLIGHT module supports a set of advanced configuration options; +for more details learn CMakeLists.txt file in the root source directory. + +You can also use other options of cmake command to customize your installation. +Learn more about available options by typing + + % cmake --help + +============= +Functionality +============= + +The functionality of the module is very similar to that one provided by +LIGHT module. + +The module functionality includes the following user actions: + +* "File" menu: + + - "Load text file" : reads and loads the contents of text file to the + study; the previous contents of the data tree + is erased. + + - "Save text file" : dumps the contents of the data tree to the text + file. + +* "PyLight" menu: + + - "Insert Line" : inserts new text line entered by the user to the + end of selected paragraph. + + - "Edit Line" : allows user to edit selected text line. + + - "Remove Lines" : : removes selected line(s). + + - "Clear All" : clears contents of the data tree. + + - "Display Line" : displays selected line in the VTK 3D viewer. + + - "Erase Line" : erases selected line from the VTK 3D viewer. + +Most of these actions change the contents of the internal data model, so the data +tree is rebuilt correspondingly. +Some of these commands are also avaiable via the context popup menu in the Object +Browser. + +Saving/restoring of the data is performed by using of default SALOMEDS-based +persistence mechanism provided by SALOME GUI via embedded SalomeApp engine. + +Note: after opening of the sudy file the PYLIGHT module data is not +immediately displayed in the Object Browser. To see it, you should activate the +module. Such behaviour takes place because the PYLIGHT module does not publish any +data directly in the SALOMEDS study - this is typical behavior of any "lighy" +SALOME module, imposed by limitation of SALOME platform. + +===== +Usage +===== + +Run SALOME with PYLIGHT module: + +- In full, CORBA-based session: + +runSalome --modules=PYLIGHT + +- In "light" session: + +runLightSalome.sh --modules=PYLIGHT + +=============== +Troubleshooting +=============== + +Please, send a mail to webmaster.salome@opencascade.com. diff --git a/SalomePYLIGHTConfig.cmake.in b/SalomePYLIGHTConfig.cmake.in index 3b8cf65..9dd0ec5 100644 --- a/SalomePYLIGHTConfig.cmake.in +++ b/SalomePYLIGHTConfig.cmake.in @@ -5,7 +5,7 @@ # ############################################################### -# Copyright (C) 2007-2015 OPEN CASCADE +# Copyright (C) 2007-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/adm_local/CMakeLists.txt b/adm_local/CMakeLists.txt index 6e8e91c..b01f446 100755 --- a/adm_local/CMakeLists.txt +++ b/adm_local/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2015 OPEN CASCADE +# Copyright (C) 2013-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/adm_local/cmake_files/CMakeLists.txt b/adm_local/cmake_files/CMakeLists.txt index 55c0048..1165879 100755 --- a/adm_local/cmake_files/CMakeLists.txt +++ b/adm_local/cmake_files/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2015 OPEN CASCADE +# Copyright (C) 2013-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/adm_local/cmake_files/FindSalomePYLIGHT.cmake b/adm_local/cmake_files/FindSalomePYLIGHT.cmake index dae1cfc..3d7b2ee 100644 --- a/adm_local/cmake_files/FindSalomePYLIGHT.cmake +++ b/adm_local/cmake_files/FindSalomePYLIGHT.cmake @@ -1,4 +1,4 @@ -# Copyright (C) 2007-2015 OPEN CASCADE +# Copyright (C) 2007-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/adm_local/unix/CMakeLists.txt b/adm_local/unix/CMakeLists.txt index 800c376..cdd76eb 100755 --- a/adm_local/unix/CMakeLists.txt +++ b/adm_local/unix/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2015 OPEN CASCADE +# Copyright (C) 2013-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/adm_local/unix/config_files/CMakeLists.txt b/adm_local/unix/config_files/CMakeLists.txt index 835a548..3a29b83 100755 --- a/adm_local/unix/config_files/CMakeLists.txt +++ b/adm_local/unix/config_files/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2015 OPEN CASCADE +# Copyright (C) 2013-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/adm_local/unix/config_files/check_PYLIGHT.m4 b/adm_local/unix/config_files/check_PYLIGHT.m4 index c5ef89f..790e6dc 100755 --- a/adm_local/unix/config_files/check_PYLIGHT.m4 +++ b/adm_local/unix/config_files/check_PYLIGHT.m4 @@ -1,4 +1,4 @@ -# Copyright (C) 2009-2015 OPEN CASCADE +# Copyright (C) 2009-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/bin/CMakeLists.txt b/bin/CMakeLists.txt index c7f711c..9466426 100644 --- a/bin/CMakeLists.txt +++ b/bin/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2015 OPEN CASCADE +# Copyright (C) 2013-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/resources/CMakeLists.txt b/resources/CMakeLists.txt index 691d133..c2ce8d6 100755 --- a/resources/CMakeLists.txt +++ b/resources/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2015 OPEN CASCADE +# Copyright (C) 2013-2016 OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public diff --git a/resources/LightApp.xml b/resources/LightApp.xml index b0b470b..660c3aa 100644 --- a/resources/LightApp.xml +++ b/resources/LightApp.xml @@ -1,5 +1,5 @@