GSvit documentation

open source FDTD solver with GPU support

User Tools

Site Tools


start:installation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
start:installation [2018/10/12 11:19]
rslesinger
start:installation [2021/02/08 11:15] (current)
pgrolich [Binary installation]
Line 4: Line 4:
 ==== Download ==== ==== Download ====
  
-GSvit can be downloaded as stable version, which is recommended,​ either as binary +GSvit can be downloaded as stable version, which is recommended,​ either as a Windows ​binary ​installer ​or as source code. A current development version can be also obtained from Subversion repository, however this is not recommended as code under development might behave unexpectedly.
-package for many different operating systems ​or as source code. A current development +
-version can be also obtained from Subversion repository, however this is not recommended +
-as code under development might behave unexpectedly. +
-See [[http://​gsvit.net/​download.php|GSvit download pages]] for more details. +
  
 +Download links can be found at [[http://​gsvit.net/​download.php|GSvit download pages]].
 ==== Binary installation ==== ==== Binary installation ====
  
-GSvit computational core and its GUI (XSvit) are distributed together for all the platforms. ​For running ​it you need [[http://​gwyddion.net|Gwyddion]] to display the output images. Gwyddion is a data processing tool widely used in Scanning Probe Microscopy field and similar surface topography areas; in GSvit it is used for output visualisation,​ surface topography data input and some internal data management tasks. ​+For running ​GSvit you need [[http://​gwyddion.net|Gwyddion]] to display the output images. Gwyddion is a data processing tool widely used in Scanning Probe Microscopy field and similar surface topography areas; in GSvit it is used for output visualisation,​ surface topography data input and some internal data management tasks. ​
  
 If you would like to run your calculations on a computer graphics card you need to have a CUDA capable card and a NVIDIA driver installed. If you would like to run your calculations on a computer graphics card you need to have a CUDA capable card and a NVIDIA driver installed.
Line 19: Line 15:
 === Windows === === Windows ===
  
-Since version 1.6 both the computational core (GSvit) and the GUI (XSvit) are distributed in a single package. ​The installer creates a desktop icon for XSvit, so you can create the necessary files and run the calculation from this environment. Of course, you can run the computational core directly provided all the necessary files were created in beforehand. In that case you have to first start a command prompt (//​cmd.exe//​) and run GSvit from there.+The 32-bit ​installer creates a desktop icon for the parameter file viewer ​XSvit, so you can create the necessary files and run the calculation from this environment. Of course, you can run the computational core directly provided all the necessary files were created in beforehand. In that case you have to first start a command prompt (//​cmd.exe//​) and run GSvit from there.
  
-We recommend to first uninstall any pre-1.7 version of GSvit as a different set of libraries ​is distributed since version 1.8. +The 64-bit version does not contain XSvitThe reason ​is that 64-bit GtkGLExt ​libraries are not available. If you want to use XSvit with 64-bit ​GSvit, we recommend ​to install ​both the 32- and 64-bit versions (to different folders)Then set GSvit executable path in File/​Preferences ​to the 64-bit GSvit executableNow you can run more demanding computations ​from XSvit using 64-bit GSvit.
- +
-Please note that Gtk, Gwyddion and CUDA libraries are shipped ​with GSvit. You don't have to install ​them separately. +
- +
-Since we switched ​to MS Visual Studio 2015 with version 1.8.2, you need to have runtime libraries for this versionIf you have sufficiently new Windows OS (not sure what "​sufficiently"​ is), you should already have them. If not, you can download them from Microsoft websites upon registration to Microsoft.+
  
 The default installation paths on 64-bit systems are //​C:​\Program Files (x86)\GSvit\bin\gsvit3d.exe//​ for the 32-bit version, and //​C:​\Program Files\GSvit\bin\gsvit3d.exe//​ for the 64-bit version. The default installation paths on 64-bit systems are //​C:​\Program Files (x86)\GSvit\bin\gsvit3d.exe//​ for the 32-bit version, and //​C:​\Program Files\GSvit\bin\gsvit3d.exe//​ for the 64-bit version.
Line 31: Line 23:
 The 32-bit binary can run on 64-bit systems too, but there are considerable constraints to the model size due to memory addressing limitations of the 32-bit architecture. The 32-bit binary can run on 64-bit systems too, but there are considerable constraints to the model size due to memory addressing limitations of the 32-bit architecture.
  
-The 64-bit version ​does not contain the parameter file viewer XSvit. The reason is that 64-bit GtkGLExt libraries are not available. If you want to use XSvit with 64-bit ​GSvit, we recommend to install both the 32- and 64-bit versions (to different ​folders). Then set GSvit executable path in File/​Preferences to the 64-bit GSvit executableNow you can run more demanding computations from XSvit using 64-bit GSvit.+We recommend to first uninstall any pre-1.7 version ​of GSvit as a different set of libraries is distributed since version 1.8.
  
-=== Linux ===+__Visual C++ Redistributable for Visual Studio 2015__\\ 
 +Since we switched to MS Visual Studio 2015 with version 1.8.2, you need to have runtime libraries for this version. If you have sufficiently new Windows OS (not sure what '​sufficiently'​ is), you should already have them. If not, you can download the package from Microsoft websites.
  
-We already precompiled the source code for several distributions via [[https://​build.opensuse.org|openSUSE Build Service]]. Howeverthese binaries ​are compiled without GPU support. The build is performed on the following distros (i586 and x86_64 architectures):​ +Please note that GtkGwyddion and CUDA libraries ​are shipped with GSvitYou don't have to install them separately.
-  * CentOS-6 +
-  * CentOS-7 +
-  * Fedora 20 +
-  * Fedora 21 +
-  * RHEL-6 +
-  * SLE 11 SP3 +
-  * SLE 12 +
-  * Scientific Linux 7 +
-  * openSUSE 11.4 +
-  * openSUSE 12.2 +
-  * openSUSE 12.3 +
-  * openSUSE 13.+
-  * openSUSE 13.+
-  * openSUSE Factory ​+
  
-The precompiled RPMs are available from the [[http://​software.opensuse.org/​package/​gsvit|home:​miraval]] project. Please note that the build might succeed also on some other distribution. We just didn't try it. +=== Linux ===
- +
-The GSvit package is also dependent on Gwyddion'​s libraries. So you need first to install this package. You can download and install it using procedures described on the official [[http://​gwyddion.net/​download.php|Gwyddion]] pages or you can use the precompiled binaries hosted on the [[http://​software.opensuse.org/​package/​gsvit|home:​miraval]] project. ​+
  
 +Due to process complexity, precompiled packages prepared using openSUSE Build Service are no longer provided.
  
 ==== Installing from source tarball ==== ==== Installing from source tarball ====
Line 73: Line 51:
 </​code>​ </​code>​
  
-You can specify the path where to install GSvit by a configure option ''​--prefix=path''​.+You can specify the path where to install GSvit by a configure option ''​%%--%%prefix=path''​.
  
 A binary RPM can also be built from the source code tarball directly by issuing the following command: A binary RPM can also be built from the source code tarball directly by issuing the following command:
Line 80: Line 58:
 == Using a non-packaged CUDA installation == == Using a non-packaged CUDA installation ==
  
-The //PATH// variable is used to search for Nvidia'​s compiler NVCC. In order to find it, you need to set this variable accordingly,​ e.g. ''​export PATH=/​usr/​local/​cuda-X.Y/​bin:​$PATH''​. Alternatively,​ you can provide path by option ''​--with-cuda=path''​ to ''​./​configure''​.+The //PATH// variable is used to search for Nvidia'​s compiler NVCC. In order to find it, you need to set this variable accordingly,​ e.g. ''​export PATH=/​usr/​local/​cuda-X.Y/​bin:​$PATH''​. Alternatively,​ you can provide path by option ''​%%--%%with-cuda=path''​ to ''​./​configure''​.
  
 Please don't forget to adjust also your //​LD_LIBRARY_PATH//​ variable, e.g. by ''​export LD_LIBRARY_PATH=/​usr/​local/​cuda-X.Y/​lib64:/​usr/​local/​cuda-X.Y/​lib:​$LD_LIBRARY_PATH''​. Or you can update the ''/​etc/​ld.so.conf''​ file to contain the CUDA lib directory, however this needs root's permissions. Please don't forget to adjust also your //​LD_LIBRARY_PATH//​ variable, e.g. by ''​export LD_LIBRARY_PATH=/​usr/​local/​cuda-X.Y/​lib64:/​usr/​local/​cuda-X.Y/​lib:​$LD_LIBRARY_PATH''​. Or you can update the ''/​etc/​ld.so.conf''​ file to contain the CUDA lib directory, however this needs root's permissions.
Line 86: Line 64:
 == Gwyddion == == Gwyddion ==
  
-You also need to have Gwyddion open source ​software ​installed to provide output to .gwy files. If you installed Gwyddion in a nonstandard location, you have to set up the //​PKG_CONFIG_PATH//​ variable, e.g. by  ''​export PKG_CONFIG_PATH=/​home/​username/​somedir/​gwyddion-X.Y/​lib/​pkgconfig:​$PKG_CONFIG_PATH''​.+GSvit is also dependent on Gwyddion'​s libraries, so you need first to install this software. ​You can download and install it using procedures described on the official [[http://​gwyddion.net/​download.php|Gwyddion download]]. 
 + 
 +If you installed Gwyddion in a nonstandard location, you have to set up the //​PKG_CONFIG_PATH//​ variable, e.g. by  ''​export PKG_CONFIG_PATH=/​home/​username/​somedir/​gwyddion-X.Y/​lib/​pkgconfig:​$PKG_CONFIG_PATH''​.
  
 The software has primarily been tested on openSUSE, Fedora and Debian, but hopefully should run on any system with CUDA and Gwyddion. The software has primarily been tested on openSUSE, Fedora and Debian, but hopefully should run on any system with CUDA and Gwyddion.
Line 101: Line 81:
 ''​svn checkout svn:​%%//​%%svn.code.sf.net/​p/​gsvit/​code/​trunk gsvit''​. For Windows, we have good experience with TortoiseSVN as a Subversion client. ''​svn checkout svn:​%%//​%%svn.code.sf.net/​p/​gsvit/​code/​trunk gsvit''​. For Windows, we have good experience with TortoiseSVN as a Subversion client.
  
-Under Linux environment the software should be installed using the standard source installation procedure, except ''​./​configure''​ is replaced by ''​./​autogen.sh''​. Note that you can also pass arguments such as ''​--prefix=path''​.+Under Linux environment the software should be installed using the standard source installation procedure, except ''​./​configure''​ is replaced by ''​./​autogen.sh''​. Note that you can also pass arguments such as ''​%%--%%prefix=path''​.
  
 Under Windows environment we use MS Visual Studio 2015, and we can provide a solution and project files together with all the necessary dependencies upon request. This MSVC version is able to compile 64-bit binaries, and indeed we succeded to complete the build. However, the 64-bit XSvit binary behaves oddly so we decided not to publish GSvit-x64 for now. We plan to put these together with all dependencies in the svn repository. ​ Under Windows environment we use MS Visual Studio 2015, and we can provide a solution and project files together with all the necessary dependencies upon request. This MSVC version is able to compile 64-bit binaries, and indeed we succeded to complete the build. However, the 64-bit XSvit binary behaves oddly so we decided not to publish GSvit-x64 for now. We plan to put these together with all dependencies in the svn repository. ​
start/installation.1539335945.txt.gz · Last modified: 2018/10/12 11:19 by rslesinger