deepicedrain/deepicedrain/atlas_catalog.yaml

metadata:
  description: 'An intake catalog for loading ICESat-2 ATLAS datasets'
  version: 1
sources:
  icesat2atlasdownloader:
    description: 'A catalog for downloading Antarctic ICESat-2 ATLAS products from NSIDC based on date'
    args:
      urlpath:
        - simplecache::https://n5eil01u.ecs.nsidc.org/ATLAS/ATL{{atlproduct}}.00{{version}}/{{date.strftime("%Y.%m.%d")}}/ATL{{atlproduct}}_*_*10_00{{version}}_0{{revision}}.h5
        - simplecache::https://n5eil01u.ecs.nsidc.org/ATLAS/ATL{{atlproduct}}.00{{version}}/{{date.strftime("%Y.%m.%d")}}/ATL{{atlproduct}}_*_*11_00{{version}}_0{{revision}}.h5
        - simplecache::https://n5eil01u.ecs.nsidc.org/ATLAS/ATL{{atlproduct}}.00{{version}}/{{date.strftime("%Y.%m.%d")}}/ATL{{atlproduct}}_*_*12_00{{version}}_0{{revision}}.h5
      xarray_kwargs:
        combine: nested
        concat_dim: ""
        engine: h5netcdf
      storage_options:
        simplecache:
          cache_storage: ATL{{atlproduct}}.00{{version}}/{{date.strftime("%Y.%m.%d")}}
          same_names: True
    parameters:
      atlproduct:
        description: ICESat-2/ATLAS product number
        type: str
        default: "06"
        allowed: ["02", "03", "04", "06", "07", "08", "09", "10", "12", "13"]
      date:
        description: Year, month, and day of data acquisition
        type: datetime
        default: 2021.07.15
        min: 2018.10.14
        max: 2021.07.15  # note missing 2018.12.09, and gap from 2019.06.27 to 2019.07.25 (inclusive)
      orbitalsegment:
        description: Orbital Segment
        type: list
        default: [10, 11, 12]
      version:
        description: Version number
        type: int
        default: 4
        allowed: [1, 2, 3, 4]
      revision:
        description: Revision number
        type: int
        default: 1
        allowed: [1, 2]  # note that 2020.04.22 to 2020.05.04 version 3 uses revision 2
    driver: intake_xarray.netcdf.NetCDFSource
  icesat2atl06:
    description: 'Reads in ICESat-2 ATL06 data into an xarray.Dataset, one date and one laser pair at a time'
    args:
      chunks:
        delta_time: 50000
      path_as_pattern: ATL06_{datetime:%Y%m%d%H%M%S}_{referencegroundtrack:4}{cyclenumber:2}{orbitalsegment:2}_{version:3}_{revision:2}.h5
      # urlpath: simplecache::s3://its-live-data.jpl.nasa.gov/icesat2/alt06/rel00{{version}}/ATL06_{{date.strftime("%Y%m%d")}}*_{{referencegroundtrack}}*{{orbitalsegment}}_00{{version}}_0*.h5
      urlpath: simplecache::https://n5eil01u.ecs.nsidc.org/ATLAS/ATL06.00{{version}}/{{date.strftime("%Y.%m.%d")}}/ATL06_*_{{referencegroundtrack}}*{{orbitalsegment}}_00{{version}}_0*.h5
      xarray_kwargs:
        combine: by_coords
        engine: h5netcdf
        group: /{{laser}}/land_ice_segments
        mask_and_scale: true
        parallel: true
      storage_options:
        # s3:
        #   anon: True
        simplecache:
          cache_storage: ATL06.00{{version}}/{{date.strftime("%Y.%m.%d")}}
          same_names: True
    # https://intake.readthedocs.io/en/latest/catalog.html#parameter-definition
    parameters:
        date:
          description: Year, month, and day of data acquisition
          type: datetime
          default: 2021.07.15
          min: 2018.10.14
          max: 2021.07.15  # note missing 2018.12.09, and gap from 2019.06.27 to 2019.07.25 (inclusive)
        referencegroundtrack:
          description: ICESat-2 Reference Ground Track number
          type: str
          default: ""  # Default: "" (all), min: "0000", max: "1387"
        orbitalsegment:
          description: Orbital Segment
          type: str
          default: 11
          allowed: [10, 11, 12]
        laser:
          description: Name of laser
          type: str
          default: gt2l
          allowed: ["gt1l", "gt1r", "gt2l", "gt2r", "gt3l", "gt3r"]
        version:
          description: Version number
          type: int
          default: 3
          allowed: [1, 2, 3]
    driver: intake_xarray.netcdf.NetCDFSource
    metadata:
      plots:
        quickview:
          kind: points
          x: longitude
          y: latitude
          c: h_li
          cmap: Blues
          rasterize: True
          hover: True
          width: 800
          height: 500
          geo: True
          coastline: True
  icesat2atl11:
    description: 'Reads in ICESat-2 ATL11 data into an xarray.Dataset, one laser pair at a time'
    args:
      path_as_pattern: ATL11_{referencegroundtrack:4}{orbitalsegment:2}_{}_{version:3}_{revision:2}.h5
      urlpath:
        - simplecache::https://n5eil01u.ecs.nsidc.org/ATLAS/ATL11.00{{version}}/{{date.strftime("%Y.%m.%d")}}/ATL11_*{{referencegroundtrack}}10_*_00{{version}}_0*.h5
        - simplecache::https://n5eil01u.ecs.nsidc.org/ATLAS/ATL11.00{{version}}/{{date.strftime("%Y.%m.%d")}}/ATL11_*{{referencegroundtrack}}11_*_00{{version}}_0*.h5
        - simplecache::https://n5eil01u.ecs.nsidc.org/ATLAS/ATL11.00{{version}}/{{date.strftime("%Y.%m.%d")}}/ATL11_*{{referencegroundtrack}}12_*_00{{version}}_0*.h5
      xarray_kwargs:
        combine: nested
        concat_dim: ""
        engine: h5netcdf
        group: /{{laser}} # /{{laser}}/ref_surf
        mask_and_scale: true
        parallel: true
      storage_options:
        simplecache:
          cache_storage: ATL11.00{{version}}
          same_names: True
    parameters:
        date:
          description: Year, month, and day of data acquisition
          type: datetime
          default: 2020.03.11
          min: 2019.03.29
          max: 2021.04.21
        referencegroundtrack:
          description: ICESat-2 Reference Ground Track number
          type: str
          default: ""  # Default: "" (all), min: "0000", max: "1387"
        laser:
          description: Name of laser pair
          type: str
          default: pt2
          allowed: ["pt1", "pt2", "pt3"]
        version:
          description: Version number
          type: int
          default: 3
          allowed: [1, 2, 3]
    driver: intake_xarray.netcdf.NetCDFSource
    metadata:
      plots:
        quickview:
          kind: points
          x: longitude
          y: latitude
          c: h_corr
          cmap: Blues
          rasterize: True
          hover: True
          width: 800
          height: 500
          geo: True
          coastline: True
  icesat2dhdt:
    description: 'Preprocessed ICESat-2 height change over time (dhdt) data in columnar Parquet format'
    args:
      urlpath: ATLXI/df_dhdt_{{placename}}.parquet
      engine: pyarrow
    parameters:
      placename:
        description: Name of a geographic locality in Antarctica
        type: str
        default: siple_coast
        allowed:
          - amundsen_sea_embayment
          - kamb
          - siple_coast
          - slessor_downstream
          - whillans_upstream
          - whillans_downstream
      cycle:
        description: ICESat-2 Cycle number
        type: int
        default: 7
        allowed: [1, 2, 3, 4, 5, 6, 7, 8, 9]
    driver: intake_parquet.source.ParquetSource
    metadata:
      fields:
        x:
          label: Polar Stereographic X (m)
        y:
          label: Polar Stereographic Y (m)
      plot:
        kind: points
        x: x
        y: y
        persist: True
        rasterize: True
        datashade: False
        dynspread: False
        hover: True
        hover_cols:
          - referencegroundtrack
          - dhdt_slope
          - h_corr_{{cycle}}
          - utc_time_{{cycle}}
        colorbar: True
        grid: True
        frame_width: 1000
        frame_height: 600
        data_aspect: 1
      plots:
        dhdt_slope:
          c: dhdt_slope
          cmap: BrBG
        referencegroundtrack:
          c: referencegroundtrack
          cmap: glasbey
        h_corr:
          c: h_corr_{{cycle}}
          cmap: gist_earth
  measures_antarctic_boundaries:
    description: 'MEaSUREs Antarctic Boundaries for IPY 2007-2009 from Satellite Radar, Version 2'
    args:
      storage_options:
        simplecache:
          cache_storage: Quantarctica3/Glaciology/MEaSUREs Antarctic Boundaries/
          same_names: true
      urlpath:
        - simplecache::http://data.pgc.umn.edu/gis/packages/quantarctica/Quantarctica3/Glaciology/MEaSUREs%20Antarctic%20Boundaries/{{boundary_type}}_Antarctica_v2.dbf
        - simplecache::http://data.pgc.umn.edu/gis/packages/quantarctica/Quantarctica3/Glaciology/MEaSUREs%20Antarctic%20Boundaries/{{boundary_type}}_Antarctica_v2.prj
        - simplecache::http://data.pgc.umn.edu/gis/packages/quantarctica/Quantarctica3/Glaciology/MEaSUREs%20Antarctic%20Boundaries/{{boundary_type}}_Antarctica_v2.qix
        - simplecache::http://data.pgc.umn.edu/gis/packages/quantarctica/Quantarctica3/Glaciology/MEaSUREs%20Antarctic%20Boundaries/{{boundary_type}}_Antarctica_v2.shp
        - simplecache::http://data.pgc.umn.edu/gis/packages/quantarctica/Quantarctica3/Glaciology/MEaSUREs%20Antarctic%20Boundaries/{{boundary_type}}_Antarctica_v2.shx
      use_fsspec: true
    parameters:
      boundary_type:
        description: 'Antarctic Boundary type. Either Coastline, GroundingLine or IceBoundaries'
        type: str
        default: IceBoundaries
        allowed: ["Coastline", "GroundingLine", "IceBoundaries"]
    driver: intake_geopandas.geopandas.ShapefileSource
    metadata: {}
  subglacial_lakes:
    description: 'Antarctic subglacial lake polygons detected from ICESat-2/ATLAS laser altimetry'
    args:
      urlpath: antarctic_subglacial_lakes_{{epsg}}.geojson
    parameters:
      epsg:
        description: Coordinate Reference System as an EPSG code
        type: int
        default: 3031
        allowed: [3031, 4326]
    driver: intake_geopandas.geopandas.GeoJSONSource
    metadata:
      lakedict:
        - lakename: Kamb 1
          ids: [69]
        - lakename: Kamb 34
          ids: [67]
        - lakename: Kamb 5
          ids: [75]
        - lakename: Kamb 6
          ids: [71]
        - lakename: Kamb 7
          ids: [67]
        - lakename: Kamb 8
          ids: [72]
        - lakename: Kamb 10
          ids: [74]
        - lakename: MacAyeal 1
          ids: [122]
        - lakename: MacAyeal 4
          ids: [121]
        - lakename: Subglacial Lake Mercer
          ids: [18, 23]
        - lakename: Recovery 2
          ids: [187, 188]
        - lakename: Recovery IV
          ids: [184]
        - lakename: Slessor 23
          ids: [142]
        - lakename: Slessor 45
          ids: [133]
        - lakename: Subglacial Lake Conway
          ids: [48, 49]
        - lakename: Subglacial Lake Whillans
          ids: [54, 55, 57]
          transect: 0989_pt1
        - lakename: Whillans 6
          ids: [46]
        - lakename: Whillans 7
          ids: [45]
          transect: 0531_pt1
        - lakename: Whillans IX
          ids: [56]
          transect: 1080_pt3
        - lakename: Whillans X
          ids: [51]
        - lakename: Whillans XI
          ids: [61, 62]
        - lakename: Subglacial Lake Engelhardt
          ids: [53]
        - lakename: Lake 78
          ids: [23]
        - lakename: Lake 12
          ids: [60]
          transect: 0593_pt1
        - lakename: \* 1
          ids: [50]
        - lakename: \* 2
          ids: [52]
        - lakename: \* 3
          ids: [64]
        - lakename: \* 4
          ids: [81, 82, 83, 91]
        - lakename: \* 5
          ids: [97]
        - lakename: \* 6
          ids: [179]
  test_data:
    description: 'Sample ICESat-2 datasets for testing purposes'
    args:
      path: '{{ CATALOG_DIR }}/tests/test_catalog.yaml'
    driver: intake.catalog.local.YAMLFileCatalog
    metadata: {}