apccapi 0.0.1__tar.gz → 0.1.1__tar.gz

apccapi-0.1.1/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: apccapi
+Version: 0.1.1
+Summary: APCC Climate Information toolKit API package
+Home-page: https://www.apcc21.org
+Author: APEC Climate Center
+Author-email: joohyung@apcc21.org
+Project-URL: CLIK, https://apcc21.org/clik/
+Keywords: APCC,apcc,Climate,Climate Information,Climate API
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: urllib3<2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+## Installation
+
+Install via pip with:
+
+```bash
+$ 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](#error-handling)).
+
+```python
+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/`](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`):
+
+```python
+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:
+
+```python
+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:
+
+```python
+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.

apccapi-0.1.1/README.md

@@ -0,0 +1,197 @@
+## Installation
+
+Install via pip with:
+
+```bash
+$ 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](#error-handling)).
+
+```python
+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/`](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`):
+
+```python
+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:
+
+```python
+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:
+
+```python
+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.

apccapi-0.1.1/apccapi/__init__.py

@@ -0,0 +1,16 @@
+from .client import (
+	Client,
+	ClikApiError,
+	download_MME_3MONTH,
+	download_MME_6MONTH,
+	download_MME_MODEL,
+	download_CMIP5,
+	download_ERA5,
+	download_NCEP1,
+	download_NCEP2,
+)
+from .clipping import ClippingClient
+from . import clipping
+
+__version__ = '0.1.1'
+__author__ = 'APEC Climate Center'