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

Rename bode and Bode plot #729

Merged
merged 3 commits into from Jul 10, 2019
Merged

Rename bode and Bode plot #729

merged 3 commits into from Jul 10, 2019

Conversation

pmli
Copy link
Member

@pmli pmli commented Jul 8, 2019

Based on return values of

and

a better name for pymor.models.iosys.InputOutputModel.bode would be freqresp (python-control's freqresp is a bit different and behaves more like bode in Matlab and SciPy). Since underscores are common in pymor.models.iosys method names, I find freq_resp would be even better.

Additionally, this PR replaces "Bode plot" with "magnitude plot". I'm not sure if "magnitude plot" is a name for something or if there is a standard name for the plot of ||H(i omega)|| vs omega, but it seems that "Bode plot" and "Bode magnitude plot" refer to a grid of subplots with a column for each input and row for each output.

I would still prefer to have pymor.iosys.models.InputOutputModel.mag_plot, since it's commonly used to visualize the MOR error.

@sdrave Thoughts?

@pmli pmli added sys-mor pr:change labels Jul 8, 2019
@pmli pmli added this to the 2019.2 milestone Jul 8, 2019
@pmli pmli requested a review from sdrave Jul 8, 2019
@sdrave
Copy link
Member

@sdrave sdrave commented Jul 9, 2019

@pmli, I think you should decide on this. Only two general remarks:

  • Only rename the methods if you really think it improves user experience.
  • I prefer Pythonic names over mimicking the interfaces of some other software. So I would prefer freq_resp over freqresp.

@pmli
Copy link
Member Author

@pmli pmli commented Jul 9, 2019

  • Only rename the methods if you really think it improves user experience.

I already got comments that "bode" is misleading. This should help.

  • I prefer Pythonic names over mimicking the interfaces of some other software. So I would prefer freq_resp over freqresp.

Alright, good.

There is still the issue with tests. @renefritze It seems there are some issues with debian and OSX.

sdrave
sdrave approved these changes Jul 10, 2019
@pmli pmli merged commit e1d0cb0 into master Jul 10, 2019
7 checks passed
@pmli pmli deleted the rename-bode branch Jul 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr:change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants