imas-paraview 2.0.0

Tool to convert IMAS Generalized Grid Description (GGD) structures to VTK, together with a few plugins to visualize GGD and non-GGD IMAS data in ParaView.

IMAS-ParaView

IMAS-ParaView is a tool to convert GGD (Generalized Grid Description) structures to VTK formats, and back. This is complemented by a number of Paraview plugins that can visualise both GGD and non-GGD IDS data in Paraview.

For an overview of the different types of IDS data that can be loaded, see the documentation.

Installation

For instructions on how to install IMAS-ParaView, please have a look at the installation instructions.

Documentation

Documentation is autogenerated from the source using Sphinx and can be found at the Read the Docs.

The documentation can be manually generated by installing sphinx and running:

make -C docs html

Open docs/_build/html/index.html.

If some dependencies are missing, create a python virtual environment and install them:

python -m venv --system-site-packages venv
source venv/bin/activate
pip install --upgrade .[docs]
make -C docs clean html