Evaluate for Free

Introduction to the CML Compiler Graphical User Interface

CML Compiler

Starting in release 2023 R2, the CML Compiler Graphical User Interface (GUI) can be used to build and maintain compact model libraries, validate source data, edit and build compact model libraries, and run QA tests. The CML Compiler GUI can be launched by clicking the New Project button next to the CML Compiler row in the Ansys Optics Launcher:

Picture16.png

The different areas of the CML Compiler GUI are shown below:

Picture17.png

Menu Bar

The Menu Bar contains the following dropdown menus:

  • File: Can be used to Exit the program.
  • View: Controls whether the Tool Bar, Element Status Center window, and Output windows are visible.
  • Run: Contains buttons with the same functions as the buttons in the Tool Bar (see below).
  • Help: Has links to the online documentation for CML Compiler.

Tool Bar

The Tool Bar contains the buttons that can be used to run various CML Compiler functions. The buttons from left to right are:

  • Deploy Lumfoundry: Opens a dialog window that can be used to deploy the Lumfoundry Template example library.
  • Validate Data: Validates the format of the element source data files.
  • Build Library: Compiles the source data into a compact model library.
  • Install Library: Installs the compiled INTERCONNECT CML in INTERCONNECT. This option is not available for Verilog-A CMLs. The following options are available from the arrow by the icon:
    • Install + Prev Steps: Validates and builds the CML, then installs it in INTERCONNECT.
  • Build Tests: Creates the QA tests for the elements in the library. The following options are available from the arrow by the icon:
    • Build Tests + Prev Steps: Validates and builds the CML, installs it in INTERCONNECT, then creates the QA tests.
  • Run Tests: Runs the QA tests for the elements in the library. The following options are available from the arrow by the icon:
    • Run all steps: Runs all of the steps in the CML compilation process: Validates and builds the CML, installs it in INTERCONNECT, then creates and runs the QA tests.
  • Verilog-A: This checkbox selects whether to create Verilog-A or INTERCONNECT elements. It only appears on Linux operating systems. In Windows, the only option is building INTERCONNECT elements.
  • Edit Library: Opens the editor for the Library Master File. 
  • Launch INTC: Launches Ansys Lumerical INTERCONNECT.
  • Launch Explorer: Launches a file explorer window at the current Library path.

Element Status Center

The Element Status Center displays the elements in your CML Compiler directory. You can search names of elements or their photonic models in the search bar.

The Library path specifies the root folder of the library source directory currently open in the GUI. The … button next to it can be used to change this root folder to open a different CML Compiler directory.

The library master file dropdown menu selects the library master file and is used to populate the element table. The Reload button next to it will refresh the element table with any changes that have been made to the library master file.

The element table displays the elements listed in the currently selected library master file. It has the following columns:

  • Select: Used to select which elements are used when the buttons in the Tool Bar are clicked. This is the left-most column of the table. To select or deselect all elements, use the check box in the header row.
  • Name: Name of the element.
  • Photonic Model: The element’s photonic model.
  • Validate: Indicates whether the element’s source data format has been successfully validated.
  • Build: Indicates whether the element has been successfully built.
  • Test: Indicates whether the element has successfully passed its QA tests.

Above the table, you can use the Element Buttons to perform one or more actions:

  • Picture18.pngAdd : Adds an element to the library source directory based on a lumfoundry template.
  • Picture19.pngDelete: Removes the selected element(s) from the library. In the pop-up window, you can select whether to only remove the element’s entry in the library master file, or to also remove the source files and folders.
  • Picture20.pngRename: Renames the selected element.
  • Picture21.pngEdit: Edit element source data in the GUI, each selected element is displayed in a separate tab.
  • Picture22.pngClear: Clears the Validate, Build, and Test status of all selected element(s) in the element table.

Below the element table there is a Select all/Unselect all checkbox that can be toggled to select or unselect all of the elements in the element table.

Output

The Output window displays the text output by CML Compiler. This text will indicate what CML Compiler is doing, and whether it is successful.

Below the output text window there is a Stop button and a Clear button. The Stop button halts an ongoing CML Compiler process. The Clear button erases the text in the output text box.

Using the CML Compiler GUI

For more information on how to use the CML Compiler GUI to create your CML, please see the following pages:

 

Associated files

Related articles