Running FEBio Jobs in FEBio Studio

Home/Running FEBio Jobs in FEBio Studio
Knowledgebase

Running FEBio Jobs in FEBio Studio

You are here:
< Back

1. Setting the Launch Configuration

Open the Run FEBio dialog box by selecting the FEBio\Run FEBio menu, by clicking on the Run FEBio icon in the main toolbar, or by pressing the F5 shortcut.

Figure 1. The FEBio Run dialog box allows users to set the launch configuration and run jobs in FEBio.

The default launch configuration will run the FEBio version that was installed as part of FEBio Studio (,which will be the latest version available at the time of the FEBio Studio release).

If you wish to run a different version of FEBio, or wish to run an FEBio job remotely, you will have to create and configure a new launch configuration.

In the new dialog click the Edit Launch Configuration button located on the right side of the dialog next to the Launch Configuration drop-down menu. A new dialog box will appear. The box on the left lists your current launch configurations. You can reorder them by clicking and dragging on any of them. You can rename any launch configuration by double-clicking on the name in the list.

Figure 2. The Launch configuration dialog box allows you to modify the way FEBio Studio will call the FEBio external process.

1.1. Creating new Local configurations

In the Launch Configuration manager, add a new launch configuration by clicking on the plus icon below the list, and then give it a new name. Select local from the Launch Type option.

Then, enter the path to the FEBio executable (including the executable’s name) in the text field. You can use absolute paths, relative paths, or the command to run the FEBio executable (i.e. what you would type to launch FEBio on a command or terminal window).

1.2. Creating Remote Configurations

Add a new launch configuration by clicking on the plus icon below the list, and then give it a new name (e.g. the name of the server).

Figure 3. Setting up a new remote launch configuration.

On the right, select the type of configuration that you would like to create from the Launch Type drop-down menu. The options are:

  • Local: will run your model in FEBio on your machine (section 1.1)
  • Remote: will connect to a remote sever and run FEBio directly on that server.
  • PSB Queue: will automatically add your job to the PBS queue located on the server that you specify.
  • Slurm queue: will automatically add your job to the Slurm queue located on the server that you specify.

After you specify the launch type, fill out the fields that are created below the drop-down menu.

Note that you must enter an existing, absolute path for Remote Directory.

When you have finished editing your launch configurations, press the OK button, then press the Yes button when you are prompted to save your changes. You will now return to the Run FEBio dialog box.

2. Running the job remotely

In the Run FEBio dialog, select your desired launch configuration from the drop-down menu, and then click the Run button.

After you click Run, FEBio Studio will first save the model to a .feb file in the local working directory (which will usually be the jobs folder in the project’s directory). The first time you run a model FEBioStudio will prompt you to create the local working directory, if it does not exist yet. Note that it will store the model locally, even if you selected a remote launch configuration.

If you have chosen a remote launch configuration, you will then be prompted for your password. After the connection to the server was successfully established, your .feb file will be copied to the remote server in the location that you specified in the launch configuration. The job will then be started automatically.

3. Getting the remote plot and log file

Note that when running a job from FEBioStudio a new item will appear in the model tree that corresponds to your run. If the job is run remotely a button will be shown, labeled “Get Remote Files”.

Figure 4. For remote jobs, a button is displayed to retrieve the remote files.

When the job is run remotely, FEBioStudio will not automatically download the log and plot files to your local machine, even when the job was completed on the server.

At any time after you have started the job, you can download a copy of your .xplt and .log files from the remote server by selecting the job in the Model Tree and the click on the Get Remote Files button. After the transfer is complete, you can open your .xplt file by clicking on either the Open in FEBioStudio button or the Open in PostView button.

If your selected launch configuration was a PBS Queue or Slurm Queue type, then you can use FEBioStudio to check on the status of the remote queue. To do this, select the job in the Model Tree and then click on the Get Queue Status button.

Table of Contents