pyconverter-xml2py/config.yaml at main · ansys/pyconverter-xml2py · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# Package settings

project_name: PyConverter-GeneratedCommands # Name of the project

library_name_structured: # Future name of the library
  - pyconverter
  - generatedcommands

subfolders:
  - subfolder
  - subsubfolder

new_package_name: package


####################################################################################
# Documentation settings

image_folder_path: ../images/_commands

documentation_subfolder: docs

####################################################################################
# Conversion settings

rules:
  "/": slash
  "*": star

specific_command_mapping:
  "*DEL": stardel
  "C***": c
  "/INQUIRE": inquire

ignored_commands:
  # Non-available commands - PyMAPDL user guide
  - "*ASK"
  - "*VEDIT"
  - "/ERASE"
  - "ERASE"
  - "HELP"
  - "HELPDISP"
  - "NOERASE"
  - "*CYCLE"
  - "*DO"
  - "*DOWHILE"
  - "*ELSE"
  - "*ELSEIF"
  - "*ENDDO"
  - "*ENDIF"
  - "*GO"
  - "*IF"
  - "*REPEAT"
  - "*RETURN"
  - "*DEL"
  - "/BATCH"
  - "/EOF"
  - "UNDO"
  # Additional commands to ignore
  - "C***"
  - "/DIRECTORY" # Defined in ``mapdl_core.py``
  - "*XPL" # Defined in ``mapdl_grpc.py``
  - "PLOT"
  - "/EXIT" # Defined in ``mapdl_core.py``

comments:
  - msg: 'This command must be run using :func:`non_interactive <ansys.mapdl.core.Mapdl.non_interactive>`.

          Please visit `Unsupported Interactive Commands <https://mapdl.docs.pyansys.com/version/stable/user_guide/mapdl.html#unsupported-interactive-commands>`_

          for further information.'
    type: "warning"
    commands:
      - "*CREATE"
      - "CFOPEN"
      - "CFCLOSE"
      - "*VWRITE"
      - "*MWRITE"
      - "LSWRITE"
      - "LSREAD"

  - msg: 'Starting with PyMAPDL v0.66.0, you can use "P" as a second argument to select entities interactively. A window pops up

          allowing you to select, unselect, add or reselect entities depending on the first argument ``type_``. An array with

          the ids of new selection is returned when the window is closed.'
    type: "note"
    commands:
     - "ASEL"

specific_classes:
  2D to 3D Analysis: Analysis 2D to 3D
  Parameters: Parameter definition

base_class:
  # Pattern-based inheritance rules
  # Patterns are matched against "module_name/class_name"
  # Use "*" for wildcards, e.g., "apdl/*" matches all classes in apdl module
  # Rules are evaluated in order - first match wins
  rules:
    - pattern: "*"
      module: "ansys.mapdl.core._commands"
      class_name: "CommandsBase"