From a8af8c45c738f0759cc60eb1484de9723f8c7984 Mon Sep 17 00:00:00 2001 From: Israel Martinez Date: Tue, 20 Feb 2024 15:58:26 -0500 Subject: [PATCH] Add wasabi function to to docs --- cosipy/util/data_fetching.py | 12 ++++++------ docs/api/index.rst | 2 +- docs/api/util.rst | 4 ++++ docs/conf.py | 3 ++- 4 files changed, 13 insertions(+), 8 deletions(-) create mode 100644 docs/api/util.rst diff --git a/cosipy/util/data_fetching.py b/cosipy/util/data_fetching.py index 1d8dce02..bef3e66c 100644 --- a/cosipy/util/data_fetching.py +++ b/cosipy/util/data_fetching.py @@ -13,18 +13,18 @@ def fetch_wasabi_file(file, Parameters ---------- - file: str + file : str Full path to file in Wasabi - output: str + output : str, optional Full path to the downloaded file in the local system. By default it will use the current durectory and the same file name as the input file. - bucket: str + bucket : str, optional Passed to aws --bucket option - endpoint: str: + endpoint : str, optional Passed to aws --endpoint-url option - access_key: str + access_key : str, optional AWS_ACCESS_KEY_ID - secret_key: str + secret_key : str, optional AWS_SECRET_ACCESS_KEY """ diff --git a/docs/api/index.rst b/docs/api/index.rst index bccae241..79f566d5 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -18,6 +18,6 @@ If you are instead interested in an overview on how to use cosipy, see out `tuto threeml ts_map image_deconvolution + util - diff --git a/docs/api/util.rst b/docs/api/util.rst new file mode 100644 index 00000000..962a8863 --- /dev/null +++ b/docs/api/util.rst @@ -0,0 +1,4 @@ +Utilities +========= + +.. autofunction:: cosipy.util.fetch_wasabi_file diff --git a/docs/conf.py b/docs/conf.py index 57a82fdb..3d93c3f6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -65,7 +65,8 @@ 'scoords', 'pandas', 'tqdm', - 'scipy'] + 'scipy', + 'awscli'] # There seems to be a conflict between unittest.mock (used by sphinx) and metaclasses # The cosipy.threeml.custom_functions.Band_Eflux includes a metaclass from