From 3ccc9a22ebdcc545b2798287a20e82ee3393b344 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Mon, 27 Nov 2023 10:02:33 -0500 Subject: [PATCH] DOC: updated docstrings Updated the description of `mock_download_dir` in the docstrings. --- pysatSpaceWeather/instruments/methods/ace.py | 5 ++-- .../instruments/methods/general.py | 4 ++- pysatSpaceWeather/instruments/methods/gfz.py | 11 +++---- pysatSpaceWeather/instruments/methods/lasp.py | 5 ++-- .../instruments/methods/lisird.py | 5 ++-- pysatSpaceWeather/instruments/methods/swpc.py | 30 +++++++++++-------- pysatSpaceWeather/instruments/sw_ae.py | 5 ++-- pysatSpaceWeather/instruments/sw_al.py | 5 ++-- pysatSpaceWeather/instruments/sw_ap.py | 5 ++-- pysatSpaceWeather/instruments/sw_apo.py | 5 ++-- pysatSpaceWeather/instruments/sw_au.py | 5 ++-- pysatSpaceWeather/instruments/sw_dst.py | 6 +++- pysatSpaceWeather/instruments/sw_f107.py | 5 ++-- pysatSpaceWeather/instruments/sw_flare.py | 5 ++-- pysatSpaceWeather/instruments/sw_hpo.py | 5 ++-- pysatSpaceWeather/instruments/sw_kp.py | 5 ++-- pysatSpaceWeather/instruments/sw_mgii.py | 5 ++-- pysatSpaceWeather/instruments/sw_polarcap.py | 5 ++-- pysatSpaceWeather/instruments/sw_sbfield.py | 5 ++-- pysatSpaceWeather/instruments/sw_ssn.py | 5 ++-- pysatSpaceWeather/instruments/sw_stormprob.py | 5 ++-- 21 files changed, 83 insertions(+), 53 deletions(-) diff --git a/pysatSpaceWeather/instruments/methods/ace.py b/pysatSpaceWeather/instruments/methods/ace.py index c5dcf76f..ab180acc 100644 --- a/pysatSpaceWeather/instruments/methods/ace.py +++ b/pysatSpaceWeather/instruments/methods/ace.py @@ -177,8 +177,9 @@ def download(date_array, name, tag='', inst_id='', data_path='', now=None, Current universal time, if None this is determined for each download. (default=None) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/methods/general.py b/pysatSpaceWeather/instruments/methods/general.py index f2f0e8c1..eea99d2e 100644 --- a/pysatSpaceWeather/instruments/methods/general.py +++ b/pysatSpaceWeather/instruments/methods/general.py @@ -80,7 +80,9 @@ def get_local_or_remote_text(url, mock_download_dir, filename): url : str Remote URL where file is located mock_download_dir : str or NoneType - If not None, directory where file is located + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Returns ------- diff --git a/pysatSpaceWeather/instruments/methods/gfz.py b/pysatSpaceWeather/instruments/methods/gfz.py index b1376919..6ff684f5 100644 --- a/pysatSpaceWeather/instruments/methods/gfz.py +++ b/pysatSpaceWeather/instruments/methods/gfz.py @@ -80,9 +80,9 @@ def json_downloads(date_array, data_path, local_file_prefix, local_date_fmt, If true, selects only the definitive data, otherwise also includes nowcast data (default=False) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - (following the local file prefix and date format) as if they were - downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date (following the local + file prefix and date format) as if they were downloaded (default=None) Raises ------ @@ -188,8 +188,9 @@ def kp_ap_cp_download(platform, name, date_array, tag, inst_id, data_path, data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date (following the local + file prefix and date format) as if they were downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/methods/lasp.py b/pysatSpaceWeather/instruments/methods/lasp.py index 0b4fcca8..c8688d44 100644 --- a/pysatSpaceWeather/instruments/methods/lasp.py +++ b/pysatSpaceWeather/instruments/methods/lasp.py @@ -22,8 +22,9 @@ def prediction_downloads(name, tag, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date (following the local + file prefix and date format) as if they were downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/methods/lisird.py b/pysatSpaceWeather/instruments/methods/lisird.py index 88264a5c..9e444914 100644 --- a/pysatSpaceWeather/instruments/methods/lisird.py +++ b/pysatSpaceWeather/instruments/methods/lisird.py @@ -117,8 +117,9 @@ def download(date_array, data_path, local_file_prefix, local_date_fmt, Dict of fill values to replace with NaN by variable name or None to leave alone (default=None) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date (following the local + file prefix and date format) as if they were downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/methods/swpc.py b/pysatSpaceWeather/instruments/methods/swpc.py index 21a020c4..f6c58569 100644 --- a/pysatSpaceWeather/instruments/methods/swpc.py +++ b/pysatSpaceWeather/instruments/methods/swpc.py @@ -41,8 +41,9 @@ def daily_dsd_download(name, today, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ @@ -106,8 +107,9 @@ def old_indices_dsd_download(name, date_array, data_path, local_files, today, today : dt.datetime Datetime for current day mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ @@ -394,8 +396,9 @@ def solar_geomag_predictions_download(name, date_array, data_path, data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ @@ -570,8 +573,9 @@ def geomag_forecast_download(name, date_array, data_path, data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ @@ -697,8 +701,9 @@ def kp_ap_recent_download(name, date_array, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ @@ -810,8 +815,9 @@ def recent_ap_f107_download(name, date_array, data_path, data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_ae.py b/pysatSpaceWeather/instruments/sw_ae.py index b4297484..aa907273 100644 --- a/pysatSpaceWeather/instruments/sw_ae.py +++ b/pysatSpaceWeather/instruments/sw_ae.py @@ -153,8 +153,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_al.py b/pysatSpaceWeather/instruments/sw_al.py index 1173bd5f..012614af 100644 --- a/pysatSpaceWeather/instruments/sw_al.py +++ b/pysatSpaceWeather/instruments/sw_al.py @@ -153,8 +153,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_ap.py b/pysatSpaceWeather/instruments/sw_ap.py index ee061931..620a3aac 100644 --- a/pysatSpaceWeather/instruments/sw_ap.py +++ b/pysatSpaceWeather/instruments/sw_ap.py @@ -228,8 +228,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Note ---- diff --git a/pysatSpaceWeather/instruments/sw_apo.py b/pysatSpaceWeather/instruments/sw_apo.py index d192768c..c2a1a25a 100644 --- a/pysatSpaceWeather/instruments/sw_apo.py +++ b/pysatSpaceWeather/instruments/sw_apo.py @@ -182,8 +182,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False, update_files : bool Re-download data for files that already exist if True (default=False) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Note ---- diff --git a/pysatSpaceWeather/instruments/sw_au.py b/pysatSpaceWeather/instruments/sw_au.py index 50fa351f..e759c179 100644 --- a/pysatSpaceWeather/instruments/sw_au.py +++ b/pysatSpaceWeather/instruments/sw_au.py @@ -153,8 +153,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_dst.py b/pysatSpaceWeather/instruments/sw_dst.py index fbafcc1c..ed64a664 100644 --- a/pysatSpaceWeather/instruments/sw_dst.py +++ b/pysatSpaceWeather/instruments/sw_dst.py @@ -254,7 +254,11 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + as if they were downloaded + mock_download_dir : str or NoneType + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py index 3a262241..ffd54136 100644 --- a/pysatSpaceWeather/instruments/sw_f107.py +++ b/pysatSpaceWeather/instruments/sw_f107.py @@ -375,8 +375,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False, update_files : bool Re-download data for files that already exist if True (default=False) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_flare.py b/pysatSpaceWeather/instruments/sw_flare.py index 38ebe72d..e510811d 100644 --- a/pysatSpaceWeather/instruments/sw_flare.py +++ b/pysatSpaceWeather/instruments/sw_flare.py @@ -327,8 +327,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False, update_files : bool Re-download data for files that already exist if True (default=False) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_hpo.py b/pysatSpaceWeather/instruments/sw_hpo.py index 44ab971a..d0c822bc 100644 --- a/pysatSpaceWeather/instruments/sw_hpo.py +++ b/pysatSpaceWeather/instruments/sw_hpo.py @@ -181,8 +181,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False, update_files : bool Re-download data for files that already exist if True (default=False) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Note ---- diff --git a/pysatSpaceWeather/instruments/sw_kp.py b/pysatSpaceWeather/instruments/sw_kp.py index e060b3c9..13b6a13e 100644 --- a/pysatSpaceWeather/instruments/sw_kp.py +++ b/pysatSpaceWeather/instruments/sw_kp.py @@ -380,8 +380,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_mgii.py b/pysatSpaceWeather/instruments/sw_mgii.py index a8900f8a..9379c9b3 100644 --- a/pysatSpaceWeather/instruments/sw_mgii.py +++ b/pysatSpaceWeather/instruments/sw_mgii.py @@ -269,8 +269,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_polarcap.py b/pysatSpaceWeather/instruments/sw_polarcap.py index 398d0ec8..0db8f0f3 100644 --- a/pysatSpaceWeather/instruments/sw_polarcap.py +++ b/pysatSpaceWeather/instruments/sw_polarcap.py @@ -166,8 +166,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_sbfield.py b/pysatSpaceWeather/instruments/sw_sbfield.py index d17be17a..04a89c3b 100644 --- a/pysatSpaceWeather/instruments/sw_sbfield.py +++ b/pysatSpaceWeather/instruments/sw_sbfield.py @@ -241,8 +241,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False, update_files : bool Re-download data for files that already exist if True (default=False) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_ssn.py b/pysatSpaceWeather/instruments/sw_ssn.py index 81079eb9..6ecfd378 100644 --- a/pysatSpaceWeather/instruments/sw_ssn.py +++ b/pysatSpaceWeather/instruments/sw_ssn.py @@ -277,8 +277,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False, update_files : bool Re-download data for files that already exist if True (default=False) mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_stormprob.py b/pysatSpaceWeather/instruments/sw_stormprob.py index d91ea2d9..0fef92c9 100644 --- a/pysatSpaceWeather/instruments/sw_stormprob.py +++ b/pysatSpaceWeather/instruments/sw_stormprob.py @@ -167,8 +167,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. mock_download_dir : str or NoneType - If not None, will process any files with the correct name and date - as if they were downloaded (default=None) + Local directory with downloaded files or None. If not None, will + process any files with the correct name and date as if they were + downloaded (default=None) Raises ------