The function orders S2 products from -Long Term Archive.
+This function is deprecated and will be removed.
Named character: list of the products to be ordered,
-in the format safelist (see safelist).
-Alternatively, it can be the path of a JSON file exported by a previous
-execution of s2_order, in case the user wants, for any reason, to
-resubmit the order.
Logical or character: if TRUE (default), -the list of ordered products is saved in a JSON text file, so to be easily -retrievable at a later stage with safe_is_online or s2_download; -if FALSE, no output files are generated. -It is also possible to pass the path of an existing folder in which the -JSON file will be saved (otherwise, a default path is used).
Numeric: time frame (in seconds) to leave between two -consecutive orders. Default is 0.5 seconds: use a higher value if you -encountered errors (i.e. not all the products were correctly ordered).
Path of the apihub.txt file containing credentials
-of SciHub account.
-If NA (default), the default location inside the package will be used.
Character: it can be "dhus" or "apihub", in which cases
-the required service is forced instead that the one present in the URLs
-passed through argument s2_prodlist.
-If NA (default), the service present in the URLs is maintained.
Logical: If TRUE, and a json file exported by s2_order
-is passed as argument to the function, try to order again also
-the "available" and "ordered" S2 datasets.
-Otherwise, only order the "notordered" ones.
A named vector, containing the subset of s2_prodlist elements
-which were ordered.
-Moreover, the vector includes the following attributes:
"available" with the elements of s2_prodlist which were already
-available for download,
"notordered" with the elements of s2_prodlist which were not ordered
-for any reasons,
"path" (only if argument export_prodlist is not FALSE) with the path
-of the json file in which the list of the products (ordered, available
-and not ordered) was saved (if export_prodlist = TRUE).
License: GPL 3.0
-L. Ranghetti, M. Boschetti, F. Nutini, L. Busetto (2020). -"sen2r": An R toolbox for automatically downloading and preprocessing -Sentinel-2 satellite data. Computers & Geosciences, 139, 104473. -doi:10.1016/j.cageo.2020.104473 -, URL: https://sen2r.ranghetti.info/.
-if (FALSE) {
-
-# Generate the lists of products
-pos <- sf::st_sfc(sf::st_point(c(-57.8815,-51.6954)), crs = 4326)
-time_window <- as.Date(c("2019-10-21", "2019-11-20"))
-list_safe <- s2_list(spatial_extent = pos, time_interval = time_window)
-print(list_safe)
-# (at the time the documentation was updated, this list was containing 6
-# archives already available online and 3 stored in the Long Term Archive)
-
-# Order the products
-ordered_prods <- s2_order(list_safe)
-
-# Check in a second time if the product was made available
-(order_path <- attr(ordered_prods, "path"))
-safe_is_online(order_path)
-
-}
-R/safe_is_online.R
safe_is_online.RdThe function checks if the required SAFE archives are -available for download, or if they have to be ordered from the Long Term -Archive.
+This function is deprecated and will be removed.
safe_is_online(s2_prodlist = NULL, apihub = NA, verbose = TRUE)Named character: list of the products to be checked,
-in the format safelist (see safelist).
-Alternatively, it can be the path of a JSON file exported by s2_order.
Path of the "apihub.txt" file containing credentials -of SciHub account. -If NA (default), the default location inside the package will be used.
Logical: if TRUE, provide processing messages summarising
-how many of the SAFE archives in s2_prodlist are available online.
A logical vector of the same length and names of the SAFE products
-passed with s2_prodlist,
-in which each element is TRUE if the corresponding SAFE archive is
-available for download, FALSE if it is not or NA in case of errors with
-the SAFE url.
License: GPL 3.0
-L. Ranghetti, M. Boschetti, F. Nutini, L. Busetto (2020). -"sen2r": An R toolbox for automatically downloading and preprocessing -Sentinel-2 satellite data. Computers & Geosciences, 139, 104473. -doi:10.1016/j.cageo.2020.104473 -, URL: https://sen2r.ranghetti.info/.
-# \donttest{
-if (is_scihub_configured()) {
-
-# Generate the lists of products
-pos <- sf::st_sfc(sf::st_point(c(-57.8815,-51.6954)), crs = 4326)
-time_window <- as.Date(c("2018-02-21", "2018-03-20"))
-list_safe <- s2_list(spatial_extent = pos, time_interval = time_window)
-# (at the time the documentation was written, this list was containing 5
-# archives already available online and 2 stored in the Long Term Archive)
-
-# Check for availability
-safe_is_online(list_safe)
-
-}
-#> Spherical geometry (s2) switched off
-#> old-style crs object detected; please recreate object with a recent sf::st_crs()
-#> old-style crs object detected; please recreate object with a recent sf::st_crs()
-#> old-style crs object detected; please recreate object with a recent sf::st_crs()
-#> Spherical geometry (s2) switched on
-#> 0 out of 7 products are online.
-#> S2B_MSIL1C_20180224T133629_N0206_R038_T21FVC_20180224T194845.SAFE
-#> FALSE
-#> S2B_MSIL1C_20180227T134629_N0206_R081_T21FVC_20180227T200327.SAFE
-#> FALSE
-#> S2A_MSIL1C_20180301T133641_N0206_R038_T21FVC_20180301T145524.SAFE
-#> FALSE
-#> S2B_MSIL1C_20180306T133629_N0206_R038_T21FVC_20180306T183210.SAFE
-#> FALSE
-#> S2A_MSIL1C_20180311T133641_N0206_R038_T21FVC_20180311T163528.SAFE
-#> FALSE
-#> S2A_MSIL1C_20180314T134631_N0206_R081_T21FVC_20180314T150724.SAFE
-#> FALSE
-#> S2B_MSIL1C_20180316T133639_N0206_R038_T21FVC_20180316T145348.SAFE
-#> FALSE
-# }
-R/scihub_login.R
scihub_login.Rdread_scihub_login() reads the SciHub login information;
write_scihub_login() saves new username and password;
check_scihub_login() checks their validity;
is_scihub_configured() check if SciHub credentials are configured.
Login information is stored in a file apihub.txt inside the
-".sen2r" subfolder of the home directory. These functions allow reading
-or writing this file, and editing it from the GUI.
-In case file apihub.txt is missing, read_scihub_login() searches inside
-the environmental variables SCIHUB_USER and SCIHUB_PASSWORD.
These functions are deprecated and will be removed.
Path of the file in which login information is saved. -If NA (default) it is automatically read from the package default location.
SciHub username.
SciHub password.
Character: it can be "dhus" or "apihub" (default).
Logical: if TRUE (default), new credentials are checked
-before writing them on apihub_path (if they are invalid, an error
-is provided);
-if FALSE, they are directly written.
Logical: if TRUE, new credentials are added
-to the ones existing within apihub_path;
-if FALSE (default), apihub_path is replaced with the new ones.
read_scihub_login() returns a matrix of credentials,
-in which username is in the first column, password in the second.
is_scihub_configured() returns TRUE if credentials can be
-accessed, FALSE if not.
check_scihub_login() returns TRUE if credentials are valid,
-FALSE elsewhere.
check_scihub_connection() returns TRUE if internet connection
-is available and SciHub is accessible, FALSE otherwise.
write_scihub_login() returns NULL.
Notice that new/recently updated SciHub credentials are recognised by API Hub -with a delay of about one week (see https://scihub.copernicus.eu/twiki/do/view/SciHubWebPortal/APIHubDescription for details).
-For this reason, newly created credentials can not immediately be used by sen2r,
-and password edits on old credentials are not immediately recognised.
License: GPL 3.0
-L. Ranghetti, M. Boschetti, F. Nutini, L. Busetto (2020). -"sen2r": An R toolbox for automatically downloading and preprocessing -Sentinel-2 satellite data. Computers & Geosciences, 139, 104473. -doi:10.1016/j.cageo.2020.104473 -, URL: https://sen2r.ranghetti.info/.
-# \donttest{
-is_scihub_configured()
-#> [1] TRUE
-# }
-if (FALSE) {
-check_scihub_connection()
-check_scihub_login("username", "password")
-write_scihub_login("username", "password")
-read_scihub_login()
-}
-(optional) Character vector of length 1 or 2, with the names of +
(deprecate) Character vector of length 1, with the names of
the servers on which SAFE archives are searched.
-Available options are "scihub" (ESA Sentinel Hub) and "gcloud"
-(Google Cloud).
-Default is "scihub", meaning that only ESA Sentinel Hub is considered.
-In case of multiple values, they are used in order of priority and
-products on LTA are always left as last choice.
+Currently, only "gcloud" (Google Cloud) is supported.
+Old "scihub" (ESA Sentinel Hub) can no more be used, since November 2023,
+when the Copernicus Sentinel Data is no longer available and has been
+replaced by the Copernicus Data Space Ecosystem.
See also the section "Details" of s2_list().
Path of the text file containing credentials
-of SciHub account.
-If NA (default), the default location inside the package will be used.
-It takes effect only if argument server includes "scihub".
deprecated