PARAVIS development
PARAVIS user documentation
- - - - -5.Starting -SALOME with PARAVIS
-6.Commands -accessible in Python console
- - + + + + +5.Starting +SALOME with PARAVIS
+6.Commands +accessible in Python console
+ + +This document describes features of ParaView Python extractor using in PARAVIS module of SALOME platform. @@ -34,25 +36,8 @@ API extracted for using in SALOME Python console is similar to the server manager API of ParaView. But there are some features what is desirable to understand for effective using of extractor.
In addition to -standard SALOME environment following environment variables has to be -defined for PARAVIS building and testing:
-PVHOME â - points to installation directory of ParaView.
-PVVERSION - â defines a number of installed ParaView version.
-PATH="${PVHOME}/bin:${PATH}"
-LD_LIBRARY_PATH=â${PVHOME}/bin:${PVHOME}/lib/paraview-${PVVERSION}:${LD_LIBRARY_PATH}"
-PYTHONPATH="${PVHOME}/bin:${PVHOME}/lib/paraview-${PVVERSION}:${PYTHONPATH}"
-TESTDIR â - points to a directory which contains test script files. Usually it - is PARAVIS_SRC/test.
-PVDATA â - points to ParaViewData directory.
-Also it is -necessary to check that PARAVIS_SRC directory contains following +
It is +necessary to check that PARAVIS_SRC directory contains following files and they are up-to-date:
src/Paraview/lex.yy.c
@@ -69,42 +54,37 @@ same version supplied with ParaView for all components and modules of SALOME.For this -purposes a new option â--with-paraviewâ has been defined for -configure script. This option configures building procedure to use -VTK from ParaView. It means that GUI package and all modules has to -be configured with this option.
+purposes a new option “--with-paraview” has been defined +for configure script. This option configures building procedure to +use VTK from ParaView. It means that GUI package and all modules has +to be configured with this option.
- Call build_configure - script in sources directory: + Call cmake in a build directory:
- > - build configure
-Launch configure script from a build directory. -
-> ../PARAVIS_SRC/configure --prefix=$PARAVIS_ROOT_DIR
+ > + ccmake ../PARAVIS_SRCCall make command in build directory.
> make
- Call - make install command - in build directory. + Call + make install command in build directory.
- > make - install
+ > make + install> runSalome âmodules="PARAVIS"
+> runSalome –modules="PARAVIS"
If it is necessary then other SALOME modules can be added to -âmodulesâ list separated by comma.
+“modules” list separated by comma.Loading ParaView Python API for PARAVIS can be done with help of @@ -120,8 +100,9 @@ which can start/stop trace in any moment, in PARAVIS trace is activating or deactivating for whole session.
Trace functionality can be switched on/off in SALOME preferences dialog box in PARAVIS tab (main menu | Preferences...). It contains -check box âDeactivate Traceâ. By default the trace is activated. -Change of check box state makes effect only for next session.
+check box “Deactivate Trace”. By default the trace is +activated. Change of check box state makes effect only for next +session.User can get the trace with help of two commands (after pvsimple import):
SaveTrace(fileName) - saves the trace into a given disk file.
Also trace is using for âDump Studyâ functionality. But if the -tracing is switched off then âDump Studyâ doesn't saves PARAVIS -module state.
+Also trace is using for “Dump Study” functionality. +But if the tracing is switched off then “Dump Study” +doesn't saves PARAVIS module state.
On SALOME study saving PARAVIS module data is also saved in the study. This data is saved in form of ParaView state file. ParaView state file could have references on external files imported during PARAVIS working session. These referenced files can be saved with the -current study depending on preference âParaview state saving typeâ -defined in PARAVIS preferences dialog box. This preference can have -three possible state:
+current study depending on preference “Paraview state saving +type” defined in PARAVIS preferences dialog box. This +preference can have three possible state:âSave referenced files only for built-in serverâ. In case - if this option is active then referenced files will be saved in - study together with ParaView state only if in PARAVIS was used +
“Save referenced files only for built-in server”. + In case if this option is active then referenced files will be saved + in study together with ParaView state only if in PARAVIS was used built-in ParaView server. In case of remote ParaView server the state will be saved as it is without referenced files.
-âAlways save referenced files if they are accessibleâ. In - this case referenced files will be saved with ParaView state for any - type of ParaView server but only in case if they are accessible +
“Always save referenced files if they are accessible”. + In this case referenced files will be saved with ParaView state for + any type of ParaView server but only in case if they are accessible across local file system.
-âNever save referenced filesâ. In this case referenced - files will be never saved with ParaView state.
+“Never save referenced files”. In this case + referenced files will be never saved with ParaView state.
It is necessary to be aware that if referenced files are not saved in study then there is no guarantee that the saved study will be @@ -173,5 +154,13 @@ appeared after SALOME launch. Other desktops, even they opened with study containing PARAVIS data, can not load PARAVIS module.
If it is necessary to define a spcific command line +parameters for ParaView application then it can be defined with help +of PARAVIS_OPTIONS environment variable. For example:
+export PARAVIS_OPTIONS=--server=myServer
+If it is necessary to define several command line +parameters then these parameters has to be separated by “:” +symbol.
\ No newline at end of file