[GSoC] Velocity Packet Tracker Visualisation: First Objective

[sarthak-dv]

📝 Description

Type: 🌞 GSoC

Solution to the first objective for the GSoC'24 project "Velocity Packet Tracker Visualisation". The Jupyter notebook contains the following tasks:

• Run the example simulation and generate an SDEC plot.
• Make a plot showing the abundance of each element, as a function of velocity.
• Make a plot that illustrates the total number of interactions that escape the simulation from the different elements (I've only considered out line interactions here)

📌 Resources

GSoC'24 Page
TARDIS GSoC'24 Ideas Page

🚦 Testing

How did you test these changes?

• Testing pipeline
• Other method (describe): Ran the notebook and generated the plots
• My changes can't be tested (explain why)

☑️ Checklist

• I requested two reviewers for this pull request

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

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[sarthak-dv]

@andrewfullard @jamesgillanders Please review

[sarthak-dv]

Note to mentors: To make the virtual packet count work, I had to make a fix in MonteCarloTransportState.

I have raised an issue and the fix is in this PR

[jaladh-singhal]

Thanks for submitting first objective @sarthak-dv

It's mostly looking good. It's great you caught a bug in the process and fixed it - now that your PR is merged, you can rebase this one.

It'll be also nice to see the plots in plotly since our tools use both matplotlib and plotly.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.18%. Comparing base (1718002) to head (4a60015).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2539   +/-   ##
=======================================
  Coverage   68.18%   68.18%           
=======================================
  Files         168      168           
  Lines       14219    14219           
=======================================
  Hits         9695     9695           
  Misses       4524     4524           

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

[sarthak-dv]

Hi @jaladh-singhal

Thanks for the detailed review. I have made the changes acordingly (Added legend, plots in Plotly, printed the dataframes)
I've also rebased master into this, to bring in the bugfix.
Please check and let me know if more changes are required.

Thanks again!

[jamesgillanders]

Hi Sarthak, looks good! Consider folding my comments above into the next iteration

[jamesgillanders]

See my recommended amendments from my attached comments

[sarthak-dv]

Thanks for the review @jamesgillanders !

I have updated the plots with the following changes:

• Convert yscale to "log"
• Convert velocities to km/s

Since NBViewer doesn't render the Plotly plots, attaching screenshots for them here: