From 93a33ff43f8a29012c073091fdcab008dc3eebf6 Mon Sep 17 00:00:00 2001 From: smithis7 Date: Mon, 27 Dec 2021 16:05:42 -0500 Subject: [PATCH 1/5] switching progress bars page to rst Co-authored by: atharva-2001 --- docs/io/output/progress_bars.ipynb | 63 ------------------------------ docs/io/output/progress_bars.rst | 11 ++++++ 2 files changed, 11 insertions(+), 63 deletions(-) delete mode 100644 docs/io/output/progress_bars.ipynb create mode 100644 docs/io/output/progress_bars.rst 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..d6ab2da8642 --- /dev/null +++ b/docs/io/output/progress_bars.rst @@ -0,0 +1,11 @@ +******************************* +Progrss Bars for Simulation Run +******************************* + +TARDIS displays progress bars by default to track the simulation's progress. + +.. image:: + ../images/progress_bars_demo.gif + :width: 500 + +Progress bars can be turned off via the keyword argument ``show_progrss_bars=False`` in the ``run_tardis()`` function (see :doc:`../../quickstart`) or in the ``Simulation.from_config()`` class method (see :doc:`../../physics/setup/index`). \ No newline at end of file From a09d51ccefd1df7091350ac5a16d31d5a7438b8b Mon Sep 17 00:00:00 2001 From: Isaac Smith <71480393+smithis7@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:05:33 -0500 Subject: [PATCH 2/5] Update docs/io/output/progress_bars.rst Co-authored-by: Wolfgang Kerzendorf --- docs/io/output/progress_bars.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/io/output/progress_bars.rst b/docs/io/output/progress_bars.rst index d6ab2da8642..faa7a76ca5d 100644 --- a/docs/io/output/progress_bars.rst +++ b/docs/io/output/progress_bars.rst @@ -1,5 +1,5 @@ ******************************* -Progrss Bars for Simulation Run +Progress Bars for Simulation Run ******************************* TARDIS displays progress bars by default to track the simulation's progress. From eb4bc9bca60d0ed0d812f81130bbb3c6ae69281d Mon Sep 17 00:00:00 2001 From: Isaac Smith <71480393+smithis7@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:05:40 -0500 Subject: [PATCH 3/5] Update docs/io/output/progress_bars.rst Co-authored-by: Wolfgang Kerzendorf --- docs/io/output/progress_bars.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/io/output/progress_bars.rst b/docs/io/output/progress_bars.rst index faa7a76ca5d..4884806946f 100644 --- a/docs/io/output/progress_bars.rst +++ b/docs/io/output/progress_bars.rst @@ -8,4 +8,4 @@ TARDIS displays progress bars by default to track the simulation's progress. ../images/progress_bars_demo.gif :width: 500 -Progress bars can be turned off via the keyword argument ``show_progrss_bars=False`` in the ``run_tardis()`` function (see :doc:`../../quickstart`) or in the ``Simulation.from_config()`` class method (see :doc:`../../physics/setup/index`). \ No newline at end of file +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`). \ No newline at end of file From cec8184ebaf247823b604494c03176f45386e300 Mon Sep 17 00:00:00 2001 From: Isaac Smith <71480393+smithis7@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:07:12 -0500 Subject: [PATCH 4/5] fix heading and width --- docs/io/output/progress_bars.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/io/output/progress_bars.rst b/docs/io/output/progress_bars.rst index 4884806946f..55cf4081f07 100644 --- a/docs/io/output/progress_bars.rst +++ b/docs/io/output/progress_bars.rst @@ -1,11 +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: 500 + :width: 600 -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`). \ No newline at end of file +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`). From a42da9b88d02d64f9172d76e7416301bdd8adb9d Mon Sep 17 00:00:00 2001 From: Isaac Smith <71480393+smithis7@users.noreply.github.com> Date: Wed, 5 Jan 2022 14:46:35 -0500 Subject: [PATCH 5/5] making gif larger --- docs/io/output/progress_bars.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/io/output/progress_bars.rst b/docs/io/output/progress_bars.rst index 55cf4081f07..b3e73ac6c6a 100644 --- a/docs/io/output/progress_bars.rst +++ b/docs/io/output/progress_bars.rst @@ -6,6 +6,6 @@ TARDIS displays progress bars by default to track the simulation's progress. .. image:: ../images/progress_bars_demo.gif - :width: 600 + :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`).