diff --git a/docs/io/output/progress_bars.ipynb b/docs/io/output/progress_bars.ipynb deleted file mode 100644 index 55c838d532a..00000000000 --- a/docs/io/output/progress_bars.ipynb +++ /dev/null @@ -1,63 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "id": "cc613a48", - "metadata": {}, - "source": [ - "### Progress Bars for Simulation Run ###\n", - "TARDIS displays progress bars by default to track the simulation. The progress bars are not displayed in the documentation but show up when you run the notebook.\n", - "\n", - "![TARDIS Progress Bars](../images/progress_bars_demo.gif)" - ] - }, - { - "cell_type": "markdown", - "id": "6e6b8b8f", - "metadata": {}, - "source": [ - "You can disable the progress bars as well." - ] - }, - { - "cell_type": "code", - "execution_count": 1, - "id": "319759fd", - "metadata": {}, - "outputs": [], - "source": [ - "from tardis import run_tardis\n", - "sim = run_tardis('tardis_example.yml', show_progress_bars = False)" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "e51d94c9", - "metadata": {}, - "outputs": [], - "source": [] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.7.10" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -} diff --git a/docs/io/output/progress_bars.rst b/docs/io/output/progress_bars.rst new file mode 100644 index 00000000000..cbbf705d5a0 --- /dev/null +++ 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 on via the keyword argument ``show_progress_bars=True`` in the ``run_tardis()`` function (see :doc:`../../quickstart`) or in the ``Simulation.from_config()`` class method (see :doc:`../../physics/setup/index`).