Skip to main content

Installation

Install via pip with:

$ pip install apccapi

Configure (Linux)

Obtain your API key from the CLIK (Climate Information toolKit) at https://apcc21.org/clik/ and enter it into the apccapi.properties file, formatting it as follows:

$ vi ~/apccapi.properties

key={your API key}
request_url=https://apcc21.org/clikapi/request/apccdata
status_url=https://apcc21.org/clikapi/request/status

Configure (Windows)

Obtain your API key from the CLIK (Climate Information toolKit) at https://apcc21.org/clik/, and create the apccapi.properties file in your Windows Home directory (typically C:\Users\YourUserName) with the following format:

key={your API key}
request_url=https://apcc21.org/clikapi/request/apccdata
status_url=https://apcc21.org/clikapi/request/status

Usage

Quick start: dataset download helpers

Each helper submits the request, polls until it's done, downloads the result, and returns the output file path (or raises on failure - see Error handling).

import apccapi

apccapi.download_MME_3MONTH(
	{
		'type': 'FORECAST',
		'method': 'SCM',
		'variable': ['prec', 't2m'],
		'period': ['Monthly mean'],
		'yearmonth': ['201909']
	},
	'mme3.zip'
)

apccapi.download_MME_6MONTH(
	{
		'type': 'FORECAST',
		'method': 'SCM',
		'variable': ['prec', 't2m'],
		'period': ['Monthly mean'],
		'yearmonth': ['201909']
	},
	'mme6.zip'
)

apccapi.download_MME_MODEL(
	{
		'type': 'FORECAST',
		'institute': 'APCC',
		'model': 'SCOPS',
		'variable': ['prec', 't2m'],
		'yearmonth': ['201909']
	},
	'model.zip'
)

apccapi.download_CMIP5(
	{
		'code': 'AD'
	},
	'cmip5.zip'
)

apccapi.download_ERA5(
	{
		'timestep': 'DAILY',      # 'DAILY' | 'MONTHLY' | 'HOURLY'
		'level': 'single',        # 'pressure' | 'single'
		'variable': 't2m',
		'year': '2020',
		'month': '12'             # omit for 'MONTHLY'
	},
	't2m_202012.nc'
)

apccapi.download_NCEP1(
	{
		'timestep': 'DAILY',      # 'DAILY' | 'MONTHLY'
		'level': 'pressure',
		'variable': 'air',
		'year': '2022'            # only required for 'DAILY'
	},
	'air.2022.nc'
)

apccapi.download_NCEP2(
	{
		'timestep': 'DAILY',
		'level': 'pressure',
		'variable': 'air',
		'year': '2022'
	},
	'air.2022.nc'
)

More runnable examples (one file per dataset) are in example/.

Low-level usage: Client.retrieve

The helpers above are thin wrappers around Client.retrieve(). Call it directly when you need a jobtype/dataset combination that doesn't have a dedicated helper yet, or the clipping jobtypes (Clipping_MME, Clipping_Model):

import apccapi

c = apccapi.Client()
c.retrieve(
	{
		'jobtype': 'MME',
		'dataset': 'MME_3MONTH',
		'type': 'FORECAST',
		'method': 'SCM',
		'variable': ['prec', 't2m'],
		'period': ['Monthly mean'],
		'yearmonth': ['201909']
	},
	'mme3.zip'
)

Clipping

ClippingClient calls a separate clipping/masking service and returns a cropped PNG or NetCDF file for a bounding box:

import apccapi

c = apccapi.ClippingClient()
c.clip(
	{
		'lead_month': '3-MON',      # '3-MON' | '6-MON'
		'variable': 'prec',         # prec, slp, sst, t2m, t850, z500
		'method': 'SCM',            # SCM, GAUS
		'period': 'Monthly mean',   # Monthly mean, Seasonal mean
		'iyear': '2021',            # issued year
		'imonth': '2',              # issued month
		'cowest': '188',
		'coeast': '191',
		'conorth': '-11',
		'cosouth': '-15',
		'return_type': 'png'        # 'png' | 'nc'
	}
)

Error handling

Every failure (rejected request, job that ends in Failed, exhausted retries, a broken download) raises apccapi.ClikApiError with the server's own message, instead of failing silently:

import apccapi

try:
	apccapi.download_ERA5(
		{'timestep': 'MONTHLY', 'level': 'single', 'variable': 't2m', 'year': '2020'},
		't2m_2020.nc'
	)
except apccapi.ClikApiError as e:
	print('Request failed:', e)

License

MIT License

Copyright (c) 2019 - 2024, APEC Climate Center

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for apccapi 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apccapi 0.1.1
File Size Uploaded Provenance Actions
apccapi-0.1.1.tar.gz 7.9 kB Without provenance Details for apccapi-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apccapi 0.1.1
File Interpreter ABI Platform Actions
apccapi-0.1.1-py3-none-any.whl Python 3 none any Details for apccapi-0.1.1-py3-none-any.whl

Total release size: 16.2 kB

Release files / apccapi-0.1.1.tar.gz

Download URL apccapi-0.1.1.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
02bb7b2055ed767857bbbc94a5ccfcff9937ee7c1d518a4744087c6ff0d20f68
BLAKE2b-256 checksum
How to use checksums
6fcad8031341e126ab19907b7bfc10e56bf010b0f63fbd38b7aa61ce1a9b6863
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Release files / apccapi-0.1.1-py3-none-any.whl

Download URL apccapi-0.1.1-py3-none-any.whl
Size 8.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
77a325ca8dc4c9ff0e7634965181b371fa8e25878c4467eeb4d8e477f63f5fb3
BLAKE2b-256 checksum
How to use checksums
3459a7fb83f7dc9dd38952099f65e8f13e6c82df02887fe9068d504cec99c93f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Security for apccapi 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page