3.5_CAMSDataAccess_ECMWFAPI_examples.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example `ECMWF Web API` requests for CAMS data"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "CAMS data can be retrieved via the [ECMWF Public Dataset web interface](https://apps.ecmwf.int/datasets/). You can browse, select and download data there.\n",
    "The web interface give you the option to retrieve the `ECMWF Web API request` for the dataset you have selected.\n",
    "\n",
    "Below, you see examples of `ECMWF WebAPI retrieve requests` for different CAMS data types. You have to change `XXXX` with your `key` and `email` credentials. Find more information [here](./11_ltpy_atmospheric_composition_overview.ipynb#cams_access)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#!/usr/bin/env python\n",
    "from ecmwfapi import ECMWFDataServer\n",
    "server = ECMWFDataServer(url=\"https://api.ecmwf.int/v1\", key=\"XXXXXXXXXXXXXX\", email=\"XXXXXXXXXXXXXX\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### CAMS Global Analyses and Forecasts"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Example `retrieve request` for a parameter of CAMS Global Forecast data:\n",
    "- **Parameter:** `Total Aerosol Optical Depth at 550 nm`\n",
    "- **Time period:** 1 October 2019\n",
    "- **Forecast step:** 24 / 48 hours\n",
    "- **Format:** NetCDF"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "server.retrieve({\n",
    "    \"class\": \"mc\",\n",
    "    \"dataset\": \"cams_nrealtime\",\n",
    "    \"date\": \"2020-11-18\",\n",
    "    \"expver\": \"0001\",\n",
    "    \"levtype\": \"sfc\",\n",
    "    \"param\": \"207.210\",\n",
    "    \"step\": \"24/48\",\n",
    "    \"stream\": \"oper\",\n",
    "    \"time\": \"00:00:00\",\n",
    "    \"type\": \"fc\",\n",
    "    \"format\": \"netcdf\",\n",
    "    \"grid\": \"0.4/0.4\",\n",
    "    \"area\": \"90/-180/-90/180\",\n",
    "    \"target\": \"cams_fc_test.nc\"\n",
    "})"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Example `retrieve request` for a parameter of CAMS Global Forecast (Near-realtime) data:\n",
    "- **Parameter:** `Total Column Carbon Monoxide`\n",
    "- **Time period:** 23 July 2019\n",
    "- **Forecast step:** 24 / 48 / 72 / 96 / 120 hours\n",
    "- **Format:** NetCDF"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "server.retrieve({\n",
    "    \"class\": \"mc\",\n",
    "    \"dataset\": \"cams_nrealtime\",\n",
    "    \"date\": \"2019-07-23/to/2019-07-23\",\n",
    "    \"expver\": \"0001\",\n",
    "    \"levtype\": \"sfc\",\n",
    "    \"param\": \"127.210\",\n",
    "    \"step\": \"0/24/48/72/96/120\",\n",
    "    \"stream\": \"oper\",\n",
    "    \"time\": \"00:00:00\",\n",
    "    \"type\": \"fc\",\n",
    "    \"grid\": \"0.2/0.2\",\n",
    "    \"area\": \"90/-180/-90/180\",\n",
    "    \"format\": \"netcdf\",\n",
    "    \"target\": \"./eodata/cams/nrt/co/2019/07/23/20190723_fc_tc_co.nc\"\n",
    "})"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### CAMS Global Fire Assimilation System (GFAS)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Example `retrieve request` for a GFAS data parameter:\n",
    "- **Parameter:** `Wildfire radiative power`\n",
    "- **Time period:** 22 to 24 October 2019\n",
    "- **Format:** NetCDF"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#!/usr/bin/env python\n",
    "server.retrieve({\n",
    "    \"class\": \"mc\",\n",
    "    \"dataset\": \"cams_gfas\",\n",
    "    \"date\": \"2019-07-23/to/2019-07-29\",\n",
    "    \"expver\": \"0001\",\n",
    "    \"levtype\": \"sfc\",\n",
    "    \"param\": \"99.210\",\n",
    "    \"step\": \"0-24\",\n",
    "    \"stream\": \"gfas\",\n",
    "    \"time\": \"00:00:00\",\n",
    "    \"type\": \"ga\",\n",
    "    \"grid\": \"0.1/0.1\",\n",
    "    \"area\": \"90/-180/-90/180\",\n",
    "    \"format\": \"netcdf\",\n",
    "    \"target\": \"./eodata/cams/gfas/2019/07/23/20190723_wildfire_radiative_power.nc\"\n",
    "})"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### CAMS Greenhouse Gases Flux Inversions"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Example `retrieve request` for a parameter of CAMS Greenhouse Gases Flux Inversions:\n",
    "- **Parameter:** `Carbondioxide`\n",
    "- **Time period:** 1 Jan 1979 to 31 Dec 2018\n",
    "- **Temporal resolution**: monthly\n",
    "- **Format:** NetCDF"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "server.retrieve({\n",
    "    \"dataset\": \"cams_ghg_inversions\",\n",
    "    \"datatype\": \"ra\",\n",
    "    \"date\": \"1979-01-01/to/2018-12-31\",\n",
    "    \"frequency\": \"mm\",\n",
    "    \"param\": \"co2\",\n",
    "    \"quantity\": \"surface_flux\",\n",
    "    \"version\": \"v18r2\",\n",
    "    \"format\": \"netcdf\",\n",
    "    \"grid\": \"0.4/0.4\",\n",
    "    \"area\": \"90/-180/-90/180\",\n",
    "    \"target\": \"cams_ghg_flux_test.nc\",\n",
    "})"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<p><img src='./img/copernicius_logo.png' align='left' alt='Logo EU Copernicus' width='25%'></img></p>\n",
    "<br clear=left>\n",
    "<p style=\"text-align:left;\">This project is licensed under the <a href=\"./LICENSE\">MIT License</a> <span style=\"float:right;\"><a href=\"https://gitlab.eumetsat.int/eumetlab/atmosphere/atmosphere\">View on GitLab</a> | <a href=\"https://training.eumetsat.int/\">EUMETSAT Training</a>"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.8.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}