Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a UML class diagram of all existing classes/functions in the current MGM2D library #34

Closed
4 tasks done
WorkGitAccount opened this issue Feb 6, 2024 · 2 comments
Assignees
Labels

Comments

@WorkGitAccount
Copy link
Collaborator

WorkGitAccount commented Feb 6, 2024

References #12

  • To better aid development and translation to python, I need a class diagram of the existing Matlab and C++ codebase.
  • The UML diagram should have all classes and functions labeled with variables, objects, and dependencies labeled.
  • Consider clarifying the class diagram model: Since Matlab uses functions and classes nearly interchangeably, it may be more clear to have a box for every function not only just classes.
  • Consider also creating an activity diagram or flowchart of behavior to aid in visualizing the logic flow in the code.
@WorkGitAccount WorkGitAccount self-assigned this Feb 6, 2024
@WorkGitAccount
Copy link
Collaborator Author

WorkGitAccount commented Feb 17, 2024

Researched some UML drafting software. PlantUML is a text based UML drafting language that will work. A PlantUML text document as well as the UML image that it creates will be placed in the /docs/ folder.

The simplified model on the project plan shows a basic flowchart of data behavior. During our code walkthrough, Dr. Grady Wright also advised to show the interpolator operators in the preprocessing phase.

WorkGitAccount added a commit that referenced this issue Feb 19, 2024
@WorkGitAccount
Copy link
Collaborator Author

A full UML diagram is at /docs/ClassDiagram.png created by /docs/ClassDiagram.txt using PlantUML (executable not included)

[t:450]

WorkGitAccount added a commit that referenced this issue Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant