Skip to main content

Installation Problems

NMSM Pipeline Matlab Installation​

The most common NMSM Pipeline installation issues are path related. We recommend that you keep your nmsm-core installation directory in a convenient and easy to find location. You should not add any nmsm-core folders to your Matlab path or system path. When you start Matlab, you should open nmsm-core\Project.prj. This will take care of all path related problems for you.

NMSM Pipeline GUI Installation​

The NMSM Pipeline GUI works inside OpenSim, and consists of two main files: rcnlPlugin.dll and org-opensim-rcnl.jar.

rcnlPlugin.dll simply needs to be placed inside a Plugins folder inside your OpenSim installation directory.

org-opensim-rcnl.jar needs to be loaded into OpenSim using a Windows Powershell command, which can be found in the installation instructions.. The command generally only needs to be run once, but if you change the file path to the .jar file at any point, the command needs to be rerun with the new path.

If the NMSM Pipeline tools are not appearing inside OpenSim at all, you have a problem with loading org-opensim-rcnl.jar. Rerunning the Powershell command typically fixes this problem.

If the NMSM Pipeline tools are appearing inside OpenSim but are not working, you typically need to load the plugin by clikcing on User Plugins under Tools in OpenSim, and selecting rcnlPlugin.dll. If rcnlPlugin.dll is not appearing in this menu, make sure that the file is inside a folder named plugins in your OpenSim installation directory.

OpenSim Installation​

The NMSM Pipeline extensively uses OpenSim Matlab API calls. When these API calls fail, they typically result in Java import errors within Matlab.

OpenSim API installation errors commonly have the form Unable to find or import 'org.opensim.modeling.*'. If you get this error, you should go through the OpenSim Matlab scripting installation process again. Installation instructions can be found here.

Some common problems are:

  • Your OpenSim bin directory needs to be added to your system path
  • You need to run OpenSim\4.5\Code\Matlab\configureOpenSim.m
    • This directory is commonly saved in your Documents folder on windows. If you can't find the directory, start OpenSim and type the following command into the ScriptingShell window: installResources()

GPOPS-II Installation​

GPOPS-II is the optimal control solver used in the Treatment Optimization Toolset. If you are only using the Model Personalization Toolset, you do not need GPOPS-II.

There are three primary GPOPS-II installation errors you might come across.

  • Unrecognized function or variable 'gpops2'.: If you got this error, you need to re-run gpopsMatlabPathSetup.m inside your GPOPS-II distribution.
  • Invalid MEX-file 'GPOPS-II-Release\nlp\ipopt\ipopt.mexw64': If you got this error, you need to replace the ipopt mex file in your GPOPS-II distribution. Go to https://github.com/jonathancurrie/OPTI/releases and download optiMEXFiles_mexw64_2_29.zip. Copy the file ipopt.mexw64 from this zip file, and replace GPOPS-II-Release\nlp\ipopt\ipopt.mexw64 with it.
  • No valid GPOPS-II license file found or GPOPS-II license file has expired: These errors are due to your GPOPS-II license being incorrect in some way. First, check that you have a file GPOPS-II-Release\license\gpops2License.p. If you are using a license file that was distributed at a workshop, these files are temporary and expire once the workshop ends. Rice MECH students have access to a departmental GPOPS-II license, but if you are at a different university, you will need to purchase your own license.