Skip to content

Commit

Permalink
Some fixes in widgets documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jaladh-singhal committed Aug 25, 2020
1 parent 569d773 commit ee149f5
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
Binary file modified docs/running/images/shell_info_widget_demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/running/tardis_widgets/generating_widgets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## 1. Shell Info Widget\n",
"## Shell Info Widget\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:"
Expand Down Expand Up @@ -401,7 +401,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## 2. Line Info Widget\n",
"## Line Info Widget\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."
Expand Down
10 changes: 5 additions & 5 deletions docs/running/tardis_widgets/using_widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ features in the simulated spectrum.
By selecting a wavelength range on the spectrum plot, you can see the species
that produced the features within that range. This is determined by counting
the number of escaping packets that experienced their last interaction with
each ion. Packets can be filtered by the wavelength at which they were
each species. Packets can be filtered by the wavelength at which they were
absorbed or emitted, using the toggle buttons.

You can then click on a species to see the packets count for each last line
Expand Down Expand Up @@ -89,17 +89,17 @@ Using other options in Modebar
------------------------------
If you take your mouse to the top right corner of figure, you will see a Modebar
with multiple options. The default option when line info widget first displays
is ***Box Select*** - the dotted square icon. You can click on other options
like ***Zoom** (magnifying glass icon), to do a rectangle zoom which maybe
is **Box Select** - the dotted square icon. You can click on other options
like **Zoom** (magnifying glass icon), to do a rectangle zoom which maybe
helpful to focus on a feature in the spectrum. You can always revert back to
the initial state of the figure by clicking on ***Reset Axes*** option.
the initial state of the figure by clicking on **Reset Axes** option.

.. image:: ../images/line_info_spectrum_modebar.gif
:alt: Demo of using modebar options

There are also several other options in the modebar which we have not explained
(because they are not very relevant) but you're free to explore them as long as
you remember to click back on the *Box Select* option for making selections on
you remember to click back on the **Box Select** option for making selections on
spectrum.

.. Toggle legend

0 comments on commit ee149f5

Please sign in to comment.