Archive of gui scripts

NOTE: As of the 26th September 2024, The latest job submission gui and documentation for it is now available from the OpenRadioss Tools repository on github, the script itself is now in python and platform agnostic, you may download and make further contributions there

Tools/openradioss_gui at main · OpenRadioss/Tools

Below is the archive of the tool development on confluence, links to download here are now disabled:

Latest version of the gui scripts, this is a combination of earlier iterations of the tools by github OpenRadioss contributors: hotaosa and PaulAltair

NEW Gui Scripts available 17th September 2024 (mk5)

In order to facilitate easier working with OpenRadioss, some simple python/tk based guis (.exe version of older mk3 tools available for windows) have been created for running jobs, queuing jobs and converting anim files to vtk or d3plot and converting T01 files to csv. The gui job submission tool sets all required environment variables, so it makes getting started with OpenRadioss much easier!

In July 2024 the Vortex Radioss d3plot converter was opened to all users, see github discussion: https://github.com/orgs/OpenRadioss/discussions/2361

And Vortex Radioss page:

https://github.com/Vortex-CAE/Vortex-Radioss

The latest mk5 version of the scripts detects if the Vortex-Radioss d3plot python module is installed, and if present, adds the option to the job submission gui to use the Vortex-Radioss d3plot tool to convert anim files to d3plot at the end of a run. A d3plot button is also added to the running job window to create d3plots from anim files on the fly during a run. A d3plot column is added to the queue status page for queued jobs.

The linked tools include a combination of the features available in earlier scripts from hotaosa and PaulAltair

The zip files linked below contain scripts for windows and for linux (for linux, if using the zip download, the files/folders will need to be set writable/executable after extraction, the tar.gz does not require this)

The older mk3 versions of the scripts (without d3plot conversion option) may still be downloaded here

Older Gui Scripts (exe version for windows) (23rd July 2023) without d3plot option (mk3)

The linked tools include a combination of the features available in earlier scripts from hotaosa and PaulAltair

The zip files linked below contain scripts for windows including an exe version.

Installation and Launch

Note: see above, the mk5 version of the gui scripts requires the installation of python as a pre-requisite if you need a windows exe version and d3plot conversion is not needed, use the mk3 version

Windows Installation and Launch

The script folder (win_scripts_mk3 or mk5) should be extracted to the installation folder of OpenRadioss (at the same level as exec, hm_cfg_files etc), the scripts work only from this directory level currently

The initial contents of the folder appear as below, the mk5 gui requires python installation due to the interaction with vortex radioss d3plot converter module and does not include an exe version. The main gui tool is the the 'openradioss_run_script_for_windows_mpi_ps.py’ file. The mk5 version also includes a d3convert.py script to call the Vortex-Radioss d3plot python libraries.

For the mk3 windows version, there is also an .exe version of the gui for which python is not a pre-requisite, it may be used directly, 'openradioss_run_script_for_windows_mpi_ps.exe’ can be launched from windows explorer on double click.

If the tools for anim-vtk or th-csv conversion are required, they should be located in the exec folder with the radioss executables

Windows Desktop Shortcut (Optional)

It is possible to create shortcut Links for the exe or python tools with the form e.g.:

Target for exe (mk3 version only):

full_path_to\win_scripts_mk3\openradioss_run_script_for_windows_mpi_ps.exe

Target for Python:

C:\Windows\pyw.exe “full_path_to\win_scripts_mk5\openradioss_run_script_for_windows_mpi_ps.py"

Start In Folder

full_path_to\win_scripts_mk5\

You may also ‘change icon’ to the one in the included icon folder

Linux Installation and Launch

The script folder (linux_scripts_mk5) should be extracted to the installation folder of OpenRadioss (same level as exec, hm_cfg_files etc), the scripts work only from this directory level currently.

If the tools for anim-vtk, th-csv conversion are required, they should be located in the exec folder with the radioss executables

bash shell, and python with tk is a pre-requisite in linux

not all linux distros necessarily include python/tk by default, e.g. lubuntu has it, but for ubuntu-mate following is needed

sudo apt-get install python3-tk

