How to install CliMetLab?

pip install climetlab

See the installing instructions for more details.

How to access data?

There are two ways to access data using CliMetLab:

  • Using a Dataset: CliMetLab provides a few demo datasets. In order to access other datasets with cml.load_dataset(), the relevant plugin must be installed.

  • Using a data Source: A data Source allows loading various kinds of data format and location through cml.load_source(). Data sources should be used when there is no dataset plugin for the data you are interested in.

How do I access data from this BUFR/GRIB/… file?

Use the file source.

How do I access data from this file on this unsupported format?

Write your own python code to open the file.


Add plugins and doc for readers.

How to help others to use my data ?

Creating a CliMetLab plugin can be a solution to share some code along with the dataset that you are publishing/using. See the plugin documentation.

How to set up my CliMetLab cache directory ?

See Caching.

How to share my cache directory with another user ?

It is not recommended to share your cache with others. What you are looking for may be a mirror. And this feature is not implemented yet.

A more robust approach is to put the data to a shared location, and define a CliMetLab dataset plugin to use it.

Can CliMetLab help using dask ?