1 ********************************
2 About SALOME PYCALCULATOR sample
3 ********************************
5 PYCALCULATOR module implements a sample of Python-based SALOME component.
6 It shows an example of a module that interfaces with SALOME FIELDS.
8 For more information please visit the SALOME platform web site:
10 <https://www.salome-platform.org/>
16 SALOME platform is distributed under the GNU Lesser General Public License.
17 See COPYING file for more details.
27 SALOME platform relies on a set of third-party softwares; some of them are needed
28 at build time only, while other ones are needed in runtime also.
30 For more information about the pre-requisites please visit SALOME platform web
33 * Check Release Notes and Software Requirements of the latest SALOME release at
35 <https://www.salome-platform.org/?page_id=15/>
37 Note: SALOME PYCALCULATOR needs SALOME KERNEL and SALOME FIELDS modules as
44 The build procedure of the SALOME platform is implemented with CMake.
45 In order to build the module you have to do the following actions:
47 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
49 2. Create a build directory:
51 % mkdir PYCALCULATOR_BUILD
53 3. Configure the build procedure:
55 % cd PYCALCULATOR_BUILD
56 % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
59 - <mode> is either Release or Debug (default: Release);
60 - <installation_directory> is a destination folder to install SALOME PYCALCULATOR
61 module (default: /usr);
62 - <path_to_src_dir> is a path to the SALOME PYCALCULATOR sources directory.
64 Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME PYCALCULATOR
65 module will be configured for installation to the /usr directory that requires
66 root permissions to complete the installation.
73 This will install SALOME PYCALCULATOR module to the <installation_directory>
74 specified to cmake command on the previous step.
80 SALOME PYCALCULATOR module supports a set of advanced configuration options;
81 for more details learn CMakeLists.txt file in the root source directory.
83 You can also use other options of cmake command to customize your installation.
84 Learn more about available options by typing
92 Please, send a mail to webmaster.salome@opencascade.com.