Climate Data Store Toolbox for MATLAB

MATLAB® Tools to access The Climate Data Store. It is a wealth of information about the Earth's past, present and future climate. There are hundreds of data sets associated with climate change. This toolbox allows you to easily access data and download it for analysis in MATLAB.

Please report bugs and suggest enhancements by creating a new issue on GitHub.

More info on installing and using the toolbox below.

Collaborating on the Climate Data Store Toolbox

We're always excited to have people make improvements large and small to Climate Data Store Toolbox. Contributions do not have to be code! If you see a way to explain things more clearly or a great example of how to use something, please contribute it (or a link to your content). Please create issues even if you don't code the solution. We also welcome pull requests to resolve issues that we haven't gotten to yet! See CONTRIBUTING.MD for more information.

How to get started improving the toolbox:

1. Clone the repository: using MATLAB:
   1. In MATLAB, switch to the directory where you want the project created.
   2. Right click in the current folder browser, and choose Source Control/Manage Files...
   3. Set the repository path to https://github.com/mathworks/climatedatastore.git, and set Sandbox to the directory you want created.
   4. Click (Retrieve). Files will be cloned locally.
2. Open the climatedatastore.prj -- You're ready to make edits!
3. When you're done, run the test suite.
4. Create a pull request.

Looking for ideas? Fix a "good first" issue!

MATLAB Features Used

This demonstrates a number of MATLAB features, including:

• Calling Python From MATLAB
• Toolbox Packaging
• MATLAB Projects
• Argument validation
• Code Issue detection using Code Analyzer and Code Issues
• Unit Tests
  • Code Coverage using Cobertura report format and CodeCov
  • Mocking Framework
  • Parameters in Unit Tests
• MATLAB Classes
  • Static Methods
  • Property Access Methods
• buildtool to run automated checks and tests
• GitHub Actions
  • Action to setup MATLAB Configure a MATLAB session
  • Multi-release testing: Run tests across a number of MATLAB releases (see yaml)
  • Action to run MATLAB Build Run automated checks and tests when new code is pushed to repo (see yaml)
  • Action to run MATLAB Code Run automated tests and release a new version when a new tag is created. (see yaml)

Using the Climate Data Store Toolbox

This is just a quick overview -- install and look at GettingStarted.mlx for more information on using the Toolbox.

Functions

Usage

1. See the notes below for information on first time install
2. type help climateDataStoreDownload or help climateDataStoreDownloadAsync for help on using the functions
3. Find your dataset at Climate Data Store and click on the "download data" tab. Make your selections for the subset of data you want. Click "show API request" at the bottom.
4. Use climateDataStoreDownload to get the data. The first parameter is the name of the data set to retrieve. The second parameter is a MATLAB version of the python structure that selects what subset of the data to download. climateDataStoreDownload downloads the files, and returns a list of files that were downloaded.

Note that downloading the files can take some time, depending on how large they are. If you have really large files, climateDataStoreDownloadAsync can be helpful. You can check on the status of your request by visiting the CDS request status page.

Typically, files returned are:

First time Install

• Requires MATLAB release R2020a or later
• Install the toolbox by using the Add-on explorer in MATLAB, or by downloading the climatedatastore.mltbx file attached to the latest release on GitHub, then doubleclicking on it.
• This relies on the CDS Python API created by the European Centre for Medium-Range Weather Forecasts (ECMWF). You'll need to have python installed. Get it from the Python Download page. See this MATLAB documentation for more information.
• The toolbox will automatically configure python and download and install the CSAPI package (you can manually install using pip3 install cdsapi)
• The toolbox will prompt you the first time for CSAPI credentials. Visit How to use the CDS API for more info.

Example: Getting Started with Copernicus Climate Data Store Toolbox

The sea ice thickness dataset provides monthly gridded data of sea ice thickness for the Arctic region based on satellite radar altimetry observations. Sea ice is an important component of our climate system and a sensitive indicator of climate change. Its presence or its retreat has a strong impact on air-sea interactions, the Earth’s energy budget as well as marine ecosystems. It is recognized by the Global Climate Observing System as an Essential Climate Variable. Sea ice thickness is one of the parameters commonly used to characterize sea ice, alongside sea ice concentration, sea ice edge, and sea ice type, also available in the Climate Data Store.

Select the sea ice thickness dataset.

datasetName ="satellite-sea-ice-thickness";

Select the data to download from the dataset (see this webpage for options). This is a "MATLABized" version of the python structure that is generated in the API request.

datasetOptions.version = "1_0";
datasetOptions.variable = "all";
datasetOptions.satellite = "cryosat_2";
datasetOptions.cdr_type = ["cdr","icdr"]; 
datasetOptions.year = ["2011","2021"]; 
datasetOptions.month = "03";

Download the data from Climate Data Store using climateDataStoreDownload. It is put in a directory called "satellite-sea-ice-thickness."

downloadedFilePaths = climateDataStoreDownload(datasetName,datasetOptions);

2021-11-10 10:38:13,694 INFO Welcome to the CDS
2021-11-10 10:38:13,697 INFO Sending request to https://cds.climate.copernicus.eu/api/v2/resources/satellite-sea-ice-thickness
2021-11-10 10:38:13,830 INFO Request is completed
2021-11-10 10:38:13,832 INFO Downloading https://download-0003.copernicus-climate.eu/cache-compute-0003/cache/data7/dataset-satellite-sea-ice-thickness-639d640c-3099-42c0-8878-6c335586d2c7.zip to C:\Users\rpurser\AppData\Local\Temp\tp3e8d85e3_9026_4531_ad2b_f3199a006857.zip (4.4M)
2021-11-10 10:38:15,378 INFO Download rate 2.8M/s

Read and format ice thickness data from 2011 and 2021.

Transform and load the latitude, longitude, and ice thickness.

ice2011 = readSatelliteSeaIceThickness(downloadedFilePaths(1));
ice2021 = readSatelliteSeaIceThickness(downloadedFilePaths(2));
head(ice2021)

Citation: Generated using Copernicus Climate Change Service information 2022

Visually compare March ice thickness in 2011 and 2021

subplot(1,2,1)
geodensityplot(ice2011.lat,ice2011.lon,ice2011.thickness,"FaceColor","interp")
geolimits([23 85],[-181.4 16.4])
geobasemap("grayterrain")
title("Ice Thickness, March 2011")

subplot(1,2,2)
geodensityplot(ice2021.lat,ice2021.lon,ice2021.thickness,"FaceColor","interp")
geolimits([23 85],[-181.4 16.4])
geobasemap("grayterrain")
title("Ice Thickness, March 2021")
f = gcf;
f.Position(3) = f.Position(3)*2;

Citation: Generated using Copernicus Climate Change Service information 2022

License

The license is available in the License file within this repository

Note: each data set in the Copernicus Climate Data Store has its own license terms. You should review the license terms for the data set that you are planning to use to ensure that it can be used in the way that you have planned.

© 2021-2022, The MathWorks, Inc.