Documentation of the KERNEL python packages

Main documentation

• General presentation of the KERNEL python package
• Documentation of the programming interface (API)
  • salome.kernel – Package containing the KERNEL python utilities
    • deprecation – Indication of deprecated modules and functions
    • termcolor – Display colored text in terminal
    • logger – Logging utility
    • studyedit – Study editor
  • salome.kernel.parametric – Package for parametric studies
    • study_exchange_vars – Handle Exchange Variables
    • compo_utils – Useful functions for SALOME components used in parametric studies
    • pyscript_utils – Useful functions for Python scripts used in parametric studies

Additional documentation

• Complement A: Organizing the SALOME python functions in a packaged structure
  • Objectives
  • Problems
    • Naming conflict between salome.py module and salome package
    • Dispatching of salome.* sub-packages in different SALOME modules
    • Adaptation of the apply_gen utility
    • What to do with already existing python files?
  • Instructions
    • Instructions for creating the python packages
    • Instructions for the associated documentation
    • Synthesis
  • Tests and usage