ROADMAP: Improve code statistics and quaility

[Samuelopez-ansys]

Code Quality Metrics

• Improve Code Coverage: Increase the percentage of code covered by automated tests (unit, integration, and system tests). Reach 90%.

• Improve Test: Make tests independent, and make tests dependent on AEDT output.

• Reduce Cyclomatic Complexity: Break down complex functions into smaller, simpler ones. High complexity can lead to harder-to-maintain code.

• Refactor duplicated code.

Performance Metrics

• Optimize Execution Time: Profile the code using tools like cProfile or line_profiler to identify and optimize bottlenecks.

• Minimize Memory Usage: Use memory profiling tools like memory_profiler to detect inefficient memory usage and optimize data structures.

Maintainability Metrics

• Reduce Technical Debt: Address warnings, and deprecated functionality

• Improve Documentation: Ensure that all functions, classes, and modules are well-documented with clear examples. This helps developers understand and extend the codebase.

[Samuelopez-ansys]

To improve docstring quality, PyAEDT should use return type annotation, like:

def add(a: int, b: int) -> int:
    return a + b