CDS Demo: Using Climate Data Store API

The Copernicus Climate Data Store API is a Python library to download data from the Climate Data Store.

https://pypi.org/project/cdsapi/

You can install it using conda:

conda install -c conda-forge cdsapi

You need to add your api key into ~/.cdsapirc.

Init CDSAPI

import cdsapi

c = cdsapi.Client()

Download CMIP6 data

c.retrieve(
    'projections-cmip6',
    {
        'temporal_resolution': 'monthly',
        'experiment': 'historical',
        'level': 'single_levels',
        'variable': 'near_surface_air_temperature',
        'model': 'mpi_esm1_2_hr',
        'date': '2000-01-01/2000-01-31',
        'area': [
            70, -40, -40,
            70,
        ],
        'format': 'zip',
    },
    'download.zip')

/home/k/k204199/.conda/envs/summerschool_2022/lib/python3.10/site-packages/urllib3/connectionpool.py:1045: InsecureRequestWarning: Unverified HTTPS request is being made to host 'cds.climate.copernicus.eu'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
2022-08-31 09:58:14,962 INFO Welcome to the CDS

2022-08-31 09:58:14,963 INFO Sending request to https://cds.climate.copernicus.eu/api/v2/resources/projections-cmip6

/home/k/k204199/.conda/envs/summerschool_2022/lib/python3.10/site-packages/urllib3/connectionpool.py:1045: InsecureRequestWarning: Unverified HTTPS request is being made to host 'cds.climate.copernicus.eu'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
2022-08-31 09:58:15,064 INFO Request is completed

2022-08-31 09:58:15,064 INFO Downloading https://download-0021.copernicus-climate.eu/cache-compute-0021/cache/data6/adaptor.esgf_wps.retrieve-1661764688.1551287-13046-20-50e09f56-f2e3-4f3f-b7fe-abca68c05989.zip to download.zip (204.5K)

