ochanticipy.config package

Submodules

ochanticipy.config.countryconfig module

Country configuration setting base class.

class ochanticipy.config.countryconfig.CodABConfig(*, admin_level_max: int, hdx_resource_name: str | List[str], layer_base_name: str, admin0_name: str | None = None, admin1_name: str | None = None, admin2_name: str | None = None, admin3_name: str | None = None, admin4_name: str | None = None, custom_layer_names: List[str] | None = None)

Bases: BaseModel

COD AB configuration.

Parameters:

• admin_level_max (int) – The maximum admin level available in the shapefile, cannot be greater than 4. If hdx_resource_name is a list, then admin_level_max must match the number of items in hdx_resource_name.

• hdx_resource_name (Union[str, List[str]]) – COD AB resource name on HDX. Can be found by taking the filename as it appears on the COD AB dataset page. If individual COD AB files are contained in separate resources, provide each filename in a list, where the index is equivalent to admin level.

• layer_base_name (str) – The base name of the different admin layers, that presumably only change by a single custom_layer_number depending on the level. Should contain {admin_level} in place of the custom_layer_number.

• admin{level}_name (str, optional) – The names of any admin level layers that do not conform to the layer_base_name pattern, where {level} ranges from 0 to 4

• custom_layer_names (list, optional) – Any additional layer names that don’t fit into the admin level paradigm

admin0_name: str | None

admin1_name: str | None

admin2_name: str | None

admin3_name: str | None

admin4_name: str | None

admin_level_max: int

custom_layer_names: List[str] | None

hdx_resource_name: str | List[str]

layer_base_name: str

class ochanticipy.config.countryconfig.CountryConfig(*, iso3: str, codab: CodABConfig | None = None, fewsnet: FewsNetConfig | None = None, glofas: GlofasConfig | None = None, usgs_ndvi: UsgsNdviConfig | None = None)

Bases: BaseModel

Country configuration.

Parameters:

• iso3 (str) – Country ISO3, must be exactly 3 letters long

• codab (CodABConfig, optional) – Configuration object for COD AB

• fewsnet (FewsNetConfig, optional) – Configuration object for FEWS NET

• glofas (GlofasConfig, optional) – Configuration object for GloFAS

• usgs_ndvi (UsgsNdviConfig, optional) – Configuration object for USGS NDVI

codab: CodABConfig | None

fewsnet: FewsNetConfig | None

glofas: GlofasConfig | None

iso3: str

usgs_ndvi: UsgsNdviConfig | None

class ochanticipy.config.countryconfig.FewsNetConfig(*, region_name_code_mapping: Dict[str, str] = {'caribbean-central-america': 'LAC', 'central-asia': 'CA', 'east-africa': 'EA', 'southern-africa': 'SA', 'west-africa': 'WA'}, region_name: str)

Bases: BaseModel

FEWS NET configuration.

Parameters:

region_name (str) – Name of the region the country belongs to. Needed to download the regional FEWS NET data

region_name: str

region_name_code_mapping: Dict[str, str]

classmethod regionname_valid(v, values)

Check that regionname is one of the valid ones.

class ochanticipy.config.countryconfig.GlofasConfig(*, reporting_points: List[ReportingPoints])

Bases: BaseModel

GloFAS configuration.

reporting_points: List[ReportingPoints]

class ochanticipy.config.countryconfig.ReportingPoints(*, name: str, lon: float, lat: float)

Bases: BaseModel

Coordinates of GloFAS reporting points.

lat: float

lon: float

name: str

class ochanticipy.config.countryconfig.UsgsNdviConfig(*, area_name_mapping: Dict[str, Tuple[str, str]] = {'central-america': ('lac/camcar/centralamerica', 'ca'), 'central-asia': ('asia/centralasia', 'cta'), 'east-africa': ('africa/east', 'ea'), 'hispaniola': ('lac/camcar/caribbean/hispaniola', 'hi'), 'north-africa': ('africa/north', 'na'), 'southern-africa': ('africa/southern', 'sa'), 'west-africa': ('africa/west', 'wa'), 'yemen': ('asia/middleeast/yemen', 'yem')}, area_name: str)

Bases: BaseModel

USGS NDVI configuration.

Parameters:

area_name (str) – Name of the USGS NDVI coverage area the country belongs to. Needed to download the regional NDVI data.

area_name: str

area_name_mapping: Dict[str, Tuple[str, str]]

classmethod area_name_valid(v, values) → str

Check that area_name is valid.

ochanticipy.config.countryconfig.create_country_config(iso3: str) → CountryConfig

Return a country configuration object from AA Toolbox.

Parameters:

iso3 (str) – Country ISO3, must be exactly 3 letters long

Return type:

CountryConfig instance

ochanticipy.config.countryconfig.create_custom_country_config(filepath: str | Path) → CountryConfig

Return a custom country configuration object.

Parameters:

filepath (str, pathlib.Path) – Path to the configuration file

Return type:

CountryConfig instance

ochanticipy.config.pathconfig module

Path configuration.

class ochanticipy.config.pathconfig.PathConfig(base_dir_env: str = 'OAP_DATA_DIR', public: str = 'public', private: str = 'private', raw: str = 'raw', processed: str = 'processed')

Bases: object

Global directory parameters.

base_dir_env: str = 'OAP_DATA_DIR'

private: str = 'private'

processed: str = 'processed'

public: str = 'public'

raw: str = 'raw'

Module contents

Run-time configuration parameters.