{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# How to Generate Data Exploration Widgets\n",
"A demonstration of how to generate TARDIS widgets that allows you to **explore simulation data within Jupyter Notebook with ease**!\n",
"\n",
"This notebook is a quickstart how-to guide, but more details on each widget (and its features) is given in the [Using TARDIS Widgets](https://tardis-sn.github.io/tardis/io/visualization/using_widgets.html) section of the documentation."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"First create and run a simulation that we can use to generate widgets (more details about running simulation in [Quickstart](https://tardis-sn.github.io/tardis/quickstart/quickstart.html) section):\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"ExecuteTime": {
"end_time": "2021-02-18T16:10:42.838867Z",
"start_time": "2021-02-18T16:09:22.826173Z"
},
"scrolled": true
},
"outputs": [],
"source": [
"from tardis import run_tardis\n",
"from tardis.io.atom_data import download_atom_data\n",
"from tardis.io.configuration.config_reader import Configuration\n",
"\n",
"# We download the atomic data needed to run the simulation\n",
"download_atom_data('kurucz_cd23_chianti_H_He_latest')\n",
"\n",
"config = Configuration.from_yaml(\"tardis_example.yml\")\n",
"config.montecarlo.tracking.track_rpacket = True\n",
"\n",
"sim = run_tardis(config, virtual_packet_logging=True)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Now, import functions & class to create widgets from `visualization` subpackage:\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"ExecuteTime": {
"end_time": "2021-02-18T17:29:30.986893Z",
"start_time": "2021-02-18T17:29:30.978764Z"
}
},
"outputs": [],
"source": [
"from tardis.visualization import (\n",
" shell_info_from_simulation,\n",
" shell_info_from_hdf,\n",
" LineInfoWidget,\n",
" GrotrianWidget,\n",
")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Shell Info Widget\n",
"\n",
"This widget allows you to explore chemical abundances of each shell - all the way from elements to ions to levels - by just clicking on the rows you want to explore!\n",
"\n",
"There are two ways in which you can generate the widget:\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Using a Simulation object\n",
"\n",
"We will use the simulation object we created in the beginning, `sim` to generate shell info widget. Then simply display it to start using.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"\n",
"**Note for Documentation Viewers**\n",
"\n",
"The interactive widget below will not function in the published documentation. To use this widget, please run this notebook locally in a Jupyter environment with TARDIS installed.\n",
"\n",
"
"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"ExecuteTime": {
"end_time": "2021-02-18T16:11:15.097803Z",
"start_time": "2021-02-18T16:11:14.753761Z"
}
},
"outputs": [],
"source": [
"shell_info_widget = shell_info_from_simulation(sim)\n",
"shell_info_widget.display()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"You can interact with the widget produced in output above (which won't be visible if you're viewing this notebook in our docs as an html page) like this:\n",
"\n",
"\n",
"\n",
"Use the button at the top of this page to run the notebook in interactively to use the widgets!\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Using a saved simulation (HDF file)\n",
"Alternatively, if you have a TARDIS simulation model saved on your disk as an HDF file, you can also use it to generate the shell info widget.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"ExecuteTime": {
"end_time": "2021-02-18T17:24:41.195180Z",
"start_time": "2021-02-18T17:24:39.006861Z"
},
"scrolled": true
},
"outputs": [],
"source": [
"# shell_info_widget = shell_info_from_hdf('demo.h5')\n",
"# shell_info_widget.display()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Line Info Widget\n",
"\n",
"This widget lets you explore the atomic lines responsible for producing features in the simulated spectrum.\n",
"\n",
"You can select any wavelength range in the spectrum interactively to display a table giving the fraction of packets that experienced their last interaction with each species. Using toggle buttons, you can specify whether to filter the selected range by the emitted or absorbed wavelengths of packets. Clicking on a row in the species table, shows packet counts for each last line interaction of the selected species, which can be grouped in several ways.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"\n",
"**Note for Documentation Viewers**\n",
"\n",
"The interactive widget below will not function in the published documentation. To use this widget, please run this notebook locally in a Jupyter environment with TARDIS installed.\n",
"\n",
"
"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"To generate line info widget, we will again use the simulation object `sim` and then display the widget:\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"ExecuteTime": {
"end_time": "2021-02-18T17:24:55.634945Z",
"start_time": "2021-02-18T17:24:49.354718Z"
}
},
"outputs": [],
"source": [
"line_info_widget = LineInfoWidget.from_simulation(sim)\n",
"line_info_widget.display()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"You can interact with this widget (which again won't be visible if you're viewing this notebook in our docs as an html page) like this:\n",
"\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"\n",
"Note\n",
"\n",
"The virtual packet logging capability must be active in order to produce virtual packets' spectrum in `Line Info Widget`. 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",
"
\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Energy Level Diagram\n",
"\n",
"This widget lets you explore and visualize the various level populations and line interactions in a simulation in the form of an Energy Level Diagram.\n",
"\n",
"You can select any ion present in the simulation and filter the transitions by wavelength or model shell to display an energy level diagram, where:\n",
"\n",
"- The horizontal lines represent the energy levels. The thickness of each line shows the relative population of that energy level, with thicker lines being more populated.\n",
"- The arrows represent the line interactions between levels, with the arrow direction giving the direction of the transition. The thickness of each arrow also shows the number of packets that underwent the transition while the wavelength is given by the color.\n",
"\n",
"In addition, you can also select between linear- and log-scaling for the y-axis (which represents the energy of each level) and the maximum number of levels to display, beginning from the lowest energy levels.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"\n",
"**Note for Documentation Viewers**\n",
"\n",
"The interactive widget below will not function in the published documentation. To use this widget, please run this notebook locally in a Jupyter environment with TARDIS installed.\n",
"\n",
"
"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"To generate the energy level diagram, we will again use the simulation object `sim` and then display the widget:\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"energy_level_widget = GrotrianWidget.from_simulation(sim)\n",
"energy_level_widget.display()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"You can interact with this widget (which again won't be visible if you're viewing this notebook in our docs as an html page) like this:\n",
"\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "tardis-X",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.13.5"
},
"notify_time": "5",
"toc": {
"base_numbering": 1,
"nav_menu": {},
"number_sections": false,
"sideBar": true,
"skip_h1_title": false,
"title_cell": "Table of Contents",
"title_sidebar": "Contents",
"toc_cell": false,
"toc_position": {},
"toc_section_display": true,
"toc_window_display": true
},
"varInspector": {
"cols": {
"lenName": 16,
"lenType": 16,
"lenVar": 40
},
"kernels_config": {
"python": {
"delete_cmd_postfix": "",
"delete_cmd_prefix": "del ",
"library": "var_list.py",
"varRefreshCmd": "print(var_dic_list())"
},
"r": {
"delete_cmd_postfix": ") ",
"delete_cmd_prefix": "rm(",
"library": "var_list.r",
"varRefreshCmd": "cat(var_dic_list()) "
}
},
"position": {
"height": "271.85px",
"left": "1265.58px",
"right": "20px",
"top": "65px",
"width": "420.167px"
},
"types_to_exclude": [
"module",
"function",
"builtin_function_or_method",
"instance",
"_Feature"
],
"window_display": false
}
},
"nbformat": 4,
"nbformat_minor": 4
}