Code readability and maintainability

[zkoppert]

Is your feature request related to a problem?

There are several related problems:

• Consistent Naming: Variable naming is generally good but could be more consistent
• Magic Values: Some hardcoded values could be converted to named constants.
• Comments: While the code has comments, some complex sections could use more detailed explanations.
• Code Organization: measure_innersource.py is too long and some functions are quite long and could be broken down into smaller, more focused functions.
• Logging: The tool uses print() statements instead of a proper logging framework, which limits flexibility and verbosity configuration.

Describe the solution you'd like

• Replace print() statements with a proper logging framework like logging.
• Break down the main() function into smaller, more focused functions, moving groups of functions to separate files where it makes sense, all while maintaining test coverage.
• Make variable naming consistent and descriptive.
• Replace any hardcoded values with named constants
• Add more detailed explanations as comments to the more complex sections of code
• Implement logging using a proper logging framework, converting print() statements into debug, info, etc statements

Describe alternatives you've considered

none

Additional context

Each of these list items could and likely should be each in their own pull request to keep the pull requests small and reviewable.

[github-actions]

This issue is stale because it has been open 21 days with no activity. Remove stale label or comment or this will be closed in 14 days.