Tracking RPacket Properties in Montecarlo Single Packet Loop Function

[DhruvSondhi]

This PR aims to add tracking functionality to Single Packet Loop via a new RPacketCollection Jitclass. It tracks all the properties to a single instance of the RPacketCollection class. The class object has the following properties available to access for the tracked packets:

• index of the packets
• seed of the packets
• status of the packets
• r (radius) of the packets
• nu of the packets
• mu of the packets
• energy of the packets

Description

Functionality to Track R_Packet interactions with the respective properties. It tracks every interaction for each packet.
Stored in a RPacketCollection Class object namely r_packet_track

Motivation and context

Important for visualising the montecarlo packets. Allows to debug the interactions a packet may undergo.

Documentation Preview
https://dhruvsondhi.github.io/tardis/branch/packet_tracking/io/output/rpacket_tracking.html

How has this been tested?

• Testing pipeline.
• Other. Local Testing

Type of change

• Bug fix.
• New feature.
• Breaking change.
• None of the above.

Checklist

• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • (optional) I have built the documentation on my fork following the instructions.
• I have assigned and requested two reviewers for this pull request.

[tardis-bot]

Before a pull request is accepted, it must meet the following criteria:

• Is the necessary information provided?
• Is this a duplicate PR?
  • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
  • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
• Does it pass existing tests and are new tests provided if required?
  • The test coverage should not decrease, and for new features should be close to 100%.
• Is the code tidy?
  • No unnecessary print lines or code comments.

[DhruvSondhi]

Initial Draft that allows logging Packet Properties to a File.

[codecov]

Codecov Report

Merging #1748 (4215291) into master (59c7f87) will decrease coverage by 0.37%.
The diff coverage is n/a.

❗ Current head 4215291 differs from pull request most recent head 97216e9. Consider uploading reports for the commit 97216e9 to get more accurate results

@@            Coverage Diff             @@
##           master    #1748      +/-   ##
==========================================
- Coverage   58.04%   57.66%   -0.38%     
==========================================
  Files          66       66              
  Lines        6747     6808      +61     
==========================================
+ Hits         3916     3926      +10     
- Misses       2831     2882      +51     

Impacted Files	Coverage Δ
...dis/montecarlo/montecarlo_numba/numba_interface.py	35.64% <0.00%> (-10.52%)	⬇️
tardis/tardis/montecarlo/montecarlo_numba/base.py	25.00% <0.00%> (-1.22%)	⬇️
...rdis/tardis/montecarlo/montecarlo_configuration.py	100.00% <0.00%> (ø)
tardis/tardis/montecarlo/base.py	88.94% <0.00%> (+0.17%)	⬆️
.../montecarlo/montecarlo_numba/single_packet_loop.py	29.78% <0.00%> (+2.66%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 59c7f87...97216e9. Read the comment docs.

[andrewfullard]

Apologies, I didn't realise this was marked draft!

[DhruvSondhi]

Need to change a test. please don't merge until I push the changes to the test :)

[DhruvSondhi]

There is an issue with the documentation here. It needs to be fixed. I am working on it.