Working with the Modelica Scripting Window

With the Modelica Scripting window, you can create, execute, and document a script. You can also use it to display and change flags.

Important: Names are case sensitive.

This task shows you how to:

See Also
About Scripting

Create and Execute a Script

You can create and execute scripts in the Modelica Scripting window.

  1. From the Behavior Tools section of the action bar, click Modelica Scripting .

    Tip: You can also access this command from the Simulation section of the action bar.

    The Modelica Scripting window appears.

  2. To create a command in the script:
    1. Type or insert the command or function in the lower line (command input line) of the Modelica Scripting window.

      Tips:
      • You can insert a function call by right-clicking and selecting Insert Function Call, and edit an existing function call by right-clicking and selecting Edit Function Call. See Inserting a Function Call and Editing an Existing Function Call.
        Note: Many useful functions are available in the library DymolaCommands,
      • To display the description of a function behavior, type:
        • for a short description: help functionName (example: help importFMU), and press Enter.
        • for a longer description, that may include examples: document("functionName") (example: document("importFMU")), and press Enter.
      • An earlier executed command is available using "arrow up" in the command input line.
      • Right-clicking, the context menu contains also common features like copy/paste.

    2. Press Enter.
      The command is displayed and run in the upper part of the window.
  3. To save the script:
    1. Right-click in the upper part of the window and select Copy All Commands.
    2. Using the Modelica Script Editor, open a new script. See Creating a New Script.
    3. Paste the commands in this script.
    4. Save the script using the Modelica Script Editor. See Saving a Script.
    The script is saved.
    Note: If you want to directly use the commands of the script in a function, you can directly paste the commands in a function.
  4. To execute a script, you can use the function call RunScript(ScriptName).
    The script is executed; commands and results are displayed in the upper pane of the Modelica Scripting window.

Document a Script

You can document the script you are working with; adding texts, images, links etc.

Before you begin: You have some content in the upper pane of the Modelica Scripting window, because of:
  • You work with creating a script.
  • You have executed a script.
  1. To add more content, click, in the upper pane of the Modelica Scripting window, where you want to add it, and do the following:
    1. To insert text, type the text.
    2. To add a link, you must first select a text, then click Insert link.
      A Create link dialog box appears. You can type, or browse for, the URL of the text, and then click OK to validate the selection.
    3. To inset an image, click Insert image.
      A Picture Creation dialog box appears. For selections in this dialog box, see step 4-6 in Adding a Picture.
  2. To modify the appearance of the text, you can select a text and do the following:
    1. Select Text style to change text style of selected text lines. You can select between 5 headings, normal, and preformatted text.
    2. Select Bold to display the selected text as bold.
    3. Select Italic to display the selected text in Italics.
    4. Select Underline to display the selected text underlined.
    5. You can select the alignment for selected text lines by clicking on any of the commands Left align, Center align, Right align, or Justify.
    6. To present the selected lines as a bullet list, click Bullet list.
    7. To present the selected lines as a numbered list, click Numbered list.
  3. To save the result, or a part of it:
    1. Select it.
    2. Right-click and select Copy.
    3. Paste it into for example Microsoft Word, or the documentation layer of a class.
    4. Save the file where the result is inserted.

    Important: The result cannot be saved in the Modelica Scripting, it must be copied and saved outside this window.