Skip to content

Commit ab4f5eb

Browse files
committed
ADD: info regarding s3 writing and reading in main.rst
1 parent 4f6d353 commit ab4f5eb

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

doc/source/overview/main.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,24 @@ locationConfigFile STRING File name (with full path) of the location config
1616
productConfigFile STRING File name (with full path) of the product configuration file. Described in Section 4.
1717
lastStateFile STRING File name (with full path) of the file containing the time of the last processed scan. Used in particular for real-time processing.
1818
imgformat STRING/ File format(s) of the images. The following formats are supported: eps, png, and jpg. If ``saveimg`` is set to 0, this field is not used.
19-
STRARR
19+
STRARR
2020
saveimgbasepath STRING Base directory for the images to save. The directory structure looks as follows:
2121
``<saveimgbasepath>/<name>/<YYYY-MM-DD>/<datasetname>/<prodname>/<outputname>``
2222
If ``saveimg`` is set to 0, this field is not used.
23-
s3copypath STRING OPTIONAL. Path to an S3 bucket. If provided all generated products will be written there as well using the same data structure. The format must be https://bucket_name.endpoint.domain, for example https://tests.fr-par-1.linodeobjects.com/. The S3 copy procedure will only work if the
24-
environment variables AWS_KEY and AWS_SECRET are defined in the pyrad scope. AWS_KEY contains the S3 bucket AWS key and AWS_SECRET the associated secret.
23+
s3EndpointRead STRING OPTIONAL. Url to an S3 endpoint containing input radar data. The format must be https://endpoint.domain (e.g. https://eu-central-1.linodeobjects.com/), the https:// is not mandatory.
24+
s3BucketRead STRING OPTIONAL. Name of an S3 bucket containing input radar data. It has to be used together with ``s3EndpointRead`` and ``s3PathRead`` to be able to read input radar data from a bucket. The procedure will only work by setting the environment variables S3_KEY_READ and S3_SECRET_READ.
25+
s3PathRead STRING OPTIONAL. Path where to find input radar data in an S3 bucket. The data will be retrieved at url https://s3BucketRead.s3EndpointRead/s3PathRead/*
26+
rm_s3_file INT OPTIONAL. If set input radar data files downloaded from and S3 bucket will be removed after reading.
27+
s3EndpointWrite STRING OPTIONAL. Url to an S3 endpoint where to store output data. The format must be https://endpoint.domain (e.g. https://eu-central-1.linodeobjects.com/), the https:// is not mandatory.
28+
s3BucketWrite STRING OPTIONAL. Name of an S3 bucket containing input radar data. It has to be used together with ``s3EndpointWrite`` and ``s3PathWrite`` to be able to save output data to a bucket. The procedure will only work by setting the environment variables S3_KEY_WRITE and S3_SECRET_WRITE.
29+
s3PathWrite STRING OPTIONAL. Path where to save output radar data in an S3 bucket. The data will be saved at url https://s3BucketRead.s3EndpointRead/s3PathRead/filename
2530
loadbasepath STRING OPTIONAL. Base path of saved data. By default, this field is set to ``saveimgbasepath``.
2631
loadname STRING OPTIONAL. Name of the saved data processing. Used for saved volume loading. By default, this field is set to ``name``.
27-
gecsxbasepath STRING OPTIONAL. Base path of saved visibility fields generated by the GECSX tool
28-
gecsxname STRING OPTIONAL. Name of the dataset generated by GEXSX in which the visibility fields are contained. Used for GECSX volume loading.
32+
gecsxbasepath STRING OPTIONAL. Base path of saved visibility fields generated by the GECSX tool
33+
gecsxname STRING OPTIONAL. Name of the dataset generated by GEXSX in which the visibility fields are contained. Used for GECSX volume loading.
2934
dempath STRING OPTIONAL. Base directory of the Digital Elevation Model (DEM) files. Basically to load the radar visibility (Optional).
3035
smnpath STRING OPTIONAL. Base directory of the SwissMetNet stations data. Used in the comparison between radar data and rain gauges (Optional).
3136
disdropath STRING OPTIONAL. Base directory of the disdrometer data. Used in the comparison between radar data and disdrometers (Optional).
3237
solarfluxpath STRING OPTIONAL. Base directory of the solar flux data. Used to plot the calibration bias based on sun monitoring (Optional).
3338
iconpath STRING OPTIONAL. Base directory of the ICON (NWP model) data files.
3439
==================== ======= =======================================================================================
35-
36-

0 commit comments

Comments
 (0)