Skip to content

Commit

Permalink
Documentation for the vrml pyvista GUI personalization
Browse files Browse the repository at this point in the history
  • Loading branch information
tbaudier committed Jul 6, 2023
1 parent 52b51b8 commit d52fec0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/user_guide_2_0_simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ The visualisation with qt is still work in progress. First, it does not work on

You can choose vrml visualization with `ui.visu_type = "vrml"`. Opengate uses `pyvista` for the GUI, so you need to install it before with `pip install pyvista`. Alternatively, if you want to use an external VRML viewer, you can save a VRML file with `ui.visu_type = "vrml_file_only"`. In such case, the GUI is not open, and you do not need pyvista. In both cases, you need to set `ui.visu_filename = "geant4VisuFile.wrl"` to save the VRML file.

If you want to personalized the pyvista GUI, you can set `ui.visu_type = "vrml_file_only"` and execute you own code in your python script. You can find an example in [test004_simple_visu_vrml.py](https://github.com/OpenGATE/opengate/blob/master/opengate/tests/src/test004_simple_visu_vrml.py#L69-L90)

##### GDML

![](figures/visu_gdml.png)
Expand Down

0 comments on commit d52fec0

Please sign in to comment.