Skip to main content

Python xweights contains functionsto create grid weighted area means

Project description

xweights Documentation Status status

Python “xweights” contains functions to calculate grid weighted area means from predefined regions or from an user-given shapefile. This tool is a wrapper around the python package xESMF.


  • Calculate grid-weighted-means and save the output as CSV file

  • As input you need a dataset dictionary. Values are xarray.Datasets and keys correspondin strings.


Note: Before building xweights from source, you nedd first install cartopy by using conda:

conda install -c conda-forge cartopy

You can install the package directly with pip:

pip install xweights

If you want to contribute, I recommend cloning the repository and installing the package in development mode, e.g.

git clone
cd xweights
pip install -e .

In additon you have to install xESMF using _Conda:

conda install -c conda-forge xesmf

This will install the package but you can still edit it and you don’t need the package in your PYTHONPATH


  • python3.6 or higher

  • numpy

  • pandas

  • geopandas

  • xarray

  • py-cordex

  • xesmf


In cases of any problems, needs or wishes do not hesitate to contact:


This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.


0.1.0 (2022-03-04)

  • First release on PyPI.

0.1.1 (2022-07-01)

  • adjusted to pre-commit

  • use functions from pyhomogenize

0.1.2 (2022-07-08)

  • change pyhomogenize version requirements

0.2.0 (2022-07-11)

  • rename spatial_averager

  • keep geometry attributes

0.2.1 (2022-07-11)

  • read and write column name to attributes

0.2.2 (2022-07-12)

  • add data and tables via pip install

0.2.3 (2023-01-26)

  • remove cartopy from requirements.txt

0.2.4 (2023-03-13)

  • using pycordex >= 0.5.1

0.2.5 (2023-08-23)

  • adding new region: counties_merged (merge counties less than 400m2)

0.2.6 (2023-08-30)

  • optionally: wite variable attributes to dataframe

0.3.0 (2023-09-15)

  • added new regions: IPCC WG1 Reference Regions v4 from Atlas

  • xweights/ is no longer available

  • xweights/ is no longer available

  • function spatial_averager -> spatial_averaging

  • function compute_weighted_means:

    • optionally: set averager_ds to calculate a general xesmf.SpatialAverager

    • parameter shp -> gdf

    • parameter input -> dataset_dict

    • parameter dataset_dict has to be a dictionary

    • parameter outdir -> output

  • function compute_weighted_means_ds: parameters are now similar to compute_weighted_means

  • command-line interface is no longer available

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

xweights-0.3.0.tar.gz (10.0 MB view hashes)

Uploaded Source

Built Distribution

xweights-0.3.0-py3-none-any.whl (10.0 MB view hashes)

Uploaded Python 3

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