Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

NEW Gui Scripts available

In order to facilitate easier working with OpenRadioss, some simple python/tk based guis (.exe versions available for windows) have been created for running jobs, converting anim files to vtk 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!

NEW for v2 (July 6th 2023): If multiple engine files are selected, they will be run sequentially, if only engine files are selected, a restart run can be performed, if only a starter is picked, only starter will run.

The zip files linked below contain scripts for windows and for linux (v2 versions here)

Windows gui Scripts zip download v2 (25MB)

Windows gui Scripts zip download (jobsub has additional mpi options) v2 (25MB)

Linux gui Scripts zip download v2 (4 KB)

Installation and Launch

For the windows versions, python is no longer a pre-requisite, the .exe versions of the guis may be used directly without a python installation, the python code is still included for information and .py script may still be used if python is installed

bash shell, and python with tk is a pre-requisite in linux (python/tk are only needed for windows if running the .py scripts instead of the .exes)

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

Code Block
sudo apt-get install python3-tk

...

Note

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, instructions below are a copy of the README from the tools repository.

https://github.com/OpenRadioss/Tools/tree/main/openradioss_gui

OpenRadioss GUI

OpenRadioss GUI is a graphical launcher for OpenRadioss on Linux and Windows.

It is a simple Python/tk based tool to execute OpenRadioss, queue jobs and convert OpenRadioss output files to csv, vtk, d3plot at the end of the run

The D3plot converter can be found at: Vortex-CAE GitHub repository

Installation

  • Python3 must be installed on the system.

    • On Windows, install Python from https://www.python.org/downloads/

    • On Linux, install python from your OS Repository.

      • On RedHat, CentOS, Rocky Linux

        Code Block
        dnf install python3
        
      • On Debian, Ubuntu

        Code Block
        apt-get install python3
        
  • Get latest OpenRadioss Release

  • Copy the openradioss_gui folder into an OpenRadioss Release Download (same level as exec, hm_cfg_files etc

...

In windows, the contents of the folder appear as below, the three ‘….Win.exe’ files are the gui tools, they should launch from explorer on double click (the '….Win.py' files are the python scripts and may be run instead if python is installed on machine)

...

In linux, the 3 ‘…Lin.py’ files are the guis,

...

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

Code Block
languagebash
python3 RunJobScriptLin.py

RunJob Scripts for Windows

The RunJobScriptWin.exe takes starter and engine files and a number of OMP/MPI processors as arguments, Dyna format input can be run by selecting Dyna file as ‘starter’ input and leaving engine file field empty, NEW for v2: If multiple engine files are selected, they will be run sequentially, if only engine files are selected, a restart run can be performed, if only a starter is picked, only starter will run.

...

If the ‘mpiselect’ version is used, an additional option is given in the gui to select the ‘vars.bat’ filepath for intelmpi installation, the path can also be modified inside the .py file if desired to save having to browse to it every time, if the ‘MPI processes’ field is set to 1 or left blank, the gui will run OMP version instead

...

RunJob Script for Linux

The linux version of the runjob script, also supports running mpi version if openmpi is installed and configured

OMP threads (nt) and MPI processes (np) can both be chosen, default is 1 and 1 (single processor OMP)

if the ‘MPI processes’ field is set to 1 or left blank, OMP version will be used

...

Anim-vtk Script

The ANIM-vtkScript….py opens a file selection dialog that takes ‘Annn’ files as input and converts to vtk for post processing in ParaView

T01-csv Script

The T01-csvScript….py opens a file selection dialog that takes ‘T0n’ files as input and converts to csv for post processing in ParaView

Note

Known Limitations

Only a single engine file is supported v2 allows multiple engine files, or only engine files (restarts)

Filepaths for selected files may not include spaces in Linux (ok in Windows)

If Filepath has spaces in windows for the converter scripts, they run twice!

See also:

...

  • .)

Execution

  • Launch the OpenRadioss_gui.vbs on Windows

  • Launch the OpenRadioss_gui.sh on Linux

...

Launch a job

  • Select the Starter input Deck in .rad or .k format

    • Click the folder Icon, a browser will appear

    • Browse to the Input deck Directory

    • Select Starter input Deck / Click on Open

  • Enter the number of thread for the job in the -nt field

  • Enter the number of MPI Domains for the job in the -np field

  • Click "Add Job" Run Window apprears.

Notes

  • Single Precision button enables the OpenRadioss single precision version

  • Run Starter Only button executes Starter only.

  • Anim - vtk button invokes the Animation to VTK converter at the end of OpenRadioss Engine simulation.

  • TH - csv button invokes the TH to CSV converter at the end of OpenRadioss Engine simulation.

  • Show Queue and Clear Queue buttons manage the run queue.

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

  • 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)

  • *D3plot button appears only if Vortex-CAE D3plot converter is detected.

The Run Window

The Run Windows has the OpenRadioss output.

...

Several buttons permits actions during job execution

  • Stop: stops the job cleanly writing restart (.rst) file(s)

  • Kill: kills the job (no restarts written)

  • Anim: writes an Anim file at the current cycle

  • h3d: writes/updates the h3d file at the current cycle

  • d3plot: 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

The Queue manager

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)

...

 

...

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

...

Archive of gui scripts