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

Jump to bottom

Add missing demo data directory entry to config documentation #1765

Merged
merged 1 commit into from
Aug 18, 2021
Merged

Add missing demo data directory entry to config documentation #1765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/source/config.rst
View file
Open in desktop
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
View file
Open in desktop
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