Warning
CliMetLab is still a work in progress: Backward compatibility is not ensured
as long a version 1.0 is not released (see todo list).
Nevertheless, the API and functionalities provided for the dataset and source
plugins are mostly stable and already usable.
Sharing code using plugins
In order to avoid rewriting the same code over and over, consider
distributing it, the design of CliMetLab allows this through plugins
developed by data providers and data users and other stakeholders.
CliMetLab has several types of plugins.
Depending on the functionalities provided by your code, it can be integrated
in CliMetLab differently either as a dataset or a source or a reader or a
helper plugin (please refer to the table below.)
If you are distributing or referring to a dataset, the right plugin type
for you is likely to be a dataset plugin.
For more details, here is also a general description of the
CliMetLab plugin mechanism.
Plugin type |
Use case |
End-User API |
|---|
Dataset |
Sharing code to access a curated dataset optionally with additional functionalities. |
climetlab.load_dataset()
|
Source |
Sharing code to access a new type of location where there are data. |
climetlab.load_source()
|
Reader (DRAFT) |
Sharing code to read data on a given format, using specific conventions, or requiring conversions. Readers will be available to the code written for the sources. |
climetlab.load_source()
|
Helper (DRAFT) |
Sharing code related to plotting data, enhancing data with additional functionalities. |
climetlab.plot_map()
|
Machine Learning (TODO) |
Sharing weather and climate specific code related to machine learning. |
climetlab.Dataset , climetlab.Source
|