Howtos

How to install CliMetLab?

pip install climetlab

See the installing instructions for more details.

How to access data?

CliMetLab only provides a few demo datasets. In order to access a dataset with cml.load_dataset(), the relevant plugin must be installed (details).

If there is no plugin for the data you are interested in, use cml.load_source() (details).

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 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. This feature is not implemented yet.

Todo

Add more standard recipes.