Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation about the parallelization problem #2399

Merged
merged 7 commits into from
Aug 22, 2023
Merged

Update documentation about the parallelization problem #2399

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
44c7d97
Add messages in quickstart and configuration docs index
atharva-2001 Aug 21, 2023
f65f15a
Quickstart note fix
atharva-2001 Aug 21, 2023
dba9474
Try admonition
atharva-2001 Aug 21, 2023
0859a7b
Warning quickstart
atharva-2001 Aug 21, 2023
2d072e4
Try line
atharva-2001 Aug 21, 2023
621ce2b
Add note in docs front page
atharva-2001 Aug 22, 2023
438f76b
Fix links
atharva-2001 Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/io/configuration/components/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://raw.githubusercontent.com/tardis-sn/tardis/master/docs/tardis_example.yml>`_.

.. 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:
Expand Down
23 changes: 18 additions & 5 deletions docs/quickstart.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
"<div class=\"alert alert-danger\">\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>"
]
},
{
"cell_type": "code",
"execution_count": null,
Expand Down Expand Up @@ -110,9 +125,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"scrolled": false
},
"metadata": {},
"outputs": [],
"source": [
"sim = run_tardis(\"tardis_example.yml\", \n",
Expand Down Expand Up @@ -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
}