From 44c7d97cbda9f08c8001152cd9845f2618364456 Mon Sep 17 00:00:00 2001 From: atharva-2001 Date: Mon, 21 Aug 2023 15:48:33 +0530 Subject: [PATCH 1/7] Add messages in quickstart and configuration docs index --- docs/io/configuration/components/index.rst | 5 +++++ docs/quickstart.ipynb | 23 +++++++++++++++++----- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/io/configuration/components/index.rst b/docs/io/configuration/components/index.rst index f71282f61c4..6fa8eae2899 100644 --- a/docs/io/configuration/components/index.rst +++ b/docs/io/configuration/components/index.rst @@ -10,6 +10,11 @@ settings for the different aspects of the TARDIS calculation. An example configuration file (with a small subset of the options that can be specified) can be downloaded `here `_. +.. DANGER:: + TARDIS parallelization is not working correctly at the moment and might produce incorrect results. + Please avoid using it. + For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021). + .. warning:: One should note that currently floats in YAML that are expressed in scientific notation need to be specified in a special format: diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb index f8fa47cdf6e..07a8de249cb 100644 --- a/docs/quickstart.ipynb +++ b/docs/quickstart.ipynb @@ -56,6 +56,21 @@ "The configuration file [tardis_example.yml](https://github.com/tardis-sn/tardis/tree/master/docs/tardis_example.yml) is used throughout this Quickstart." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "
\n", + "\n", + "**Warning:**\n", + "\n", + "TARDIS parallelization is not working correctly at the moment and might produce incorrect results.\n", + "Please avoid using it.\n", + "For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021).\n", + "\n", + "
" + ] + }, { "cell_type": "code", "execution_count": null, @@ -110,9 +125,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "scrolled": false - }, + "metadata": {}, "outputs": [], "source": [ "sim = run_tardis(\"tardis_example.yml\", \n", @@ -193,9 +206,9 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.16" + "version": "3.8.17" } }, "nbformat": 4, - "nbformat_minor": 2 + "nbformat_minor": 4 } From f65f15a2e7851340e0fa3c3a7dd45b00793749ca Mon Sep 17 00:00:00 2001 From: atharva-2001 Date: Mon, 21 Aug 2023 16:57:24 +0530 Subject: [PATCH 2/7] Quickstart note fix --- docs/quickstart.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb index 07a8de249cb..2df3ce5cc00 100644 --- a/docs/quickstart.ipynb +++ b/docs/quickstart.ipynb @@ -60,7 +60,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "
\n", + "
\n", "\n", "**Warning:**\n", "\n", From dba9474e0c7afbbf75d5eb7444b08be618eebf06 Mon Sep 17 00:00:00 2001 From: atharva-2001 Date: Mon, 21 Aug 2023 23:49:16 +0530 Subject: [PATCH 3/7] Try admonition --- docs/quickstart.ipynb | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb index 2df3ce5cc00..1adbf7aac50 100644 --- a/docs/quickstart.ipynb +++ b/docs/quickstart.ipynb @@ -57,17 +57,18 @@ ] }, { + "attachments": {}, "cell_type": "markdown", "metadata": {}, "source": [ - "
\n", - "\n", - "**Warning:**\n", + "
\n", + "

Warning:

\n", "\n", + "

\n", "TARDIS parallelization is not working correctly at the moment and might produce incorrect results.\n", "Please avoid using it.\n", - "For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021).\n", - "\n", + "For more information, see issue #2021.\n", + "

\n", "
" ] }, From 0859a7bad28006191c0107e4560d327103445812 Mon Sep 17 00:00:00 2001 From: atharva-2001 Date: Tue, 22 Aug 2023 00:20:49 +0530 Subject: [PATCH 4/7] Warning quickstart --- docs/quickstart.ipynb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb index 1adbf7aac50..626be5968b5 100644 --- a/docs/quickstart.ipynb +++ b/docs/quickstart.ipynb @@ -61,14 +61,14 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "
\n", - "

Warning:

\n", + "
\n", + "\n", + "**Warning:**\n", "\n", - "