/home/k/k204199/.conda/envs/summerschool_2022/lib/python3.10/site-packages/urllib3/connectionpool.py:1045: InsecureRequestWarning: Unverified HTTPS request is being made to host 'download-0021.copernicus-climate.eu'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(

  0%|                                                                                                                                              | 0.00/204k [00:00<?, ?B/s]

2022-08-31 09:58:15,404 INFO Download rate 602.4K/s

Result(content_length=209385,content_type=application/zip,location=https://download-0021.copernicus-climate.eu/cache-compute-0021/cache/data6/adaptor.esgf_wps.retrieve-1661764688.1551287-13046-20-50e09f56-f2e3-4f3f-b7fe-abca68c05989.zip)

Use command line to extract downloaded data

!unzip -o download.zip 

Archive:  download.zip
 extracting: tas_Amon_MPI-ESM1-2-HR_historical_r1i1p1f1_gn_20000116-20000116_v20190710.nc  
 extracting: adaptor.esgf_wps.retrieve-1661764688.1551287-13046-20-50e09f56-f2e3-4f3f-b7fe-abca68c05989_provenance.json  
 extracting: adaptor.esgf_wps.retrieve-1661764688.1551287-13046-20-50e09f56-f2e3-4f3f-b7fe-abca68c05989_provenance.png  

Use xarray to open CMIP6 data

import xarray as xr

ds = xr.open_dataset("tas_Amon_MPI-ESM1-2-HR_historical_r1i1p1f1_gn_20000116-20000116_v20190710.nc")
ds

<xarray.Dataset>
Dimensions:    (time: 1, bnds: 2, lat: 118, lon: 117)
Coordinates:
  * time       (time) datetime64[ns] 2000-01-16T12:00:00
  * lat        (lat) float64 -39.74 -38.81 -37.87 -36.93 ... 67.79 68.73 69.66
  * lon        (lon) float64 -39.38 -38.44 -37.5 -36.56 ... 67.5 68.44 69.38
    height     float64 2.0
Dimensions without coordinates: bnds
Data variables:
    time_bnds  (time, bnds) datetime64[ns] 2000-01-01 2000-02-01
    lat_bnds   (lat, bnds) float64 -40.21 -39.27 -39.27 ... 69.19 69.19 70.13
    lon_bnds   (lon, bnds) float64 -39.84 -38.91 -38.91 ... 68.91 68.91 69.84
    tas        (time, lat, lon) float32 289.4 289.2 288.9 ... 256.7 256.1 255.4
Attributes: (12/47)
    Conventions:            CF-1.7 CMIP-6.2
    activity_id:            CMIP
    branch_method:          standard
    branch_time_in_child:   0.0
    branch_time_in_parent:  0.0
    contact:                cmip6-mpi-esm@dkrz.de
    ...                     ...
    title:                  MPI-ESM1-2-HR output prepared for CMIP6
    variable_id:            tas
    variant_label:          r1i1p1f1
    license:                CMIP6 model data produced by MPI-M is licensed un...
    cmor_version:           3.5.0
    tracking_id:            hdl:21.14100/af75dd9f-d9c2-4e0e-a294-2bb0d5b740cf

xarray.Dataset

• Dimensions:
  • time: 1
  • bnds: 2
  • lat: 118
  • lon: 117
• Coordinates: (4)
  • time
    (time)
    datetime64[ns]
    2000-01-16T12:00:00

    bounds :

    time_bnds

    axis :

    T

    long_name :

    time

    standard_name :

    time

    array(['2000-01-16T12:00:00.000000000'], dtype='datetime64[ns]')

  • lat
    (lat)
    float64
    -39.74 -38.81 ... 68.73 69.66

    bounds :

    lat_bnds

    units :

    degrees_north

    axis :

    Y

    long_name :

    Latitude

    standard_name :

    latitude

    array([-39.740099, -38.805039, -37.86998 , -36.93492 , -35.99986 , -35.064799,
           -34.129739, -33.194679, -32.259618, -31.324558, -30.389497, -29.454436,
           -28.519375, -27.584315, -26.649254, -25.714193, -24.779132, -23.84407 ,
           -22.909009, -21.973948, -21.038887, -20.103825, -19.168764, -18.233703,
           -17.298641, -16.36358 , -15.428518, -14.493457, -13.558395, -12.623333,
           -11.688272, -10.75321 ,  -9.818148,  -8.883087,  -7.948025,  -7.012963,
            -6.077901,  -5.14284 ,  -4.207778,  -3.272716,  -2.337654,  -1.402593,
            -0.467531,   0.467531,   1.402593,   2.337654,   3.272716,   4.207778,
             5.14284 ,   6.077901,   7.012963,   7.948025,   8.883087,   9.818148,
            10.75321 ,  11.688272,  12.623333,  13.558395,  14.493457,  15.428518,
            16.36358 ,  17.298641,  18.233703,  19.168764,  20.103825,  21.038887,
            21.973948,  22.909009,  23.84407 ,  24.779132,  25.714193,  26.649254,
            27.584315,  28.519375,  29.454436,  30.389497,  31.324558,  32.259618,
            33.194679,  34.129739,  35.064799,  35.99986 ,  36.93492 ,  37.86998 ,
            38.805039,  39.740099,  40.675159,  41.610218,  42.545277,  43.480336,
            44.415395,  45.350454,  46.285512,  47.22057 ,  48.155628,  49.090686,
            50.025743,  50.960801,  51.895857,  52.830914,  53.76597 ,  54.701026,
            55.636081,  56.571136,  57.50619 ,  58.441244,  59.376297,  60.311349,
            61.246401,  62.181452,  63.116502,  64.051551,  64.986599,  65.921645,
            66.856691,  67.791734,  68.726776,  69.661816])

  • lon
    (lon)
    float64
    -39.38 -38.44 -37.5 ... 68.44 69.38

    bounds :

    lon_bnds

    units :

    degrees_east

    axis :

    X

    long_name :

    Longitude

    standard_name :

    longitude

    array([-39.375 , -38.4375, -37.5   , -36.5625, -35.625 , -34.6875, -33.75  ,
           -32.8125, -31.875 , -30.9375, -30.    , -29.0625, -28.125 , -27.1875,
           -26.25  , -25.3125, -24.375 , -23.4375, -22.5   , -21.5625, -20.625 ,
           -19.6875, -18.75  , -17.8125, -16.875 , -15.9375, -15.    , -14.0625,
           -13.125 , -12.1875, -11.25  , -10.3125,  -9.375 ,  -8.4375,  -7.5   ,
            -6.5625,  -5.625 ,  -4.6875,  -3.75  ,  -2.8125,  -1.875 ,  -0.9375,
             0.    ,   0.9375,   1.875 ,   2.8125,   3.75  ,   4.6875,   5.625 ,
             6.5625,   7.5   ,   8.4375,   9.375 ,  10.3125,  11.25  ,  12.1875,
            13.125 ,  14.0625,  15.    ,  15.9375,  16.875 ,  17.8125,  18.75  ,
            19.6875,  20.625 ,  21.5625,  22.5   ,  23.4375,  24.375 ,  25.3125,
            26.25  ,  27.1875,  28.125 ,  29.0625,  30.    ,  30.9375,  31.875 ,
            32.8125,  33.75  ,  34.6875,  35.625 ,  36.5625,  37.5   ,  38.4375,
            39.375 ,  40.3125,  41.25  ,  42.1875,  43.125 ,  44.0625,  45.    ,
            45.9375,  46.875 ,  47.8125,  48.75  ,  49.6875,  50.625 ,  51.5625,
            52.5   ,  53.4375,  54.375 ,  55.3125,  56.25  ,  57.1875,  58.125 ,
            59.0625,  60.    ,  60.9375,  61.875 ,  62.8125,  63.75  ,  64.6875,
            65.625 ,  66.5625,  67.5   ,  68.4375,  69.375 ])

  • height
    ()
    float64
    ...

    units :

    m

    axis :

    Z

    positive :

    up

    long_name :

    height

    standard_name :

    height

    array(2.)

• Data variables: (4)
  • time_bnds
    (time, bnds)
    datetime64[ns]
    ...

    array([['2000-01-01T00:00:00.000000000', '2000-02-01T00:00:00.000000000']],
          dtype='datetime64[ns]')

  • lat_bnds
    (lat, bnds)
    float64
    ...

    array([[-40.207629, -39.272569],
           [-39.272569, -38.337509],
           [-38.337509, -37.40245 ],
           ...,
           [ 67.324213,  68.259255],
           [ 68.259255,  69.194296],
           [ 69.194296,  70.129335]])

  • lon_bnds
    (lon, bnds)
    float64
    ...

    array([[-39.84375, -38.90625],
           [-38.90625, -37.96875],
           [-37.96875, -37.03125],
           ...,
           [ 67.03125,  67.96875],
           [ 67.96875,  68.90625],
           [ 68.90625,  69.84375]])

  • tas
    (time, lat, lon)
    float32
    ...

    standard_name :

    air_temperature

    long_name :

    Near-Surface Air Temperature

    comment :

    near-surface (usually, 2 meter) air temperature

    units :

    K

    cell_methods :

    area: time: mean

    cell_measures :

    area: areacella

    history :

    2019-08-25T11:09:34Z altered by CMOR: Treated scalar dimension: 'height'. 2019-08-25T11:09:34Z altered by CMOR: replaced missing value flag (-9e+33) and corresponding data with standard missing value (1e+20). 2019-08-25T11:09:34Z altered by CMOR: Inverted axis: lat.

    array([[[289.35242, 289.2196 , ..., 285.94812, 285.8114 ],
            [290.03406, 289.89734, ..., 286.66687, 286.5282 ],
            ...,
            [233.9481 , 232.11607, ..., 257.35632, 254.98912],
            [234.47154, 232.26646, ..., 256.0946 , 255.38365]]], dtype=float32)

• Attributes: (47)

  Conventions :

  CF-1.7 CMIP-6.2

  activity_id :

  CMIP

  branch_method :

  standard

  branch_time_in_child :

  0.0

  branch_time_in_parent :

  0.0

  contact :

  cmip6-mpi-esm@dkrz.de

  creation_date :

  2019-08-25T11:09:34Z

  data_specs_version :

  01.00.30

  experiment :

  all-forcing simulation of the recent past

  experiment_id :

  historical

  external_variables :

  areacella

  forcing_index :

  1

  frequency :

  mon

  further_info_url :

  https://furtherinfo.es-doc.org/CMIP6.MPI-M.MPI-ESM1-2-HR.historical.none.r1i1p1f1

  grid :

  gn

  grid_label :

  gn

  history :

  2019-08-25T11:09:34Z ; CMOR rewrote data to be consistent with CMIP6, CF-1.7 CMIP-6.2 and CF standards.

  initialization_index :

  1

  institution :

  Max Planck Institute for Meteorology, Hamburg 20146, Germany

  institution_id :

  MPI-M

  mip_era :

  CMIP6

  nominal_resolution :

  100 km

  parent_activity_id :

  CMIP

  parent_experiment_id :

  piControl

  parent_mip_era :

  CMIP6

  parent_source_id :

  MPI-ESM1-2-HR

  parent_time_units :

  days since 1850-1-1 00:00:00

  parent_variant_label :

  r1i1p1f1

  physics_index :

  1

  product :

  model-output

  project_id :

  CMIP6

  realization_index :

  1

  realm :

  atmos

  references :

  MPI-ESM: Mauritsen, T. et al. (2019), Developments in the MPI‐M Earth System Model version 1.2 (MPI‐ESM1.2) and Its Response to Increasing CO2, J. Adv. Model. Earth Syst.,11, 998-1038, doi:10.1029/2018MS001400, Mueller, W.A. et al. (2018): A high‐resolution version of the Max Planck Institute Earth System Model MPI‐ESM1.2‐HR. J. Adv. Model. EarthSyst.,10,1383–1413, doi:10.1029/2017MS001217

  source :

  MPI-ESM1.2-HR (2017): aerosol: none, prescribed MACv2-SP atmos: ECHAM6.3 (spectral T127; 384 x 192 longitude/latitude; 95 levels; top level 0.01 hPa) atmosChem: none land: JSBACH3.20 landIce: none/prescribed ocean: MPIOM1.63 (tripolar TP04, approximately 0.4deg; 802 x 404 longitude/latitude; 40 levels; top grid cell 0-12 m) ocnBgchem: HAMOCC6 seaIce: unnamed (thermodynamic (Semtner zero-layer) dynamic (Hibler 79) sea ice model)

  source_id :

  MPI-ESM1-2-HR

  source_type :

  AOGCM

  sub_experiment :

  none

  sub_experiment_id :

  none

  table_id :

  Amon

  table_info :

  Creation Date:(09 May 2019) MD5:e6ef8ececc8f338646ebfb3aeed36bfc

  title :

  MPI-ESM1-2-HR output prepared for CMIP6

  variable_id :

  tas

  variant_label :

  r1i1p1f1

  license :

  CMIP6 model data produced by MPI-M is licensed under a Creative Commons Attribution ShareAlike 4.0 International License (https://creativecommons.org/licenses). Consult https://pcmdi.llnl.gov/CMIP6/TermsOfUse for terms of use governing CMIP6 output, including citation requirements and proper acknowledgment. Further information about this data, including some limitations, can be found via the further_info_url (recorded as a global attribute in this file) and. The data producers and data providers make no warranty, either express or implied, including, but not limited to, warranties of merchantability and fitness for a particular purpose. All liabilities arising from the supply of the information (including any liability arising in negligence) are excluded to the fullest extent permitted by law.

  cmor_version :

  3.5.0

  tracking_id :

  hdl:21.14100/af75dd9f-d9c2-4e0e-a294-2bb0d5b740cf

Plot CMIP6 data

ds.tas.isel(time=0).plot()

<matplotlib.collections.QuadMesh at 0x7fff4f6122c0>