disdrodb.data_transfer package

Submodules

disdrodb.data_transfer.download_data module

disdrodb.data_transfer.download_data.click_download_option(function: object)[source]

Click command line options for DISDRODB archive download transfer. :param function: Function. :type function: object

disdrodb.data_transfer.download_data.download_disdrodb_archives(disdrodb_dir: str, data_sources: Optional[Union[str, List[str]]] = None, campaign_names: Optional[Union[str, List[str]]] = None, station_names: Optional[Union[str, List[str]]] = None, force: bool = False)[source]

Get all YAML files that contain the ‘data_url’ key and download the data locally.

Parameters

  • disdrodb_dir (str, optional) – DisdroDB data folder path. Must end with DISDRODB.

  • data_sources (str or list of str, optional) – Data source folder name (eg : EPFL). If not provided (None), all data sources will be downloaded. The default is data_source=None.

  • campaign_names (str or list of str, optional) – Campaign name (eg : EPFL_ROOF_2012). If not provided (None), all campaigns will be downloaded. The default is campaign_name=None.

  • station_names (str or list of str, optional) – Station name. If not provided (None), all stations will be downloaded. The default is station_name=None.

  • force (bool, optional) – If True, overwrite the already existing raw data file. The default is False.

disdrodb.data_transfer.download_data.get_station_local_remote_locations(yaml_file_path: str) → tuple[source]

Return the station’s local path and remote url.

Parameters

yaml_file_path (str) – Path to the metadata YAML file.

Returns

Tuple containing the local path and the url.

Return type

tuple

disdrodb.data_transfer.upload_data module

disdrodb.data_transfer.upload_data.click_upload_option(function: object)[source]

Click command line options for DISDRODB archive upload transfer.

Parameters

function (object) – Function.

disdrodb.data_transfer.upload_data.upload_disdrodb_archives(platform: Optional[str] = None, force: bool = False, **kwargs) → None[source]

Find all stations containing local data and upload them to a remote repository.

Parameters

  • platform (str, optional) – Name of the remote platform. If not provided (None), the default platform is Zenodo. The default is platform=None.

  • force (bool, optional) – If True, upload even if data already exists on another remote location. The default is force=False.

  • disdrodb_dir (str, optional) – DisdroDB data folder path. Must end with DISDRODB.

  • data_sources (str or list of str, optional) – Data source folder name (eg: EPFL). If not provided (None), all data sources will be uploaded. The default is data_source=None.

  • campaign_names (str or list of str, optional) – Campaign name (eg: EPFL_ROOF_2012). If not provided (None), all campaigns will be uploaded. The default is campaign_name=None.

  • station_names (str or list of str, optional) – Station name. If not provided (None), all stations will be uploaded. The default is station_name=None.

Module contents