\n", "TARDIS parallelization is not working correctly at the moment and might produce incorrect results.\n", "Please avoid using it.\n", - "For more information, see issue #2021.\n", - "

\n", + "For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021).\n", + "\n", "
" ] }, From 2d072e43ba4692981bbb11f7b2e57ec249dc7319 Mon Sep 17 00:00:00 2001 From: atharva-2001 Date: Tue, 22 Aug 2023 01:11:46 +0530 Subject: [PATCH 5/7] Try line --- docs/quickstart.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb index 626be5968b5..c15ebfd2365 100644 --- a/docs/quickstart.ipynb +++ b/docs/quickstart.ipynb @@ -69,7 +69,7 @@ "Please avoid using it.\n", "For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021).\n", "\n", - "
" + "
\n" ] }, { From 621ce2ba8fe17ca164e0d54841fc11e4cf88876d Mon Sep 17 00:00:00 2001 From: atharva-2001 Date: Tue, 22 Aug 2023 16:32:07 +0530 Subject: [PATCH 6/7] Add note in docs front page --- docs/index.rst | 4 ++++ docs/io/configuration/components/index.rst | 4 ---- docs/io/configuration/index.rst | 6 +++++- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a16a456d7ce..cfda8f06459 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -47,6 +47,10 @@ Mission Statement using an open-community model that emphasizes interdisciplinary research and science reproducibility.* +.. caution:: + TARDIS parallelization is not working correctly at the moment and might produce incorrect results. + Please avoid using it. + For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021). .. toctree:: :maxdepth: 2 diff --git a/docs/io/configuration/components/index.rst b/docs/io/configuration/components/index.rst index 6fa8eae2899..2757b50646c 100644 --- a/docs/io/configuration/components/index.rst +++ b/docs/io/configuration/components/index.rst @@ -10,10 +10,6 @@ settings for the different aspects of the TARDIS calculation. An example configuration file (with a small subset of the options that can be specified) can be downloaded `here `_. -.. DANGER:: - TARDIS parallelization is not working correctly at the moment and might produce incorrect results. - Please avoid using it. - For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021). .. warning:: One should note that currently floats in YAML that are expressed in scientific notation diff --git a/docs/io/configuration/index.rst b/docs/io/configuration/index.rst index b7293213f39..239047699cd 100644 --- a/docs/io/configuration/index.rst +++ b/docs/io/configuration/index.rst @@ -10,7 +10,11 @@ configuration file. The following sections respectively describes what can or mu configuration file, shows an example configuration file, describes how TARDIS checks to make sure a configuration file is valid, and demonstrates how a YAML configuration file is read in. - +.. caution:: + TARDIS parallelization is not working correctly at the moment and might produce incorrect results. + Please avoid using it. + For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021). + .. toctree:: :maxdepth: 1 From 438f76b5a963d5d42247938b061322b7f580312c Mon Sep 17 00:00:00 2001 From: atharva-2001 Date: Tue, 22 Aug 2023 17:23:58 +0530 Subject: [PATCH 7/7] Fix links --- docs/index.rst | 2 +- docs/io/configuration/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index cfda8f06459..08d84b4a09d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,7 +50,7 @@ Mission Statement .. caution:: TARDIS parallelization is not working correctly at the moment and might produce incorrect results. Please avoid using it. - For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021). + For more information, see issue `#2021 `_. .. toctree:: :maxdepth: 2 diff --git a/docs/io/configuration/index.rst b/docs/io/configuration/index.rst index 239047699cd..96483b6b8da 100644 --- a/docs/io/configuration/index.rst +++ b/docs/io/configuration/index.rst @@ -13,7 +13,7 @@ file is valid, and demonstrates how a YAML configuration file is read in. .. caution:: TARDIS parallelization is not working correctly at the moment and might produce incorrect results. Please avoid using it. - For more information, see issue [#2021](https://github.com/tardis-sn/tardis/issues/2021). + For more information, see issue `#2021 `_. .. toctree:: :maxdepth: 1