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

Implement discharge capacity as an optional x-axis in QuickPlot #4775

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

medha-14
Copy link
Contributor

Description

Fixes #1751

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@medha-14
Copy link
Contributor Author

I have implemented the necessary changes for handling 0D variables. Once this is confirmed to be working correctly, I plan to work on handling 1D and 2D variables. Additionally, I have made changes in the dynamic plot, though I am unsure if they were necessary, so I would appreciate it if you could review them as well. Could you please suggest the next steps for moving forward?

Copy link

codecov bot commented Jan 19, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 17 lines in your changes missing coverage. Please review.

Project coverage is 98.62%. Comparing base (ef8571c) to head (ffe69f6).

Files with missing lines Patch % Lines
src/pybamm/plotting/quick_plot.py 50.00% 17 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4775      +/-   ##
===========================================
- Coverage    98.69%   98.62%   -0.08%     
===========================================
  Files          303      303              
  Lines        23226    23252      +26     
===========================================
+ Hits         22923    22932       +9     
- Misses         303      320      +17     

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

@medha-14
Copy link
Contributor Author

Hello @agriyakhetarpal could please give a review on this? :)

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

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

Thanks, this is a good start.

Variables should always be evaluated with time, not discharge capacity.

Also, the implementation would be simpler if you just set self.x_axis, self.x_min and self.x_max once and used those everywhere, instead of having the if/else for time and discharge capacity in so many places

if self.x_axis == "Discharge capacity [A.h]":
var_min = np.min(
[
ax_min(var(self.dc_values[i], **spatial_vars))
Copy link
Member

Choose a reason for hiding this comment

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

Whenever a variable is being evaluated, it should always be evaluated with time as the first argument, regardless of how the x-axis is defined. So this change is not necessary (also applies in a few other places)

)
var_max = np.max(
[
ax_max(var(self.dc_values[i], **spatial_vars))
Copy link
Member

Choose a reason for hiding this comment

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

see above

full_dc = self.dc_values[i]
(self.plots[key][i][j],) = ax.plot(
full_dc,
variable(full_dc),
Copy link
Member

Choose a reason for hiding this comment

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

see above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Quickplot with discharge capacity as x axis
2 participants