Skip to main content »

Trinity College Dublin

TVS 2.0

TVS (Trinity Visualisation Suite) is TCHPC's home grown Scientific Visualisation software, which allows us to deploy custom-built software to satisfy the needs of the different groups that it supports.

Documentation:

Usage


To open a file, you have four options: you can run TVS 2 by using the command line and then type the name of the file that you want to load after "TVS2", you can select the instance (or instances, if you want the file loaded into more than one) and then click on the "Open file" option in either the main window tool bar or the main window top menu. Also, you can drag and drop the icon of the file to the TVS2 instance that you want that file loaded into (particularly useful when you are working with multiple instances), or you you can go to any specific instance and then click on its Open file button.

To create multiple instances, you can use the button in the main window toolbar; each time that you press it, a new instance will be generated. Another option is to clone any of the existing instances by right clicking on it, thus brining a contextual menu, and then choosing the "Clone" option, that will replicate the content of the chosen instance into a new one.

To select multiple instances, you can hit Ctrl+A (provided that you want to select all of them) or go to the mainwindow tool bar and choose the select all or leave the Ctrl key pressend and then proceed to click the specific instances that you want to select.

To link multiple instances together, first you must select the instances that you want to link, and then you have three options: you can press the Ctrl+L hotkeys, you can go to the main window menu and, under the "View" submenu, choose the "Link instances" option; or you can choose the link button on the main window tool bar. Linking multiple instances makes all the changes to the camera on any of them to propagate to the other ones, which can be useful when you want to compare different datasets from exactly the same point of view.

To save a status file, which lets you save the current state of the files loaded into TVS2 so you can later recover it, you can go to the main window menu and, under the "Tools" submenu, choose the "Save Status" option, or you can choose directly that option from the main window toolbar. To load a status file, you simply have to load it like any other file.

To create a recording file, which lets you not only to save the current state of the files loaded into TVS2 but to record as well everything that you do on the software until you stop and save the recording, so you can later replay it, and also to dump the content of the windows, therefore you can create a movie with what you did during that period of time, you can simply hit Ctrl+R to start and stop recording (this is recomended as it is the fastest way), or you can go to the main window menu and, under the Tools submenu, choose the Start Recording option. To load a recording file, you simply have to load it like any other data file.

To take a screen capture, you have two mayor options, depending on whether you want to capture all the window (including the GUI or) just the OpenGL (3d) context of a single instance. To take a capture of the whole screen (extremely useful if you need to capture multiple instances), press the Screen Capture option on the mainwindow toolbar. If you just want to capture the OpenGl content of a single instance instead, just click on the camera icon of that instance

To activate or deactivate stereo rendering, there are also two possibilities - the easier is to press Ctrl+S; the other way to activate the quadbuffered stereo is to go to the main window menu and, under the View submenu, choose the Activate Stereo option.

Hot keys


Ctrl + A To select all the instances Shift + Left Arrow To rotate the instance to the left
Ctrl + C To clear an instance out of data Shift + Right Arrow To rotate the instance to the right
Ctrl + F To toggle fullscreen on / off Shift + Up Arrow To rotate the instance to up
Ctrl + L To link selected instances together Shift + Down Arrow To rotate the instance to down
Ctrl + O To open a file
Ctrl + P To show / hide the frames per second
Ctrl + Q To quit the program
Ctrl + R To start and stop recording
Ctrl + S To toggle quad buffered stereo on / off

Main window toolBar options


Create new instance Click here to create a new instance in TVS 2.0.
Open fileClick here to open a file in the selected instances (if multiple instances are selected), or in the only one, if only one has been created.
Link instancesUse this option to link several selected instances together; or, if, in a group of selected instances, only one of them has been selected, click here to remove it from that group.
Screen Capture This option lets the user take a screen capture of all the current TVS window. Take into account that only the 3d image will be saved to a file; the upper toolbar and rightframe will not be saved to the capture.
Customized Tools Please refer to the documentation tab for the appropriate dataset to read the documentation about the specific tools provided for that particular dataset.
Save Status This options allows the user to save the current state of the program into a single file (by \current state\ we mean the number of instances, the datafiles loaded into them, the position of the cameras on each instances and the configuration of the datasets for each one of the instances - for example thresholds and the color of each isosurfaces, etc)
Exit Click here to exit TVS 2.0.

Instance toolBar options


Color This small square tell you which group of linked instances this instance belongs to. You can also select all the instances in the group by clicking this square.
Open file Click this icon to choose a file supported by TVS 2.0 and add it to this instance.
Clean instance Removes all the datasets loaded into this particular instance.
Fullscreen Click here to resize the TVS 2.0 window to fit the size of the desktop and hide the window frame.
Hide toolbar Since the toolbar and rightframe of each instance can take up quite a lot of space in a small desktop or if too many instanceshave been opened, the options to show and hide both parts of the instance have been provided.
Hide frame See entry above.
Close Clicking this will close this particular instance, thus deleting all the information contained on it.
Take capture This option lets the user take a screen capture of the OpenGL context of this instance. Take into account that only the 3d image will be saved to a file; the upper toolbar and rightframe will not be saved to the capture.
Run tools Please refer to the documentation tab for the appropriate dataset to read the documentation about the specific tools provided for that particular dataset.

