adding RPacketPlotter to TARDIS

[jayantbhakar]

📝 Description

Type: 🚀 feature

This PR is based on the Montecarlo 2D packet visualization project. It aims to write a module for the RPacketPlotter tool which creates a 2D animated graph of the RPackets or the real packets used in the Montecarlo simulation.

Example code to plot is shown below:

rpacket_plotter = RPacketPlotter.from_simulation(sim, no_of_packets=10)
rpacket_plotter.generate_plot()

Here's how the plot looks like:

Light Theme:

Dark theme:

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

• Testing locally: Here is the log of pytests that I have run locally.

☑️ Checklist

• I requested two reviewers for this pull request
• I updated the documentation according to my changes
• I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

[codecov]

Codecov Report

Attention: Patch coverage is 18.47826% with 75 lines in your changes are missing coverage. Please review.

Project coverage is 61.08%. Comparing base (de9f29b) to head (02edb56).

❗ Current head 02edb56 differs from pull request most recent head bfdd23a. Consider uploading reports for the commit bfdd23a to get more accurate results

Files	Patch %	Lines
tardis/visualization/tools/rpacket_plot.py	18.47%	75 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2119      +/-   ##
==========================================
- Coverage   67.67%   61.08%   -6.59%     
==========================================
  Files         170       76      -94     
  Lines       14308     8727    -5581     
==========================================
- Hits         9683     5331    -4352     
+ Misses       4625     3396    -1229     

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

[jaladh-singhal]

I'll review the code in the module soon. Please start writing unit tests and updating the docs

[jayantbhakar]

Yeah, I think before writing tests and docs, I should work on adding some functionalities that are left. Today I am working on the dark theme.

[MarkMageeAstro]

Nice work Jayant. This will be a really nice addition to TARDIS when it's merged. I have a few specific codes that I've left. Generally though I think it would be good to add more comments throughout the code -- comments never hurt. The docstrings are good, but there are some specific bits of code where it's not clear exactly what they're doing. Just adding some comments to explain that will really help

[jaladh-singhal]

Good to see things finally shaping up - the final plot looks great. Thanks for finishing up animation and adding themes.

I have few minor comments about code n comments

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[tardis-bot]

*beep* *bop*

Hi, human.

The docs workflow has failed ❌

Click here to see the build log.

[sonachitchyan]

in here, change it from ```ith`` to ```i-th```

[MarkMageeAstro]

Looks good overall. I think some of the comments could be a bit more descriptive in places

[review-notebook-app]

View / edit / reply to this conversation on ReviewNB

MarkMageeAstro commented on 2022-09-07T09:54:57Z
----------------------------------------------------------------

properties (specifically...

with respect to the x-axis...

used (along...

calculate the x and y...

[review-notebook-app]

View / edit / reply to this conversation on ReviewNB

MarkMageeAstro commented on 2022-09-07T09:54:58Z
----------------------------------------------------------------

Here the theme parameter...

Remove only

By default the light theme

[review-notebook-app]

View / edit / reply to this conversation on ReviewNB

MarkMageeAstro commented on 2022-09-07T09:54:59Z
----------------------------------------------------------------

Is there supposed to be something here? It doesn't show anything for me even in the docs preview

[review-notebook-app]

View / edit / reply to this conversation on ReviewNB

MarkMageeAstro commented on 2022-09-07T09:55:00Z
----------------------------------------------------------------

The Play button

The animation

to reach any

[andrewfullard]

Okay, I did the rebase so now it just needs some cleanup to the current code structure.