CMIP7-data-request-api 1.2b2

A programmatic interface to the CMIP7 Data Request

CMIP7 Data Request Software

Python software to interact with the CMIP7 data request. It provides an API to query and utilize the information in the data request, including example scripts and notebooks showing how to use the API.

For the Quick Start guide, please see below.

The Data Request Task Team encourages user feedback to help us improve the software. Here are some ways to provide feedback:

• For specific questions or issues (such as bugs) please open a github issue.
• For more general questions or concerns, such as suggestions for new features, contribute to the Software's github discussion forum.

v1.2 Data Request release

The latest official release of the CMIP7 Data Request is v1.2 (31 March 2025) Access all information about the v1.2 release on the CMIP website.

Please note that a technical update to the Data Request, v1.2.1, is planned for late April 2025. This update will affect some details such as the names of CMOR variables, without substantially changing the scientific content of the request. For further information please see the v1.2 release page. An update of this software will follow the release of v1.2.1.

Installation

Quick Start

In a python virtual environment that already has the dependencies installed, do:

pip install CMIP7-data-request-api

If an environment first needs to be created, you can do:

python -m venv my_dreq_env
source my_dreq_env/bin/activate
pip install --upgrade pip
wget https://raw.githubusercontent.com/CMIP-Data-Request/CMIP7_DReq_Software/refs/heads/main/requirements.txt
pip install -r requirements.txt 
pip install CMIP7-data-request-api

using the requirements.txt file from the top-level directory of this repository, which lists the package dependencies, and my_dreq_env can be changed to whatever environment name is preferred. If a conda environment is preferred instead of venv, an env.yml file with the dependencies is also provided and a conda environment can be created by doing:

wget https://raw.githubusercontent.com/CMIP-Data-Request/CMIP7_DReq_Software/refs/heads/main/env.yml
conda env create -n my_dreq_env --file env.yml

If installation is successful you should be able to run the command

export_dreq_lists_json --all_opportunities v1.1 amip.json --experiments amip

The package can be uninstalled using

python -m pip uninstall CMIP7_data_request_api

Configuration

The package comes with a default configuration. After installation, you can initialize the configuration file with the default settings by running:

CMIP7_data_request_api_config init

This will create the .CMIP7_data_request_api_config file in your home directory. Optionally, the default location of this file can be changed by setting the CMIP7_DR_API_CONFIGFILE environment variable. Alternatively, the file will be automatically created the first time you use the software.

The configuration file is a YAML file containing key: value pairs that control the behavior of the software. You can modify the values by either editing the file directly or using the following command:

CMIP7_data_request_api_config <key> <value>

To reset the configuration to its default values, run:

CMIP7_data_request_api_config reset

For example, to set the software to run offline, use:

CMIP7_data_request_api_config offline true

This will prevent checks for updates and retrievals of new versions of the data request content.

Development

To install for development:

git clone [e-mail]:CMIP-Data-Request/CMIP7_DReq_Software.git
cd CMIP7_DReq_Software

If needed create an environment with the required dependencies (as in Quick Start, above). Then, in the top-level directory of the repository, run:

python -m pip install -e .

Documentation

Technical Documentation

https://cmip-data-request.github.io/CMIP7_DReq_Software/data_request_api/

Contributors

Thanks to our contributors!