Skip to content

Cube file structure and naming convention

Hans Permana edited this page Oct 11, 2017 · 3 revisions

There is a need to create a meaningful pattern of the generated cube so that it can be easily identifiable and also easily integrated with any potential tools that consume the data.

For that, the following structure has been defined:

Naming convention

esdc-${temporal_resolution}-${spatial_resolution}-${chunk_size}-${cube_model_version} 

Description:

  • There are 4 different parameters that are encoded into the directory name: temporal_resolution, spatial_resolution, chunk_size, and cube_model_version. Each of the parameter is separated by a -.
  • temporal_resolution: the temporal resolution of the cube in days with letter d as the suffix. Example:
    • 1d (1 day)
    • 8d (8 days)
    • 10d (10 days)
  • spatial_resolution: the spatial resolution of the cube in degrees with deg as the suffix. There is no limit on the number of decimal places (if any), but to ensure the readability, try keep it minimum. Example:
    • 0.25deg (0.25 degrees)
    • 0.083deg (0.083 degrees)
  • chunk_size: the chunk size of the cube in 3 dimensions in the order of time, latitude, and longitude separated by x. When no chunking was applied, use no_chunking. Example:
    • 1x100x100 (chunked in 1 (time), 100 (latitude), and 100 (longitude))
    • 1x2160x4320 (chunked in 1 (time), 2160 (latitude), and 4320 (longitude))
    • 46x270x270 (chunked in 46 (time), 270 (latitude), and 270 (longitude))
  • cube_model_version: the cube model version plus a minor version to distinguish cube with exactly the same configuration and has been generated for different purpose. It can be a number or a word (or words without any hyphen - or underscore _). Example:
    • 0.2.3_1 (cube model 0.2.3, first generation)
    • 0.2.3_after2005 (cube model 0.2.3, only has data from 2005 onwards)
    • 1.0.1_forcate (cube model 1.0.1, generated for usage by CATE - an external software)
    • 1.0.1_europe(cube model 1.0.1, only for europe region)
    • 1.0.1_20022005(cube model 1.0.1, only for period 2002-2005)

Directory structure

any-directory
  |- esdc-8d-0.25deg-1x720x1440-1.0.1_1
  |   |- data
  |   |   |- aerosol_optical_thickness_550
  |   |   |   |- 2002_aerosol_optical_thickness_550.nc
  |   |   |   |- ...
  |   |   |   |- ...
  |   |   |   |- ...
  |   |   |   |- 2011_aerosol_optical_thickness_550.nc
  |   |   |- aerosol_optical_thickness_555
  |   |   |- ...
  |   |   |- ...
  |   |   |- ...
  |   |   |- white_sky_albedo
  |   |- CHANGELOG
  |   |- cube.config
  |- esdc-8d-0.25deg-46x100x100-1.0.1_1
  |- esdc-8d-0.25deg-no_chunking-0.2.3_1
  |- esdc-8d-0.25deg-no_chunking-1.0.0_1
  |- esdc-8d-0.083deg-1x1080x1080-1.0.1_1
  |- esdc-8d-0.083deg-46x100x100-1.0.1_1
  |- esdc-8d-0.083deg-no_chunking-0.2.3_1
Clone this wiki locally