Skip to content

Rename plotWaves #765

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.

Sign up for GitHub

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

Jump to bottom
Merged
kmruehl merged 2 commits into from
Dec 8, 2021
Merged

Rename plotWaves #765

kmruehl merged 2 commits into from
Dec 8, 2021

Conversation

@jtgrasb
Copy link
Contributor

@jtgrasb jtgrasb commented Nov 10, 2021

I renamed the plotWaves function to plotWaveBodyVisualization to describe the function more accurately. I also updated the documentation to account for the new name. @kmruehl Did you also want this function moved to a different class?

@kmruehl kmruehl self-requested a review November 11, 2021 22:32
@kmruehl
Copy link
Collaborator

kmruehl commented Dec 7, 2021

@jtgrasb do you have any ideas on what we could call this? It does more than plotWaves, but plotWaveBodyVisualization is very long. What about something like plotViz, saveViz or saveAnimation? I somewhat prefer using "save" since this method automatically saves a gif or avi file, unlike the plot methods. Thoughts?

For reference, are the places it shows up in the docs:
http://wec-sim.github.io/WEC-Sim/master/user/advanced_features.html#wec-sim-visualization
http://wec-sim.github.io/WEC-Sim/master/user/api.html#objects.responseClass.plotWaves

@kmruehl kmruehl added the Visualization Visualization and Paraview label Dec 7, 2021
@jtgrasb
Copy link
Contributor Author

jtgrasb commented Dec 8, 2021

@kmruehl thanks for the suggestions! I think saveViz is nice and short but gets the point across, so I'll change it to that and update the relevant documentation.

kmruehl
kmruehl approved these changes Dec 8, 2021
View reviewed changes
Copy link
Collaborator

@kmruehl kmruehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks! I'll merge it now

@kmruehl kmruehl merged commit adc9568 into WEC-Sim:dev Dec 8, 2021
@jtgrasb jtgrasb deleted the Rename-plotWaves branch January 21, 2022 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kmruehl kmruehl kmruehl approved these changes

Assignees

No one assigned

Labels

Visualization Visualization and Paraview

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jtgrasb @kmruehl