Update documentation about the parallelization problem (#2399)

tardis-sn · Aug 22, 2023 · 59bdcf3 · 59bdcf3
1 parent e444787
commit 59bdcf3
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 6 deletions.
diff --git 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
@@ -10,6 +10,7 @@ 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
 <https://raw.githubusercontent.com/tardis-sn/tardis/master/docs/tardis_example.yml>`_.
 
+
 .. 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/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
 

diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb
@@ -56,6 +56,22 @@
     "The configuration file [tardis_example.yml](https://github.com/tardis-sn/tardis/tree/master/docs/tardis_example.yml) is used throughout this Quickstart."
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-warning\">\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",
+    "</div>\n"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -110,9 +126,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "sim = run_tardis(\"tardis_example.yml\", \n",
@@ -193,9 +207,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
 }