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

TimeBasedPlotter default timestamps and Notebook animation docs #751

Merged
merged 2 commits into from
Jan 6, 2023

Conversation

sdhiscocks
Copy link
Member

  • Use all timestamps by default for TimeBasedPlotter
    This no longer requires specifying the time stamps, as they default to
    those from data being plotted
  • Simplify docs for Notebook use of animations in TimeBasedPlotter
    Also ignore example gif file that is saved.

This no longer requires specifying the time stamps, as they default to
those from data being plotted
Also ignore example gif file that is saved.
@sdhiscocks sdhiscocks requested a review from a team as a code owner November 28, 2022 13:24
@sdhiscocks sdhiscocks requested review from jswright-dstl and hpritchett-dstl and removed request for a team and jswright-dstl November 28, 2022 13:24
@codecov
Copy link

codecov bot commented Nov 28, 2022

Codecov Report

Base: 94.92% // Head: 94.92% // No change to project coverage 👍

Coverage data is based on head (d50021e) compared to base (18ee65a).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #751   +/-   ##
=======================================
  Coverage   94.92%   94.92%           
=======================================
  Files         171      171           
  Lines        8454     8454           
  Branches     1232     1232           
=======================================
  Hits         8025     8025           
  Misses        317      317           
  Partials      112      112           
Flag Coverage Δ
integration 69.74% <ø> (-0.04%) ⬇️
unittests 92.03% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@gawebb-dstl gawebb-dstl left a comment

Choose a reason for hiding this comment

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

Its a small useful PR and the code looks good to me. I've commented one optional small change so that the figure appears when being ran from the command line/ pycharm


ani = plotter.run(times_to_plot, plot_item_expiry=datetime.timedelta(seconds=60))
plt.show()
plotter.run(plot_item_expiry=datetime.timedelta(seconds=60))

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
matplotlib.pyplot.show()

This makes the animation appear, when ran from the command line

@sdhiscocks sdhiscocks merged commit fae5908 into main Jan 6, 2023
@sdhiscocks sdhiscocks deleted the ani_plot branch January 6, 2023 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants