ReadThedocs - Design and Code updates

[mpatrou]

This includes updates mainly in the technical documentation files (docs/)

Short description of the changes:

Long description of the changes:

• class and module signatures added
• class connectivity, their parameters, in the diagrams updated
• MVP workflow diagrams updates
• documentation includes clean variables for future inclusion in the code to improve readbility
• docstrings of various functions in MVP files updated to be included in the documentation
• cleanup

Check list for the pull request

• I have read the [CONTRIBUTING]
• I have read the [CODE_OF_CONDUCT]
• I have added tests for my changes
• I have updated the documentation accordingly

Check list for the reviewer

• I have read the [CONTRIBUTING]
• I have verified the proposed changes
• best software practices
  • all internal functions have an underbar, as is python standard
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

Manual test for the reviewer

References

Update documentation - design docs

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.51%. Comparing base (c219107) to head (665e0e4).

Additional details and impacted files

@@           Coverage Diff           @@
##             next      #41   +/-   ##
=======================================
  Coverage   98.51%   98.51%           
=======================================
  Files          10       10           
  Lines         806      807    +1     
=======================================
+ Hits          794      795    +1     
  Misses         12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.