Skip to content

Commit

Permalink
Add missing demo data directory entry to config documentation (#1765)
Browse files Browse the repository at this point in the history
  • Loading branch information
djhoese committed Aug 18, 2021
1 parent bb61325 commit 3b771a8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
10 changes: 10 additions & 0 deletions doc/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,16 @@ defaults to a different path depending on your operating system following the

.. _download_aux_setting:

Demo Data Directory
^^^^^^^^^^^^^^^^^^^

* **Environment variable**: ``SATPY_DEMO_DATA_DIR``
* **YAML/Config Key**: ``demo_data_dir``
* **Default**: <current working directory>

Directory where demo data functions will download data files to. Available
demo data functions can be found in :mod:`satpy.demo` subpackage.

Download Auxiliary Data
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
3 changes: 2 additions & 1 deletion satpy/_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@
_satpy_dirs = appdirs.AppDirs(appname='satpy', appauthor='pytroll')
_CONFIG_DEFAULTS = {
'cache_dir': _satpy_dirs.user_cache_dir,
'data_dir': _satpy_dirs.user_data_dir,
'config_path': [],
'data_dir': _satpy_dirs.user_data_dir,
'demo_data_dir': '.',
'download_aux': True,
}

Expand Down

0 comments on commit 3b771a8

Please sign in to comment.