In linux, the content of the linux_scripts_mk5 folder is as below, the ‘openradioss_run_script_for_linux_mpi_ps.py’ file is the main gui, the d3convert.py file is included in the gui directory if mk5 version is installed.

in order to launch it, enter the linux_scripts_mk5 folder in a terminal window open it with python3, e.g. :

python3 openradioss_run_script_for_linux_mpi_ps.py

Linux Desktop Shortcut (Optional)

It is possible to create a clickable desktop/menu icon for linux:

add/create a file: ./local/share/applications/openradioss.desktop (make executable)
content of form e.g.:

[Desktop Entry]
Type=Application
Name=OpenRadioss
Exec=bash -c "cd /home/user/OpenRadioss/linux_scripts_mk5 && /usr/bin/python3 /home/user/OpenRadioss/linux_scripts_mk5/openradioss_run_script_for_linux_mpi_ps.py"
Icon=/home/user/OpenRadioss/linux_scripts_mk5/icon/ross.png

This will add a shortcut to desktop, menus: then can be pinned to desktop also:

Script Usage (windows/linux)

The gui usage is the same in both linux and windows, the gui takes input file and a number of OMP/MPI processors (-nt, -np) as arguments, there are also options for running single precision version, and having Anim-vtk, Anim-d3plot and TH-csv conversion performed at end of the run.

Submission gui

Job Input file can be Radioss format Starter (_0000.rad) Radioss format Engine (_0001.rad, _0002.rad etc.) or Dyna format .k or .key file

By default, all files for a run present in a folder will be submitted, e.g. if Starter, and Engine(s) exist, they will automatically be run sequentially starting from the file chosen.

If a Dyna format file is chosen, the ‘engine’ phase (automatically created) will be run automatically if interpretation of the keyword file was successful.

If ‘Run Starter Only’ option is checked, then the job will stop after the Starter (or keyword file) and not run the Engine(s).

If an engine file is selected, a restart run can be performed from that engine file (all engine files after the one selected will be automatically be run sequentially)

If -np is 1 then the SMP (OMP) version of OpenRadioss is run, if -np is > 1 then the SPMD (MPI) version of OpenRadioss is run

If ‘sp’ box is checked, the extended single precision version of OpenRadioss will be run (if self compiling, this version is not compiled by default, see compilation guides)

If ‘Anim - vtk’ box is checked, at the conclusion of the run, all animation files will be converted to vtk

If ‘TH - csv’ box is checked, at the conclusion of the run, all time history files will be converted to csv

If ‘Anim - d3plot’ box is checked (mk5 September 2024 released version only), at the conclusion of the run, all animation files will be converted to d3plot

The ‘info’ drop down has links to the downloads section of github and an ‘About’ credit to the script creators

Note: In Windows version only: On first attempt to submit an mpi run (-np > 1) you will be prompted to locate a suitable vars.bat file on your machine, once selected, this is remembered (to reset, delete the created ‘path_to_mpi_vars.txt’ file from the install directory, or edit its contents)

Run Window

The job runs in a window titled with the run name, with some option buttons at the bottom:

(d3plot option only shown when Vortex-Radioss module present)

Button Functions	Starter phase	Engine phase

Button Functions	Starter phase	Engine phase
Stop	stops the job at end of starter	stops the job cleanly writing restart (.rst) file(s)
Kill	stops the job at end of starter	kills the job (no restarts written)
Anim	no function	writes an Anim file at the current cycle
h3d	no function	writes/updates the h3d file at the current cycle
d3plot	no function	converts any Anim files present in the run folder to d3plot (always converts all anim files present)
Close	becomes available when job is completed, and closes the run window	becomes available when job is completed, and closes the run window

Queue Window

it is possible to submit further jobs from the submission gui after the first and they will be queued for running when the currently running job completes, the queue can be checked and edited, by clicking the ‘Show Queue’ button in the submission gui.

The Job Queue shows jobs queued along with the options chosen, with the buttons in the window it is possible to cancel the next or last job from the queue, or to manually start the next or last job from the queue (this happens in addition to the queue being processed, jobs will open another run window and run at same time as any running job, queue will continue to automatically run any remaining jobs only when 1st one finishes)