Launching Help

Launching Help through the main interface

Simcenter Amesim's Help is launched by pressing F1, through the contextual menus, or through the Help menu item. It is also accessible through the Help buttons of dialog boxes.

The Help opens in your default browser.

Launching the Help server manually

You can also start the server which manages the help through its executable (HelpNavigator.exe), located in the $AME/win64 or $AME/lnx_x64 folder. This lets you launch Help even if Simcenter Amesim is not running.

Arguments (some mandatory):

• -docPath: mandatory — tells the server where the documentation is located. A path corresponding to $AME must be given. If missing or incorrect, the server displays an error and does not start.
• -p: optional — port for the server. Default is 8080.
• -noBrowser: optional — controls whether the server opens the main help page in the system's default browser at launch. Default is true (does not auto-open a page; you manually enter the address in your browser of choice). Use -noBrowser=false to auto-open the main page in the default browser at launch.
• -showUrl: optional — usable when -noBrowser is set to false. Performs an index search with the given value and opens the first result found (instead of the main page). For example, to open Help displaying information on modulo plots: -showUrl modulo. If no result is found, the main Help page opens.

Once the server has started, enter this address in your browser:

http://localhost:<port number>/

Note: If you call HelpNavigator.exe manually, to stop the server you must stop the process.