Hestia's Distribution library
Project description
Hestia Data Utils
Utils library to manipulate distributions on the Hestia platform
Install
pip install hestia_earth.distribution
- Optional: to generate distribution files, please install pymc 4.
Usage
By default, all output files will be stored under ./data folder.
You can set the env variable DISTRIBUTION_DATA_FOLDER
to store in a different folder.
To get posterior distribution:
from hestia_earth.distribution.posterior_yield import get_post_ensemble, get_post
# get a single posterior distribution, run:
mu_ensemble, sd_ensemble = get_post_ensemble('GADM-GBR', 'wheatGrain')
# Or, if only instrested in the mean of the mu and sd values, run:
mu, sd = get_post('GADM-GBR', 'wheatGrain')
Advance Usage
You can clone this repository to use the commands below.
Generate prior distribution
To generate yield prior file for all products:
python generate_prior_yield.py --overwrite
For more information, run python generate_prior_yield.py --help
.
Generate likelihood data
In order to generate likelihood data (a spreadsheet of crop yield and fertiliser data) for a specific product and a specific country, run:
python generate_likelihood.py --product-id="wheatGrain" --country-id="GADM-GBR" --limit=1000
For more information, run python generate_likelihood.py --help
.
Generate posterior distribution
- In order to generate posterior distribution (for Bayesian statistics) for a specific product and a specific country, run:
python generate_posterior_yield.py --product-id="wheatGrain" --country-id="GADM-GBR"
- In order to generate posterior distribution for a specific product (for all countries), run:
python generate_posterior_yield.py --product-id="wheatGrain"
- In order to generate posterior distribution for a specific country (for all products), run:
python generate_posterior_yield.py --country-id="GADM-GBR"
- In order to generate posterior distribution for all products and all countries, run:
python generate_posterior_yield.py
Plotting
Prior Yield
To plot prior distribution by product by country:
python plot_prior_yield.py --country-id='GADM-GBR' --product-id='wheatGrain' --output-file='prior.png'
To plot FAO annual yield data, change --type
parameter to one of the four options: fao_per_country
, fao_per_product
, fao_per_country_per_product
, world_mu_signma
. Example:
python plot_prior_yield.py --country-id='GADM-GBR' --output-file='fao-yield-gbr-allProducts.png' --type='fao_per_country'
For more information, run python plot_prior_yield.py --help
.
Cycle Yield
To plot the bivariate distribution of yield data for Wheat, grain in United Kingdom:
python plot_cycle_yield.py --product-id=wheatGrain" --country-id="GADM-GBR" --limit=100
This will take a sample size of 100
and create a result.png
file with the distribution.
For more information, run python plot_cycle_yield.py --help
.
Posterior Yield
In order to plot the posterior distribution for a specific product and a specific country, run:
python plot_posterior_yield.py --country-id="GADM-GBR" --product-id="wheatGrain" --output-file="post.png"
For more information, run python plot_posterior_yield.py --help
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hestia-earth-distribution-0.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d51d3af991ff47e5f1acc0eee2c867592303dc27fbc36156033ba4df2c85f6d |
|
MD5 | 315c0647c7fe26938cc599befa9a467e |
|
BLAKE2b-256 | 8af70f10e6ec3cb925176c82376f5d1e36f6da2f3ea0d3c38b0148bb0bddbb67 |
Hashes for hestia_earth_distribution-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4c06065b7ba5bfc9c59e03a629d81a6a2fd062e104c0efe1f5bb24562fec2c6 |
|
MD5 | 0a88e5f26abf1e1bb66a356d941ee571 |
|
BLAKE2b-256 | 43302a703dd95f18dcb229c16aee445e5260dd766645a70cb073bb96fb13fa90 |