Skip to main content

Access data for anticipating humanitarian risk

Project description

OCHA AnticiPy: Access data for anticipating humanitarian risk

license Test Status PyPI Status Documentation Status Coverage Status pre-commit Code style: black Imports: isort

OCHA AnticiPy is a Python library for simple downloading and processing of data related to the anticipation of humanitarian risk, from climate observations and forecasts to food insecurity.

The datasets that we currently support are:

  • CHIRPS rainfall
  • COD ABs (Common Operational Datasets administrative boundaries)
  • FEWS NET food insecurity
  • GloFAS river discharge
  • IRI seasonal rainfall forecast
  • USGS NDVI (normalized difference vegetation index)

For more information, please see the documentation.

Installing

Install and update using pip:

pip install ocha-anticipy

Some modules of the toolbox have specific dependencies not installed by default. These are documented within each module, but all dependencies can be installed using.

pip install -U ocha-anticipy[full]

A Simple Example

OCHA AnticiPy downloads data to the directory referenced by the environment variable OAP_DATA_DIR. Before beginning, please make sure that this environment variable is defined and points to where you would like the data to go.

Next, you can simply download the admin boundary CODs for Nepal, and retrieve provinces as a GeoDataFrame:

from ochanticipy import create_country_config, CodAB

country_config = create_country_config('npl')
codab = CodAB(country_config=country_config)
codab.download()
provinces = codab.load(admin_level=1)

Contributing

For guidance on setting up a development environment, see the contributing guidelines

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ocha-anticipy-1.1.1.tar.gz (114.4 kB view details)

Uploaded Source

Built Distribution

ocha_anticipy-1.1.1-py3-none-any.whl (86.4 kB view details)

Uploaded Python 3

File details

Details for the file ocha-anticipy-1.1.1.tar.gz.

File metadata

  • Download URL: ocha-anticipy-1.1.1.tar.gz
  • Upload date:
  • Size: 114.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for ocha-anticipy-1.1.1.tar.gz
Algorithm Hash digest
SHA256 eb15fa4ef6e740ae3c14ec855053bfc945649305aabd437fb6122791581a63db
MD5 db41b99090029bfb600d343bb1ba97e6
BLAKE2b-256 4e90a2f55801aa30323543f0887e1de28428fc14254741d12c5876500248758d

See more details on using hashes here.

File details

Details for the file ocha_anticipy-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ocha_anticipy-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b33342dba0e515765e4acf45a5df1264905ec5cae506bcfdc740f9a6bdfe509b
MD5 2fb739343cc20af5b02e808020ec0eed
BLAKE2b-256 9ca6f7357dee2acde5078e0d45236d07061e8a8b5362b139a76c4d43ba24773e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page