Skip to content

Commit 2718b4c

Browse files
authored
Merge pull request #336 from zmoon/doc-dask-pb-opt
Document `enable_dask_progress_bars` option
2 parents ddd3d7d + 2144e1c commit 2718b4c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/appendix/yaml.rst

+11
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,17 @@ regarding the directory files are read from.
7878
**add_logo:** This is an optional argument.
7979
Set this to ``false`` to forgo adding the MELODIES MONET logo to the plots.
8080

81+
**enable_dask_progress_bars:** This is an optional argument.
82+
Set this to ``true`` to enable Dask progress bars for a
83+
`Dask local task scheduler <https://docs.dask.org/en/stable/diagnostics-local.html>`__
84+
(i.e. not ``dask.distributed``).
85+
By default, this is disabled to keep logs cleaner
86+
(e.g. using :doc:`the CLI </cli>` to run a control file in a batch job).
87+
However, you may wish to enable this for interactive use in a Jupyter notebook
88+
or other interactive Python session,
89+
as it gives you some visual indication of the progress of multi-file data loading
90+
and some parts of the processing.
91+
8192
Models
8293
------
8394
All input for each instance of the model class. First level should be the model

0 commit comments

Comments
 (0)