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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cd9ff3ecc3bd798f1eccf620d66818fd85531bb3ef0a55b4e611a91e3df6eb1 |
|
MD5 | 389c6ae33f7c0c90ef0803abd5fa8329 |
|
BLAKE2b-256 | 03aab569ecf9b41a909f38c3fa9f30175b396d1ce6e61523ff9ff71c43deedc5 |
Hashes for hestia_earth_distribution-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 349f6526242ad8ae2e869e3a141f5c98fd4f6235a3a5a8362bcf4bfe1d84de38 |
|
MD5 | 5874fb9666dabe15075cd8c9cd46321a |
|
BLAKE2b-256 | d1f125abee6686e472d76b3aec5fc7bbe7ed5c38b512f87d74437d358c7370d8 |