README

# IMASViz

**IMASViz** is a visualization tool developed within
**Integrated Modelling Analysis Suite** (**IMAS**) for the purposes of
visualizing static and dynamic IMAS data, stored within IMAS
**Interface Data Structures** (**IDSs**).

Copyright holders : Commissariat � l�Energie Atomique et aux Energies Alternatives (CEA), France;
and Laboratory for Engineering Design - LECAD, University of Ljubljana, Slovenia
CEA and LECAD authorize the use of the METIS software under the CeCILL-C open source license https://cecill.info/licences/Licence_CeCILL-C_V1-en.html  
The terms and conditions of the CeCILL-C license are deemed to be accepted upon downloading the software and/or exercising any of the rights granted under the CeCILL-C license.


## Installing and launching IMASViz from sources

### Requirements

IMASViz is only compatible with the python HLI hosted at ssh://git@git.iter.org/imas/al-python.git

IMASViz is NOT compatible with IMAS-python hosted at https://github.com/iterorganization/IMAS-Python.git 

IMASViz requires the following libraries:

- IMAS

- Python3.x and the following Python libraries:
   - PyQt5
   - pyqtgraph
   - matplotlib
   - Sphinx
   (pip3 install sphinx)
   - Sphinx RTD theme
   (pip3 install sphinx_rtd_theme)


### Obtaining the source code

Clone the IMASViz repository from **https://github.com/IRFM/IMASViz.git**.

By default, the main branch will be created.

To switch to the develop branch:

    git checkout develop

### Setting the environment

To set the environment, go to **viz** directory and set **VIZ_HOME**
and **VIZ_PRODUCTION** environment variables by executing the following
commands:

    cd viz

    # bash
    export VIZ_PRODUCTION=1
    export VIZ_HOME=$PWD
    export UDA_DISABLED=1 #disable UDA

    # csh
    setenv VIZ_PRODUCTION 1
    setenv VIZ_HOME $PWD
    setenv UDA_DISABLED 1 #disable UDA

IMASViz requires generated Python files parsers built from the IMAS Data Dictionary.
(these files are generated to folder $HOME/.imasviz/VizGeneratedCode/).
This is done by executing make command from the $VIZ_HOME directory:

        # Main command
        make

### Configuring UDA

1. The IMAS access layer used by IMASViz should support UDA for accessing remote UDA servers.

2. The file 'UDA_machines' located in directory $VIZ_HOME/config lists all tokamaks with remote UDA servers which
can be accessed from the current machine where IMASViz is installed.
Please refers to the documentation for the required prerequisites for accessing a particular remote UDA server.



### Running IMASViz from sources

    module load IMAS

    python $VIZ_HOME/imasviz/VizGUI/QtVIZ_GUI.py

### Installing and browsing IMASViz documentation

**IMASViz documentation** can be generated to multiple formats, e.g. **HTML**, **PDF**...

In $VIZ_HOME directory execute:

    make doc

    # to open PDF documentation
    xdg-open doc/build/latex/IMASViz.pdf

    # to open HTML documentation
    firefox doc/build/html/index.html




## Running IMASViz from installed modules on Gateway and ITER HPC

### GateWay HPC

Load the following modules:

    module load cineca
    module load imasenv

Check the installed IMASViz modules:

    module available imas-viz

Load a specific version of IMASViz, for example:

    module load imas-viz/2.3.7


### ITER HPC

Load the IMAS module:

    module load IMAS

Check the installed IMASViz modules:

    module available Viz

Load a specific version of IMASViz, for example:

    module load Viz/2.3.7-intel-2018a-Python-3.6.4


### Launching IMASViz

To launch **IMASViz**, execute the following command:

    viz


### IMASViz documentation

To browse IMASViz documentation, just type:

    viz_doc