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

Adding Instructions For Enabling virtual_packet_logging Properties in Config #1551

Merged
merged 1 commit into from
May 14, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/using/visualization/generating_widgets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -575,11 +575,16 @@
]
Copy link
Member

@jaladh-singhal jaladh-singhal May 17, 2021

Choose a reason for hiding this comment

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

This should not be placed on same level as that of Line Info Widget. Think about it - since we only need this instruction for line info widget it should be nested within it instead. Just remove the heading, it will automatically nest.

Also, correction: "... to show virtual packets' spectrum in Line Info Widget. Thus, ..." not SDEC Plot.


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I do something wrt to this change @jaladh-singhal ?

},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"metadata": {},
"outputs": [],
"source": []
"source": [
"## Enabling `virtual_packet_logging` Property for Plotting \n",
"<div class=\"alert alert-info\">\n",
"\n",
"**Important:** The virtual packet logging capability must be active in order to produce SDEC Plot. Thus, make sure to set `virtual_packet_logging: True` in your configuration file. It should be added under `virtual` property of `spectrum` property, as described in [configuration schema](https://tardis-sn.github.io/tardis/using/components/configuration/configuration.html#spectrum).\n",
"\n",
"</div>"
]
}
],
"metadata": {
Expand All @@ -598,7 +603,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.9"
"version": "3.8.8"
},
"notify_time": "5",
"toc": {
Expand Down