varunayan package

Subpackages

• varunayan.download package
  • Submodules
    • varunayan.download.era5_downloader module
      • BlockInfoFilter
      • set_v_downloader()
      • download_era5_single_lvl()
      • download_era5_pressure_lvl()
  • Module contents
    • download_era5_single_lvl()
    • download_era5_pressure_lvl()
    • set_v_downloader()
• varunayan.processing package
  • Submodules
    • varunayan.processing.data_aggregator module
      • set_v_data_agg()
      • aggregate_by_frequency()
      • aggregate_pressure_levels()
    • varunayan.processing.data_filter module
      • set_v_data_fil()
      • filter_netcdf_by_shapefile()
      • get_unique_coordinates_in_polygon()
    • varunayan.processing.file_handler module
      • set_v_file_han()
      • extract_download()
      • find_netcdf_files()
    • varunayan.processing.variable_lists module
  • Module contents
    • aggregate_by_frequency()
    • aggregate_pressure_levels()
    • filter_netcdf_by_shapefile()
    • get_unique_coordinates_in_polygon()
    • extract_download()
    • find_netcdf_files()
    • set_v_file_han()
    • set_v_data_fil()
    • set_v_data_agg()
• varunayan.search_and_desc package
  • Submodules
    • varunayan.search_and_desc.pressure_levels_variables module
    • varunayan.search_and_desc.search_and_desc_functions module
      • get_available_datasets()
      • get_single_levels_dataset()
      • get_pressure_levels_dataset()
      • describe_variables()
      • search_variable()
    • varunayan.search_and_desc.single_levels_variables module
  • Module contents
    • describe_variables()
    • search_variable()
• varunayan.util package
  • Submodules
    • varunayan.util.geojson_utils module
      • set_v_geoj_utl()
      • extract_coords_from_geometry()
      • get_bounding_box()
      • load_json_with_encoding()
      • is_valid_geojson()
      • convert_to_geojson()
      • create_geojson_from_bbox()
      • create_temp_geojson()
    • varunayan.util.logging_utils module
      • Colors
      • ColorFormatter
      • get_logger()
  • Module contents
    • extract_coords_from_geometry()
    • get_bounding_box()
    • load_json_with_encoding()
    • is_valid_geojson()
    • convert_to_geojson()
    • create_geojson_from_bbox()
    • create_temp_geojson()
    • Colors
      • Colors.RESET
      • Colors.RED
      • Colors.GREEN
      • Colors.YELLOW
      • Colors.BLUE
      • Colors.PURPLE
      • Colors.CYAN
      • Colors.WHITE
      • Colors.GREEN_BRIGHT
      • Colors.RED_BRIGHT
      • Colors.YELLOW_BRIGHT
      • Colors.BLUE_BRIGHT
      • Colors.CYAN_BRIGHT
    • get_logger()
    • set_v_geoj_utl()

Submodules

• varunayan.cli module
  • parse_flexible_date()
  • main()
• varunayan.config module
  • set_v_config()
  • set_api_key()
  • check_cdsapi_config()
  • setup_cdsapi_config()
  • ensure_cdsapi_config()
• varunayan.core module
  • ProcessingParams
    • ProcessingParams.request_id
    • ProcessingParams.variables
    • ProcessingParams.start_date
    • ProcessingParams.end_date
    • ProcessingParams.frequency
    • ProcessingParams.resolution
    • ProcessingParams.dataset_type
    • ProcessingParams.pressure_levels
    • ProcessingParams.north
    • ProcessingParams.south
    • ProcessingParams.east
    • ProcessingParams.west
    • ProcessingParams.geojson_file
    • ProcessingParams.geojson_data
    • ProcessingParams.dist_features
    • ProcessingParams.__init__()
  • set_verbosity()
  • download_with_retry()
  • process_time_chunks()
  • process_era5_data()
  • aggregate_and_save()
  • adjust_sum_variables()
  • save_results()
  • process_era5()
  • print_processing_header()
  • validate_inputs()
  • load_and_validate_geojson()
  • print_bounding_box()
  • print_processing_strategy()
  • calculate_map_dimensions()
  • draw_geojson_ascii()
  • print_processing_footer()
  • era5ify_geojson()
  • era5ify_bbox()
  • era5ify_point()
  • parse_date()
  • cleanup_temp_files()

Module contents

varunayan.era5ify_geojson(request_id: str, variables: List[str], start_date: str, end_date: str, json_file: str, dist_features: List[str] | None = None, dataset_type: str = 'single', pressure_levels: List[str] | None = None, frequency: str = 'hourly', resolution: float = 0.25, verbosity: int = 0, save_raw: bool = True) → DataFrame

Public function for querying data for a GeoJSON.

Parameters:

• request_id (str) – Unique identifier for the request.

• variables (List[str]) – List of variables to download.

• start_date (str) – Start date of the data in ‘YYYY-M-D’ or ‘YYYY-MM-DD’ format.

• end_date (str) – End date of the data in ‘YYYY-M-D’ or ‘YYYY-MM-DD’ format.

• json_file (str) – Path to the GeoJSON file.

