Skip to content

Commit

Permalink
Add documentation for Spectral Element Decomposition Plot (tardis-sn#…
Browse files Browse the repository at this point in the history
…1438)

* Restructured gui index to incoprorte viz tools

* Added notebook to demo SEDec plot

* Added notebook demonstrating SEDec plot

* Renamed SEDec to SDEC

* Added distance option & additional options usage

* Changed ref link name in index

* Added gif to demo notebook

* Increase matplotlib plot size

* Fixed inconsistency in docstring

* Made grammatical edits in notebook & hid warnings

* Fixed top level heading from ## to #
  • Loading branch information
jaladh-singhal authored Feb 11, 2021
1 parent b749747 commit 5bfc3e9
Show file tree
Hide file tree
Showing 4 changed files with 1,002,176 additions and 11 deletions.
27 changes: 21 additions & 6 deletions docs/using/gui/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
.. _gui:
.. _visualization:

*************************
Graphical User Interface
*************************
*****************************
Visualization Tools & Widgets
*****************************

A collection of widgets (simple GUIs) that makes it easier for you to explore
the simulation data within Jupyter Notebooks.
TARDIS Visualization Tools
==========================
A collection of tools that post-process TARDIS simulations to generate
diagnostic visualizations.

.. toctree::
:maxdepth: 2

sdec_plot


TARDIS Widgets (Graphical User Interfaces)
==========================================

A collection of Jupyter widgets that allow you to interactively explore TARDIS
simulations. Widgets are simple Graphical User Interfaces (GUIs) that run within
Jupyter Notebooks, making data exploration much easier.

.. toctree::
:maxdepth: 2
Expand Down
Loading

0 comments on commit 5bfc3e9

Please sign in to comment.