Vasp rightframe options and tools


File Displays the name of the loaded file. If the dataset does not match a file, this field will remain empty until the dataset is saved.
Show frame for this dataset Since multiple datasets can be loaded into a single instance and the spaced required for each one is quite large you can uncheck this option to hide all the right frame data for a particular dataset.
Save file Click this button to save the dataset as a Vasp file - its default name will be the name of the compound.
Grid size This field states the size of this dataset's grid.
Name of the compound The name of the compound, as loaded from the VASP files, or, if the dataset has been generated out of other datasets, it will be automatically generated from the input datasets.
Density Threshold This field states the value of the electronic density that the isosurface shows.
Set surface color Click this button and a menu will appear, in which you can choose any color that you might want to be used on the isosurface.
Highlight oringinal grid Check this checkbox to highlight the grid of the original lattice.
Draw bonds The values stated in this fields will state which bonds are drawn and which ones are not.
Copies in different directions In this fields, you can choose how many copies in each direction will be rendered into the screen.
List of atom types and colors This field contains a list with the different kinds of atoms. Double clicking any of them will open a menu that lets you customize the color of that particular type of atom. If the file is a Vasp 5+ one (ie the atoms are being specified by their element symbol), all the atoms of that type will change to the desired color. This configuration will also be saved to the configuration file and will be used later on when TVS 2.0 is used again.

Vasp Tools

The Vasp tools can be accessed from the tool bar (by clicking the cogs icon), by right clicking and choosing the "Tools" option on the contextual menu, or by clicking the main window's tool bar's "Customized Tools" button.

By doing that, a new window called "TVS 2.0 tools window" will appear. In this window, all the loaded datasets will be shown (along with information about what kind of data it is and in which instances the datasets have been loaded), and the ones for which TVS tools have been implemented will display a checkable check box.

Below the list of datasets, there is a list of the actions that can be taken with the selected datasets (as, for example, to add or differentiate them); then, depending on the types of datasets that have been selected, additional options will be displayed (for example, if in the dataset there are atoms that have to be handled in a specific manner.

After that, the location of the resulting dataset, if any, has to be specified as well. Any of the current instances or a new one can be chosen. Also, if the dataset is based on three dimensional grid, the user can check whether he wants to keep any of the original grids or state an entirely different one for the new dataset.

Finally, by clicking on the "Run tools" button located at the bottom of the window, the software will proceed to perform the operations that have been requested; if any of the options that have been specified is not valid, a warning message will appear and the user will be prompted to go back to the window and change any invalid option.

XCrysden rightframe options and tools


File Displays the name of the loaded file. If the dataset does not match a file, this field will remain empty until the dataset is saved.
Show frame for this dataset Since multiple datasets can be loaded into a single instance and the spaced required for each one is quite large you can uncheck this option to hide all the right frame data for a particular dataset.
Save file Click this button to save the dataset as a xcrysden file - its default name will be the name of the compound.
Name of the compound The name of the compound, as loaded from the xcrysden files, or, if the dataset has been generated out of other datasets, it will be automatically generated from the input datasets.
Grid size This field states the size of this dataset's grid.
Density Threshold This field states the value of the electronic density that the isosurface shows.
Set surface color Click this button and a menu will appear, in which you can choose any color that you might want to be used on the isosurface.
Highlight oringinal grid Check this checkbox to highlight the grid of the original lattice.
Draw bonds The values stated in this fields will state which bonds are drawn and which ones are not.
Copies in different directions In this fields, you can choose how many copies in each direction will be rendered into the screen.

Xcrysden Tools

The xcrysden tools can be accessed from the tool bar (by clicking the cogs icon), by right clicking and choosing the "Tools" option on thecontextual menu, or by clicking the main window's tool bar's "Customized Tools" button.

By doing that, a new window called "TVS 2.0 tools window" will appear. In this window, all the loaded datasets will be shown (along with information about what kind of data it is and in which instances the datasets have been loaded), and the ones for which TVS tools have been implemented will display a checkable check box.

Below the list of datasets, there is a list of the actions that can be taken with the selected datasets (as, for example, to add or differentiate them); then, depending on the types of datasets that have been selected, additional options will be displayed (for example, if in the dataset there are atoms that have to be handled in a specific manner.

After that, the location of the resulting dataset, if any, has to be specified as well. Any of the current instances or a new one can be chosen. Also, if the dataset is based on three dimensional grid, the user can check whether he wants to keep any of the original grids or state an entirely different one for the new dataset.

Finally, by clicking on the "Run tools" button located at the bottom of the window, the software will proceed to perform the operations that have been requested; if any of the options that have been specified is not valid, a warning message will appear and the user will be prompted to go back to the window and change any invalid option.

Last updated 02 May 2012Contact TCHPC: info | support.