• dist_features (List[str] | None, optional) – List of feature properties to distinguish different areas in the GeoJSON. Defaults to None.

• dataset_type (str, optional) – Type of dataset. Either ‘single’ (single level) or ‘pressure’ (pressure level). Defaults to ‘single’.

• pressure_levels (List[str] | None, optional) – List of pressure levels to download (e.g., [“1000”, “925”, “850”]). Defaults to None.

• frequency (str, optional) – Frequency of the data (‘hourly’, ‘daily’, ‘weekly’, ‘monthly’, ‘yearly’). Defaults to ‘hourly’.

• resolution (float, optional) – Spatial resolution in degrees (0.25, 0.1, 0.5, etc.). Defaults to 0.25, minimum is 0.1.

• verbosity (int, optional) – Verbosity level (0 for no output, 1 for info output, 2 for debug/complete output). Defaults to 0.

• save_raw (bool, optional) – Whether to save the raw data. Defaults to True.

Returns:

A DataFrame containing the processed data for the region described by GeoJSON.

Return type:

DataFrame

varunayan.era5ify_bbox(request_id: str, variables: List[str], start_date: str, end_date: str, north: float, south: float, east: float, west: float, dataset_type: str = 'single', pressure_levels: List[str] | None = None, frequency: str = 'hourly', resolution: float = 0.25, verbosity: int = 0, save_raw: bool = True) → DataFrame

Public function for querying data for a defined bounding box (north, south, east, west bounds).

Parameters:

• request_id (str) – Unique identifier for the request.

• variables (List[str]) – List of variables to download.

• start_date (str) – Start date of the data in ‘YYYY-M-D’ or ‘YYYY-MM-DD’ format.

• end_date (str) – End date of the data in ‘YYYY-M-D’ or ‘YYYY-MM-DD’ format.

• north (float) – Northern bound of the bounding box.

• south (float) – Southern bound of the bounding box.

• east (float) – Eastern bound of the bounding box.

• west (float) – Western bound of the bounding box.

• dataset_type (str, optional) – Type of dataset. Either ‘single’ (single level) or ‘pressure’ (pressure level). Defaults to ‘single’.

• pressure_levels (List[str] | None, optional) – List of pressure levels to download (e.g., [“1000”, “925”, “850”]). Defaults to None.

• frequency (str, optional) – Frequency of the data (‘hourly’, ‘daily’, ‘weekly’, ‘monthly’, ‘yearly’). Defaults to ‘hourly’.

• resolution (float, optional) – Spatial resolution in degrees (0.25, 0.1, 0.5, etc.). Defaults to 0.25, minimum is 0.1.

• verbosity (int, optional) – Verbosity level (0 for no output, 1 for info output, 2 for debug/complete output). Defaults to 0.

• save_raw (bool, optional) – Whether to save the raw data. Defaults to True.

Returns:

A DataFrame containing the processed data for the specified bbox.

Return type:

DataFrame

varunayan.era5ify_point(request_id: str, variables: List[str], start_date: str, end_date: str, latitude: float, longitude: float, dataset_type: str = 'single', pressure_levels: List[str] | None = None, frequency: str = 'hourly', verbosity: int = 0, save_raw: bool = True) → DataFrame

Public function for querying data for a single geographical point (latitude, longitude).

Parameters:

• request_id (str) – Unique identifier for the request.

• variables (List[str]) – List of variables to download.

• start_date (str) – Start date of the data in ‘YYYY-M-D’ or ‘YYYY-MM-DD’ format.

• end_date (str) – End date of the data in ‘YYYY-M-D’ or ‘YYYY-MM-DD’ format.

• latitude (float) – Latitude of the point of interest.

• longitude (float) – Longitude of the point of interest.

• dataset_type (str, optional) – Type of dataset. Either ‘single’ (single level) or ‘pressure’ (pressure level). Defaults to ‘single’.

• pressure_levels (List[str] | None, optional) – List of pressure levels to download (e.g., [“1000”, “925”, “850”]). Defaults to None.

• frequency (str, optional) – Frequency of the data (‘hourly’, ‘daily’, ‘weekly’, ‘monthly’, ‘yearly’). Defaults to ‘hourly’.

• verbosity (int, optional) – Verbosity level (0 for no output, 1 for info output, 2 for debug/complete output). Defaults to 0.

• save_raw (bool, optional) – Whether to save the raw data. Defaults to True.

Returns:

A DataFrame containing the processed data for the specified point.

Return type:

DataFrame

varunayan.describe_variables(variable_names: List[str], dataset_type: str) → Dict[str, str]

Get descriptions for specific variables

Parameters:

• variable_names (list) – List of variable names to describe

• dataset_type (str) – Dataset type to search (“single”, “pressure”, “all”, or any other registered dataset)

varunayan.search_variable(pattern: str | None, dataset_type: str = 'all') → None

Search for variables in the dataset by pattern

Parameters:

• pattern (str or None) – The string pattern to search for in variable names. If None, prints all variables.

• dataset_type (str) – Dataset type to search (“single”, “pressure”, “all”, or any other registered dataset)