AquaMatch_documentation/config.yml at main · AquaSat/AquaMatch_documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# This config file allows for three types of pipeline operation:
#
# 1) default: create all harmonization files from scratch using the files downloaded
# locally by the AquaMatch_download_WQP repository and associated pipeline.
# This is most useful if you have run the AquaMatch_download_WQP pipeline locally.
# This config option will error if you have not completed the download pipeline
# locally.
#
# 2) use_stable: using the most recent 'stable' downloads produced by the ROSS group,
# harmonize the WQP files using this pipeline. This would be most useful if you
# are customizing the decisions made within the harmonization pipeline.
#
# 3) admin_update: for use by the ROSS group to update stable versions of the
# harmonization pipeline. This config option requires write access to the ROSS
# Google email.
#
# Default: provide email and drive folder and use dynamic, user-created local versions,
# but not the stable versions created by the AquaMatch project.
default:
  # gmail account to associate with {googledrive} package
  google_email: ""
  # The local directory where the first {targets} pipeline is located (i.e.,
  # the pipeline that runs the download step)
  download_repo_directory: "../AquaMatch_download_WQP/"
  # Use a stable version of the parameter datasets?
  chl_use_stable: FALSE
  doc_use_stable: FALSE
  sdd_use_stable: FALSE
  tss_use_stable: FALSE
  tc_use_stable: FALSE
  # Use the stable version of other files created in the download step?
  general_use_stable: FALSE
  drive_project_folder: "" # folder name must end with "/", if you use a nested
  # folder location, you will need to create that folder structure before using
  # this pipeline
# External user runs harmonization using stable datasets, creates harmonized
# datasets in their own Google Drive - you will need to enter your email in
# `google_email` and the desired path for the files to be stored within your
# Google Drive in `drive_project_folder`
use_stable:
  google_email: ""
  download_repo_directory: "../AquaMatch_download_WQP/"
  chl_stable_date: "20240701" #YYYYMMDD format
  doc_stable_date: "20240701" #YYYYMMDD format
  sdd_stable_date: "20240701" #YYYYMMDD format
  tc_stable_date: "20240701" #YYYYMMDD format
  tss_stable_date: "20241205" #YYYYMMDD format
  general_stable_date: "20240701" #YYYYMMDD format
  drive_project_folder: "" # folder name must end with "/", if you use a nested
  # folder location, you will need to create that folder structure before using
  # this pipeline
# Update the stable dataset version for one or more parameters, requires write
# access for the ROSS group Google account.
admin_update:
  google_email: "therossyndicate@gmail.com"
  download_repo_directory: "../AquaMatch_download_WQP/"
  cdom_stable_date: "20250626" #YYYYMMDD format
  chl_stable_date: "20240701" #YYYYMMDD format
  doc_stable_date: "20240701" #YYYYMMDD format
  sdd_stable_date: "20240701" #YYYYMMDD format
  tc_stable_date: "20240701" #YYYYMMDD format
  tss_stable_date: "20250430" #YYYYMMDD format
  general_stable_date: "20240701" #YYYYMMDD format
  drive_project_folder: "~/aquamatch_download_wqp/" # folder name must end with "/",
  # if you use a nested  folder location, you will need to create that folder
  # structure before using this pipeline