Merge a42da9b into f24be9a

tardis-sn · Jan 5, 2022 · 2f500c8 · 2f500c8
2 parents f24be9a + a42da9b
commit 2f500c8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 63 deletions.
diff --git a/docs/io/output/progress_bars.ipynb b/docs/io/output/progress_bars.ipynb
diff --git a/docs/io/output/progress_bars.rst b/docs/io/output/progress_bars.rst
@@ -0,0 +1,11 @@
+********************************
+Progress Bars for Simulation Run
+********************************
+
+TARDIS displays progress bars by default to track the simulation's progress.
+
+.. image::
+    ../images/progress_bars_demo.gif
+    :width: 750
+
+Progress bars can be turned off via the keyword argument ``show_progress_bars=False`` in the ``run_tardis()`` function (see :doc:`../../quickstart`) or in the ``Simulation.from_config()`` class method (see :doc:`../../physics/setup/index`).