====== Gwyscope GUI installation ======

Graphical user interface is designed to be run on user's computer (not on the Gwyscope boards). The computer has to be connected to a network as the GUI connects to Gwyscope boards using Ethernet interface.

To install and run the GUI, use the following guidance:

===== Linux =====

**Stable** version can downloaded from [[https://sourceforge.net/p/gwyscope/code/HEAD/tree/|Sourceforge repository]]. For example version of Gwyscope GUI that is matched to V4 version of electronic boards can be downloaded [[https://sourceforge.net/p/gwyscope/code/HEAD/tree/hardware_documentation/V4/gwyscope-1.0.tar.xz|here]]. Download it to your PC and unpack it using ''7z'' and ''tar'':

<code>
7z x -so gwyscope-1.0.tar.xz | tar xf -
</code>

Gwyscope GUI is compiled using standard ''./configure'', ''make'' and ''make install'' procedure. Note that it depends on [[https://gwyddion.net/|Gwyddion]] and [[https://sourceforge.net/projects/libgwyscan/|libgwyscan]]. Change to ''gwyscope-1.0'' directory and call ''./configure'' with ''PKG_CONFIG_PATH'' variable pointing to directories with Gwyddion's and libgwyscan's .pc files. Optionally set the ''%%--%%prefix'' switch to your preferred installation directory.

<code>
PKG_CONFIG_PATH=/home/valtr/run/gwyddion/lib64/pkgconfig:/home/valtr/run/libgwyscan/lib64/pkgconfig:$PKG_CONFIG_PATH ./configure --prefix=/home/valtr/run/gwyscope
</code>

After successful compilation and installation, the Gwyscope GUI binary can be run as follows:

<code>
/prefix/bin/gwyscope
</code>

Gwyscope GUI should show up. Note that the IP address and port of the hwserver that we want to connect to is stored in ''/home/username/.gwyscope/gwyscope.ini'' file and it has to be changed to valid values.

{{ :wiki:gui:gwyscope_gui.png?400 }}

**Development** versions are available from Sourceforge too. Use ''svn'' to checkout the latest version and then follow the ''./configure, make, make install'' procedure similarly as described above.

<code>
svn checkout https://svn.code.sf.net/p/gwyscope/code/gwyscope
</code>

Update to latest version can be done using ''svn up'' command called in the ''gwyscope'' directory.

===== Windows =====

So far only **unstable** versions are available for download. They can be downloaded from Sourceforge repository [[https://sourceforge.net/p/gwyscope/code/HEAD/tree/hardware_documentation/unstable/|here]].

After download click on the .exe file and allow making changes to your PC. Accept the license and click ''Next''

{{ :wiki:gui:gui_lic.png?400 }}

We recommend to leave install path in its default value. Click on ''Next''.

{{ :wiki:gui:gui_path.png?400 }}

Leave the ''Create a desktop shortcut'' box checked and click ''Next''.

{{ :wiki:gui:gui_shortcut.png?400 }}

Click on ''Install''.

{{ :wiki:gui:gui_install.png?400 }}

Click ''Finish'' to exit setup.

{{ :wiki:gui:gui_finish.png?400 }}

To start Gwyscope GUI click on the ''GwyScope (32-bit)'' shortcut. The Gwyscope GUI together with a debug console should show up.

{{ :wiki:gui:gwyscope_gui_win.png?400 }}

Gwyscope tries to connect to the hwserver using default IP address and port. This has to be changed according to the local configuration. Close Gwyscope, open ''C:\Users\username\.gwyscope\gwyscope.ini'' file and modify the first two parameters (''hardware_server'' and ''port'') according to your setup. Note that the ''username'' in the .ini file path has to be changed too. Now start the hwserver (see [[hwboxserver|Starting hwserver]] for details) and run the Gwyscope GUI again. If a successful connection is established, you should see in the debug console ''starting hw loop, server ...'', otherwise ''Cannot send message'' or ''Cannot connect to address...'' messages are printed.

{{ :wiki:gui:gwyscope_gui_win_connect.png?400 }}

**Development** version is available from Sourceforge repository [[https://sourceforge.net/p/gwyscope/code/HEAD/tree/gwyscope/|here]]. Currently, we use MS Visual Studio 2022 for source files compilation. Solution and project files are stored in the msvc2022 directory. In order to checkout source files from the repository, the [[https://tortoisesvn.net/|TortoiseSVN]] package is recommended. Note that there are several dependencies (Gwyddion, GTK, libgwyscan and Python2.7) that have to be also installed. Details will be provided upon request. Ask <petr.grolich@cmi.gov.cz> for assistance.