Photonics

Photonics

Topics related to Lumerical and more.

Where can I get all the manuals on scripting

    • 2022160206
      Subscriber

      Dear friends

      I meet some problems when I try to find the various parameters in functions. Even though I can use commands like "?get;" to get the name of the variable, it's challenging to get more detailed information, such as the data type and the "Dictionary element" meaning in the variable. 

    • Amrita Pati
      Ansys Employee

      Hi Shaoyan,

      You can get a list of all script commands alphabetically on the following page: Lumerical scripting language Alphabetical-list.

      And another list categorized based on their functionality here:Lumerical scripting language By category

      If you click on any of these script commands, you will be directed to the page where you can find detailed information on them. Let me know if you have any further questions.

      Regards,
      Amrita

      • 2022160206
        Subscriber

        Thanks, I know this is a good source to find the commands, but the question is that it is hard to get the detailed information. For example, I can use "addrcwa; ?get;" to get the parameters in RCWA, but I don't know how to set "interface reference positions",  because "interface reference positions" is a CellArray, and the cells meaning in it are unknown. I can't find more detailed information in the website.

        I would appreciate if you could provide more effective method.

    • Amrita Pati
      Ansys Employee

      Hi Shaoyan,

      Thanks for the feedback. I understand that we don't have sufficient information online when it comes to a few of the script commands. I will bring this up internally and we will see how we can add more information to our current articles. But at present these webpages are the only places we document the script commands. 

      Coming to the specific concern on setting interface positions, you can set the reference positions by script using the "set" or "setnamed" commands for the "interface reference positions" property. The argument is a cell array of cell arrays where there is an inner cell array for each enabled reference position. The cell array for the interface has three fields: name, type and interfaces. So an example cell array would be:
       
      {{"::model::rectangle", "max", 1},{"::model::rectangle", "min", 1}}
       
      An example script command to set this property would be:

      setnamed("RCWA", "interface reference positions", {{"::model::rectangle", "max", 1},{"::model::rectangle", "min", 1}});

      Let me know if you need help with any of the other script commands.

      Regards,
      Amrita
       

Viewing 2 reply threads
  • The topic ‘Where can I get all the manuals on scripting’ is closed to new replies.