doc/UserDocumentation.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <HTML>
   3 <HEAD>
   4         <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
   5         <TITLE></TITLE>
   6         <META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.5  (Linux)">
   7         <META NAME="CREATED" CONTENT="20100112;19261000">
   8         <META NAME="CHANGED" CONTENT="20100528;14505900">
   9 </HEAD>
  10 <BODY LANG="en-US" DIR="LTR">
  11 <P ALIGN=CENTER><FONT SIZE=6><B>PARAVIS development</B></FONT></P>
  12 <P ALIGN=CENTER><FONT SIZE=6><B>PARAVIS user documentation</B></FONT></P>
  13 <P STYLE="page-break-before: always"><A HREF="#1.Introduction|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">1.Introduction</FONT></SPAN></B></A></P>
  14 <P><A HREF="#2.Building environment|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">2.Building
  15 environment</FONT></SPAN></B></A></P>
  16 <P><A HREF="#3.VTK library|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">3.VTK
  17 library</FONT></SPAN></B></A></P>
  18 <P><A HREF="#4.Building of PARAVIS|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">4.Building
  19 of PARAVIS</FONT></SPAN></B></A></P>
  20 <P><A HREF="#5.Starting SALOME with PARAVIS|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">5.Starting
  21 SALOME with PARAVIS</FONT></SPAN></B></A></P>
  22 <P><A HREF="#6.Commands accessible in Python console|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">6.Commands
  23 accessible in Python console</FONT></SPAN></B></A></P>
  24 <P><A HREF="#7.Trace management|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">7.Trace
  25 management</FONT></SPAN></B></A></P>
  26 <P><A HREF="#8.PARAVIS GUI specific|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">8.PARAVIS
  27 GUI specific</FONT></SPAN></B></A></P>
  28 <P><A HREF="#PARAVIEW options|outline"><B><SPAN LANG="fr-FR"><FONT SIZE=4 STYLE="font-size: 15pt">9.
  29 PARAVIEW options</FONT></SPAN></B></A></P>
  30 <H1><A NAME="1.Introduction|outline"></A>Introduction</H1>
  31 <P STYLE="margin-bottom: 0in">This document describes features of
  32 ParaView Python extractor using in PARAVIS module of SALOME platform.
  33 In general building of PARAVIEW module is not too much differ from
  34 usual process of any other SALOME module building, and result Python
  35 API extracted for using in SALOME Python console is similar to the
  36 server manager API of ParaView. But there are some features what is
  37 desirable to understand for effective using of extractor.</P>
  38 <H1><A NAME="2.Building environment|outline"></A>Building environment</H1>
  39 <P STYLE="margin-bottom: 0in; page-break-inside: auto">It is
  40 necessary to check that PARAVIS_SRC directory contains following
  41 files and they are up-to-date:</P>
  42 <OL>
  43         <LI><P STYLE="margin-bottom: 0in; page-break-inside: auto">src/Paraview/lex.yy.c</P>
  44         <LI><P STYLE="margin-bottom: 0in; page-break-inside: auto">src/Paraview/vtkParse.tab.c</P>
  45         <LI><P STYLE="margin-bottom: 0in; page-break-inside: auto">src/Paraview/vtkParse.h</P>
  46 </OL>
  47 <H1><A NAME="3.VTK library|outline"></A>VTK library</H1>
  48 <P STYLE="margin-bottom: 0in; page-break-inside: auto">SALOME already
  49 uses VTK library for visualization and post-processing purposes.
  50 PARAVIS also uses VTK library supplied with ParaView. In order to
  51 avoid problem with using of different versions of VTK library in
  52 different components of SALOME platform it is necessary to use the
  53 same version supplied with ParaView for all components and modules of
  54 SALOME.
  55 </P>
  56 <P STYLE="margin-bottom: 0in; page-break-inside: auto">For this
  57 purposes a new option &ldquo;--with-paraview&rdquo; has been defined
  58 for configure script. This option configures building procedure to
  59 use VTK from ParaView. It means that GUI package and all modules has
  60 to be configured with this option.</P>
  61 <H1><A NAME="4.Building of PARAVIS|outline"></A>Building of PARAVIS</H1>
  62 <P STYLE="margin-bottom: 0in; page-break-inside: auto"><BR>
  63 </P>
  64 <OL>
  65         <LI><P ALIGN=JUSTIFY STYLE="margin-bottom: 0.08in; page-break-inside: auto; widows: 2; orphans: 2">
  66         Call <B>cmake</B> in a build directory:
  67         </P>
  68         <P ALIGN=JUSTIFY STYLE="margin-bottom: 0.08in; page-break-inside: auto; widows: 2; orphans: 2">
  69         <I><FONT SIZE=3><FONT FACE="Nimbus Roman No9 L"><FONT COLOR="#000000">&gt;
  70         ccmake ../PARAVIS_SRC</FONT></FONT></FONT></I></P>
  71         <LI><P>Call <B>make</B> command in build directory.
  72         </P>
  73         <P><I>&gt; make</I></P>
  74         <LI><P ALIGN=JUSTIFY STYLE="margin-bottom: 0.08in; page-break-inside: auto; widows: 2; orphans: 2">
  75         <FONT FACE="Nimbus Roman No9 L"><B><FONT SIZE=2><FONT COLOR="#000000">Call
  76         </FONT></FONT>make install</B> command in</FONT> build directory.
  77         </P>
  78         <P ALIGN=JUSTIFY STYLE="margin-bottom: 0.08in; page-break-inside: auto; widows: 2; orphans: 2">
  79         <FONT FACE="Nimbus Roman No9 L"><FONT SIZE=3><I>&gt; <FONT COLOR="#000000">make
  80         </FONT>install</I></FONT></FONT></P>
  81 </OL>
  82 <H1 ALIGN=LEFT STYLE="margin-top: 0.42in; margin-bottom: 0.08in; page-break-inside: avoid; widows: 2; orphans: 2; page-break-after: avoid"><A NAME="5.Starting SALOME with PARAVIS|outline"></A>
  83 <FONT COLOR="#000000"><FONT FACE="Arial, sans-serif"><FONT SIZE=4 STYLE="font-size: 16pt"><B>Starting
  84 SALOME with PARAVIS</B></FONT></FONT></FONT></H1>
  85 <P>&gt; runSalome &ndash;modules=&quot;PARAVIS&quot;</P>
  86 <P>If it is necessary then other SALOME modules can be added to
  87 &ldquo;modules&rdquo; list separated by comma.</P>
  88 <H1><A NAME="6.Commands accessible in Python console|outline"></A>Commands
  89 accessible in Python console</H1>
  90 <P>Loading ParaView Python API for PARAVIS can be done with help of
  91 command:</P>
  92 <P><I>&gt; from pvsimple import *</I></P>
  93 <P>This command makes accessible the same Python API what provided by
  94 simple.py module in ParaView (see ParaView documentation).
  95 </P>
  96 <H1><A NAME="7.Trace management|outline"></A>Trace management</H1>
  97 <P>Last version of ParaView is supplied with trace functionality.
  98 PARAVIS also supports this feature. But in contrary to ParaView,
  99 which can start/stop trace in any moment, in PARAVIS trace is
 100 activating or deactivating for whole session.</P>
 101 <P>Trace functionality can be switched on/off in SALOME preferences
 102 dialog box in PARAVIS tab (main menu | Preferences...). It contains
 103 check box &ldquo;Deactivate Trace&rdquo;. By default the trace is
 104 activated. Change of check box state makes effect only for next
 105 session.</P>
 106 <P>User can get the trace with help of two commands (after pvsimple
 107 import):</P>
 108 <OL>
 109         <LI><P>PrintTrace() - prints the trace content directly into Python
 110         console window.</P>
 111         <LI><P>SaveTrace(fileName) - saves the trace into a given disk file.</P>
 112 </OL>
 113 <P>Also trace is using for &ldquo;Dump Study&rdquo; functionality.
 114 But if the tracing is switched off then &ldquo;Dump Study&rdquo;
 115 doesn't saves PARAVIS module state.</P>
 116 <H1>SALOME study save</H1>
 117 <P>On SALOME study saving PARAVIS module data is also saved in the
 118 study. This data is saved in form of ParaView state file. ParaView
 119 state file could have references on external files imported during
 120 PARAVIS working session. These referenced files can be saved with the
 121 current study depending on preference &ldquo;Paraview state saving
 122 type&rdquo; defined in PARAVIS preferences dialog box. This
 123 preference can have three possible state:</P>
 124 <OL>
 125         <LI><P>&ldquo;Save referenced files only for built-in server&rdquo;.
 126         In case if this option is active then referenced files will be saved
 127         in study together with ParaView state only if in PARAVIS was used
 128         built-in ParaView server. In case of remote ParaView server the
 129         state will be saved as it is without referenced files.</P>
 130         <LI><P>&ldquo;Always save referenced files if they are accessible&rdquo;.
 131         In this case referenced files will be saved with ParaView state for
 132         any type of ParaView server but only in case if they are accessible
 133         across local file system.</P>
 134         <LI><P>&ldquo;Never save referenced files&rdquo;. In this case
 135         referenced files will be never saved with ParaView state.</P>
 136 </OL>
 137 <P>It is necessary to be aware that if referenced files are not saved
 138 in study then there is no guarantee that the saved study will be
 139 opened correctly on other station or if the referenced files will be
 140 moved or deleted.</P>
 141 <H1><A NAME="8.PARAVIS GUI specific|outline"></A>PARAVIS GUI specific</H1>
 142 <P STYLE="margin-bottom: 0in; page-break-inside: auto">In fact
 143 PARAVIS is a ParaView GUI integrated into SALOME environment. General
 144 architecture of ParaView is very different from general architecture
 145 of SALOME. If SALOME is an application which is able to open several
 146 documents (studies) within one application session because it has
 147 multi-document architecture, then ParaView has a single document
 148 architecture what means that it can have only one document (data
 149 structure) opened within one session.</P>
 150 <P STYLE="margin-bottom: 0in; page-break-inside: auto">This leads to
 151 the fact that PARAVIS module can be opened only once within SALOME
 152 application session. It can be opened only in a first desktop
 153 appeared after SALOME launch. Other desktops, even they opened with
 154 study containing PARAVIS data, can not load PARAVIS module.</P>
 155 <P ALIGN=LEFT><BR><BR>
 156 </P>
 157 <H1><A NAME="PARAVIEW options|outline"></A>PARAVIEW options</H1>
 158 <P ALIGN=LEFT>If it is necessary to define a spcific command line
 159 parameters for ParaView application then it can be defined with help
 160 of PARAVIS_OPTIONS environment variable. For example:</P>
 161 <P ALIGN=LEFT>export PARAVIS_OPTIONS=--server=myServer</P>
 162 <P ALIGN=LEFT>If it is necessary to define several command line
 163 parameters then these parameters has to be separated by &ldquo;:&rdquo;
 164 symbol.</P>
 165 </BODY>
 166 </HTML>