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.

Sign up for GitHub

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

Fix documentation build failure due to PR #1823 #1918

Merged
merged 3 commits into from
Mar 3, 2022
Merged

Fix documentation build failure due to PR #1823 #1918

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98f6307
Include the show_convergence_plots option in the run_tardis function …
atharva-2001 Mar 1, 2022
908cf49
Remove unwanted changes
atharva-2001 Mar 2, 2022
0c546b8
[build docs]
atharva-2001 Mar 2, 2022
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
10 changes: 5 additions & 5 deletions docs/io/visualization/convergence_plot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@
"id": "dc1a0c1f",
"metadata": {},
"source": [
"The Convergence Plots consist of two Plotly FigureWidget Subplots, the `plasma_plot` and the `t_inner_luminosities_plot`. The plots are stored in the `convergence_plots` attribute of the simulation object `sim` and can be accessed using `sim.convergence_plots.plasma_plot` and `sim.convergence_plots.t_inner_luminosities_plot`.\n",
"\n",
"The Convergence Plots are shown by default when you running TARDIS because `show_convergence_plots` parameter of the `run_tardis()` function is set to `True`. If you don't want to do this, set it to `False`. "
"The Convergence Plots consist of two Plotly FigureWidget Subplots, the `plasma_plot` and the `t_inner_luminosities_plot`. The plots can be displayed by setting the `show_convergence_plots` option in the `run_tardis` function to `True`. The plots are stored in the `convergence_plots` attribute of the simulation object `sim` and can be accessed using `sim.convergence_plots.plasma_plot` and `sim.convergence_plots.t_inner_luminosities_plot`."
]
},
{
Expand Down Expand Up @@ -48,7 +46,7 @@
"download_atom_data('kurucz_cd23_chianti_H_He')\n",
"\n",
"# We run a simulation\n",
"sim = run_tardis('tardis_example.yml', export_convergence_plots=True)"
"sim = run_tardis('tardis_example.yml', show_convergence_plots=True, export_convergence_plots=True)"
]
},
{
Expand Down Expand Up @@ -89,7 +87,7 @@
"The default line-colors of the plasma plots can be changed by passing the name of the cmap in the `plasma_cmap` option. \n",
"\n",
"```py\n",
"sim = run_tardis(\"tardis_example.yml\",plasma_cmap= \"viridis\")\n",
"sim = run_tardis(\"tardis_example.yml\", show_convergence_plots=True, plasma_cmap=\"viridis\")\n",
"```\n",
"\n",
"Alongwith the cmap name, one can also provide a list of colors in rgb, hex or css-names format in the `t_inner_luminosities_colors` option to change the default colors of the luminosity and inner boundary temperature plots. \n",
Expand Down Expand Up @@ -127,6 +125,7 @@
"source": [
"sim = run_tardis(\n",
" \"tardis_example.yml\",\n",
" show_convergence_plots=True,\n",
" plasma_cmap= \"viridis\", \n",
" t_inner_luminosities_colors = ['rgb(102, 197, 204)',\n",
" 'rgb(246, 207, 113)',\n",
Expand Down Expand Up @@ -173,6 +172,7 @@
"source": [
"sim = run_tardis(\n",
" \"tardis_example.yml\",\n",
" show_convergence_plots=True,\n",
" plasma_plot_config={\n",
" \"layout\": {\n",
" \"template\": \"ggplot2\",\n",
Expand Down