wcpms 0.1.0

Python Client of the Web Crop Phenological Metrics Service for Earth Observation Data Cubes

About

The Web Crop Phenology Metrics Service (WCPMS) is an web service for calculating phenological metrics based on Phenolopy library and EO Data from the Brazil Data Cube (BDC). It will allow analysts to calculate phenological metrics from data cubes without downloading big EO datasets to their personal computers.

The software run on the server side, so it doesn’t require package installation. Through a simple API, analysts indicate a spatial location or region and the WCPMS will retrieve the phenological metrics associated with spatial locations by calculating it using time series.

The WCPMS is a web service, and it can be accessed through its API. To facilitate these operations, we have developed an official client—a simple Python library. The WCPMS Client is composed of a group of functions, the main ones are:

• get_collections: returns in list format the unique identifier of each of the data cubes available in the BDC’s SpatioTemporal Asset Catalogs (STAC).

• get_description: returns in dictionary format the information on each of the phenology metrics, such as code, name, description and method.

• get_phenometrics: returns in dictionary form all the phenological metrics calculated for the given spatial location.

• get_phenometrics_region: returns in list form dictionary with the phenological metrics calculated for each of the given spatial location based on selected region methodology (all, systematic grid or random grid).

Installation

See INSTALL.rst.

Using WCPMS in the Command Line

See CLI.rst.

Documentation

See https://wcpms.readthedocs.io/en/latest.

References

WIP

License

Copyright (C) 2024 INPE.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.