Renamed widgets subpackage to visualization and restructured modules …

…within it (#1462)

* Reorganized widgets & tools modules

* Changed import paths as per new subpackage structure

* Updated imports in demo notebooks

* Added EOF newline to init files

docs/using/visualization/sdec_plot.ipynb

@@ -13,8 +13,8 @@
    "execution_count": 1,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2021-02-12T14:05:43.742242Z",
-     "start_time": "2021-02-12T14:05:43.739877Z"
+     "end_time": "2021-02-18T17:35:03.859695Z",
+     "start_time": "2021-02-18T17:35:03.851958Z"
     },
     "nbsphinx": "hidden"
    },
@@ -36,8 +36,8 @@
    "execution_count": 2,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2021-02-12T14:06:46.089440Z",
-     "start_time": "2021-02-12T14:05:43.746092Z"
+     "end_time": "2021-02-18T17:37:30.434925Z",
+     "start_time": "2021-02-18T17:35:06.936525Z"
     }
    },
    "outputs": [
@@ -311,7 +311,7 @@
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Starting iteration 20/20 (\u001b[1mbase.py\u001b[0m:326)\n",
       "Running post-merge numba montecarlo (with C close lines)!\n",
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Luminosity emitted = 1.26319e+43 erg / s Luminosity absorbed = 4.10706e+42 erg / s Luminosity requested = 1.05928e+43 erg / s (\u001b[1mbase.py\u001b[0m:450)\n",
-      "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Simulation finished in 20 iterations and took 54.49 s (\u001b[1mbase.py\u001b[0m:384)\n"
+      "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Simulation finished in 20 iterations and took 85.37 s (\u001b[1mbase.py\u001b[0m:384)\n"
      ]
     }
    ],
@@ -344,13 +344,13 @@
    "execution_count": 3,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2021-02-12T14:06:49.123425Z",
-     "start_time": "2021-02-12T14:06:46.090887Z"
+     "end_time": "2021-02-18T17:37:42.468383Z",
+     "start_time": "2021-02-18T17:37:30.702418Z"
     }
    },
    "outputs": [],
    "source": [
-    "from tardis.widgets import SDECPlotter"
+    "from tardis.visualization import SDECPlotter"
    ]
   },
   {
@@ -365,8 +365,8 @@
    "execution_count": 4,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2021-02-12T14:06:49.704614Z",
-     "start_time": "2021-02-12T14:06:49.125705Z"
+     "end_time": "2021-02-18T17:37:44.686809Z",
+     "start_time": "2021-02-18T17:37:42.534053Z"
     }
    },
    "outputs": [],
@@ -395,8 +395,8 @@
    "execution_count": 5,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2021-02-12T14:06:52.444227Z",
-     "start_time": "2021-02-12T14:06:49.706660Z"
+     "end_time": "2021-02-18T17:37:48.944341Z",
+     "start_time": "2021-02-18T17:37:44.697819Z"
     }
    },
    "outputs": [
@@ -430,8 +430,8 @@
    "execution_count": 6,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2021-02-12T14:06:53.409156Z",
-     "start_time": "2021-02-12T14:06:52.446100Z"
+     "end_time": "2021-02-18T17:37:59.778634Z",
+     "start_time": "2021-02-18T17:37:56.684368Z"
     },
     "scrolled": false
    },
@@ -1002079,7 +1002079,6 @@
   }
  ],
  "metadata": {
-  "celltoolbar": "Edit Metadata",
   "kernelspec": {
    "display_name": "Python 3",
    "language": "python",

tardis/visualization/__init__.py

@@ -0,0 +1,8 @@
+"""Visualization tools and widgets for TARDIS."""
+
+from tardis.visualization.widgets.shell_info import (
+    shell_info_from_simulation,
+    shell_info_from_hdf,
+)
+from tardis.visualization.widgets.line_info import LineInfoWidget
+from tardis.visualization.tools.sdec_plot import SDECPlotter

tardis/visualization/tools/__init__.py

@@ -0,0 +1,6 @@
+"""
+Classes & functions to generate diagnostic visualizations.
+
+These interfaces (or tools) post-process TARDIS simulations allowing user to
+produce a specific visualization through a function (or class method) call.
+"""

tardis/widgets/sdec_plot.py → tardis/visualization/tools/sdec_plot.py

@@ -15,7 +15,7 @@
 import plotly.graph_objects as go
 
 from tardis.util.base import atomic_number2element_symbol
-from tardis.widgets import plot_util as pu
+from tardis.visualization import plot_util as pu
 
 
 class SDECData:

tardis/visualization/widgets/__init__.py

@@ -0,0 +1,6 @@
+"""
+Jupyter widgets to interactively explore TARDIS simulations.
+
+These are simple Graphical User Interfaces (GUIs) that run within Jupyter
+Notebooks, making data exploration much easier.
+"""

tardis/widgets/line_info.py → tardis/visualization/widgets/line_info.py

@@ -11,8 +11,11 @@
 
 from tardis.analysis import LastLineInteraction
 from tardis.util.base import species_tuple_to_string, species_string_to_tuple
-from tardis.widgets.util import create_table_widget, TableSummaryLabel
-from tardis.widgets import plot_util as pu
+from tardis.visualization.widgets.util import (
+    create_table_widget,
+    TableSummaryLabel,
+)
+from tardis.visualization import plot_util as pu
 
 
 class LineInfoWidget:

tardis/widgets/shell_info.py → tardis/visualization/widgets/shell_info.py

@@ -5,7 +5,7 @@
     species_tuple_to_string,
 )
 from tardis.simulation import Simulation
-from tardis.widgets.util import create_table_widget
+from tardis.visualization.widgets.util import create_table_widget
 
 import pandas as pd
 import numpy as np

tardis/widgets/tests/test_line_info.py → tardis/visualization/widgets/tests/test_line_info.py

@@ -2,7 +2,7 @@
 import pandas as pd
 import numpy as np
 from plotly.callbacks import Points, BoxSelector
-from tardis.widgets.line_info import LineInfoWidget
+from tardis.visualization.widgets.line_info import LineInfoWidget
 from tardis.util.base import species_string_to_tuple
 
 

tardis/widgets/tests/test_shell_info.py → tardis/visualization/widgets/tests/test_shell_info.py

@@ -2,7 +2,7 @@
 import numpy as np
 import pandas.testing as pdt
 
-from tardis.widgets.shell_info import (
+from tardis.visualization.widgets.shell_info import (
     BaseShellInfo,
     SimulationShellInfo,
     HDFShellInfo,