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

[TASK] Visualize the graph of components and resources #163

Closed
10 tasks done
j-bryan opened this issue May 17, 2022 · 0 comments · Fixed by #223
Closed
10 tasks done

[TASK] Visualize the graph of components and resources #163

j-bryan opened this issue May 17, 2022 · 0 comments · Fixed by #223
Assignees
Labels
priority-minor tasks or issues that are not time-sensitive or critical task Feature requests

Comments

@j-bryan
Copy link
Contributor

j-bryan commented May 17, 2022


Issue Description

Is your feature request related to a problem? Please describe.
It can be difficult for a user to determine if their inputs match their intention. It would be helpful if there was a way to visually represent what the received input is so that users could more easily learn HERON and debug their inputs.

Describe the solution you'd like
At a minimum, this feature could output an image of a directed graph with nodes for components and resources and directed edges indicating production and consumption of resources. The NetworkX library could be used to this. This could be enhanced with additional information, such as node sizing by relative capacity of each component or information on the cash flows associated with each component. With more information, it may be beneficial to make this diagram interactive rather than a static image by using a library like plotly.

Describe alternatives you've considered
A simple adjacency matrix could be printed to the terminal. However, I believe this would be more difficult for new users to interpret.


For Change Control Board: Issue Review

This review should occur before any development is performed as a response to this issue.

  • 1. Is it tagged with a type: defect or task?
  • 2. Is it tagged with a priority: critical, normal or minor?
  • 3. If it will impact requirements or requirements tests, is it tagged with requirements?
  • 4. If it is a defect, can it cause wrong results for users? If so an email needs to be sent to the users.
  • 5. Is a rationale provided? (Such as explaining why the improvement is needed or why current code is wrong.)

For Change Control Board: Issue Closure

This review should occur when the issue is imminently going to be closed.

  • 1. If the issue is a defect, is the defect fixed?
  • 2. If the issue is a defect, is the defect tested for in the regression test system? (If not explain why not.)
  • 3. If the issue can impact users, has an email to the users group been written (the email should specify if the defect impacts stable or master)?
  • 4. If the issue is a defect, does it impact the latest release branch? If yes, is there any issue tagged with release (create if needed)?
  • 5. If the issue is being closed without a pull request, has an explanation of why it is being closed been provided?
@j-bryan j-bryan added the task Feature requests label May 17, 2022
@j-bryan j-bryan changed the title [TASK] Visualize the graph of components and resources [TASK] Visualize the graph of components and resources [priority-normal] [requirements] May 17, 2022
@j-bryan j-bryan changed the title [TASK] Visualize the graph of components and resources [priority-normal] [requirements] [TASK] Visualize the graph of components and resources May 17, 2022
@dylanjm dylanjm added the priority-minor tasks or issues that are not time-sensitive or critical label May 17, 2022
@BotrosHanna-INL BotrosHanna-INL self-assigned this Sep 19, 2022
@dylanjm dylanjm mentioned this issue Nov 2, 2022
9 tasks
@dgarrett622 dgarrett622 linked a pull request Nov 2, 2022 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-minor tasks or issues that are not time-sensitive or critical task Feature requests
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants