Add instructions to enable virtual packet logging

[karban8]

Description

This PR is an attempt to fix issue #1374
The configuration file has been updated and suitable instructions have been added in the jupyter notebook (enable_virtual_generating_widgets.ipynb)

Motivation and Context

How Has This Been Tested?

• Testing pipeline
• Reference Data Comparison following these instructions
• Other (please describe)

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• None of the above (please describe)

Checklist:

• My code follows the code style of this project
• My change requires a change to the documentation
• I have updated the documentation accordingly
• I have built the documentation on my fork following these instructions
• I have assigned and requested two reviewers for this pull request

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov]

Codecov Report

Merging #1508 (8a3c975) into master (47010f8) will not change coverage.
The diff coverage is n/a.

❗ Current head 8a3c975 differs from pull request most recent head 7c207c7. Consider uploading reports for the commit 7c207c7 to get more accurate results

@@           Coverage Diff           @@
##           master    #1508   +/-   ##
=======================================
  Coverage   68.12%   68.12%           
=======================================
  Files          68       68           
  Lines        6040     6040           
=======================================
  Hits         4115     4115           
  Misses       1925     1925           

---

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 47010f8...7c207c7. Read the comment docs.

[karban8]

@jaladh-singhal Please review my PR. Thanks

[andrewfullard]

Note that with the merge of #1498 this documentation needs to be updated to include the second way of enabling virtual packet logging. Furthermore, I am not sure that an explicit new notebook is needed to show how this works. Rather, a new section of text in the visualization notebook that this is based on should be enough.

[karban8]

Note that with the merge of #1498 this documentation needs to be updated to include the second way of enabling virtual packet logging. Furthermore, I am not sure that an explicit new notebook is needed to show how this works. Rather, a new section of text in the visualization notebook that this is based on should be enough.

Alright I will incorporate the new changes. Also at first at I did try in the generating_widgets notebook (present in docs/using/visualization) but run_tardis(tardis_example.yml) gives a 'file not found' error though it is present in /docs/using

[andrewfullard]

Do you plan to continue with this?

[jaladh-singhal]

run_tardis(tardis_example.yml) gives a 'file not found' error though it is present in /docs/using
Because it needs to be present in docs/using/visualization - same directory where notebook lives.

[jaladh-singhal]

Like @andrewfullard pointed out, there's no need of separate notebook. This should instead be a warning box in "Line Info Widget" section's starting - exact same as in existing sdec_plot notebook.

[marxwillia]

Closing due to inactivity. Happy to reopen if work resumes.