diff --git a/doc/RTD/source/Task/index.rst b/doc/RTD/source/Task/index.rst index e701e924a79f9256d4c0b034b6c15651f41ff405..82210895618618f87faaada472c72afe321b1d04 100644 --- a/doc/RTD/source/Task/index.rst +++ b/doc/RTD/source/Task/index.rst @@ -9,10 +9,12 @@ Task System This section of the documentation includes information on the task system available in SWIFT, as well as how to implement your own task. -SWIFT produces at the beginning of each simulation a ``dot`` file (see the graphviz library for more information). -It contains the full hierarchy of tasks used in this simulation. +SWIFT can produce a graph containing all the dependencies using graphviz. +At the beginning of each simulation a ``csv`` file is generated and can be transformed into a ``png`` with the script ``tools/plot_task_dependencies.py``. +This script has also the possibility to generate a list of function calls for each task with the option ``--with-calls``. You can convert the ``dot`` file into a ``png`` with the following command -``dot -Tpng dependency_graph.dot -o dependency_graph.png``. +``dot -Tpng dependency_graph.dot -o dependency_graph.png`` or directly read it with the python module ``xdot`` with ``python -m xdot dependency_graph.dot``. + .. toctree:: :maxdepth: 2