Skip to content

Commit

Permalink
add reference to rectangular grid requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
ks905383 committed Nov 12, 2024
1 parent 73c2af6 commit 297aecd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion joss_paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ When these raster and polygon worlds collide, as they often do in social or natu

Therefore, an ideal aggregation would weight not only by the area of overlap between grid cells and polygons, but also optionally by other densities of relevant variables - population, area planted, etc. [@auffhammer_using_2013].

`xagg` fulfills this need, by providing a simple interface for aggregating raster data stored in `xarray` [@hoyer_xarray_2017] `Datasets` or `DataArrays` onto polygons stored in `geopandas` [@bossche_geopandasgeopandas_2024] `geodataframes`, weighted by the fractional area overlap between the raster grid and the polygon, and optionally additionally weighted by a secondary gridded variable (see \autoref{fig1} for a sample workflow). Fractional area weights are generated by constructing polygons for each grid cell and using `geopandas`' `gpd.overlay()` function to calculate the overlaps between input polygons and grid cells. Aggregated data is then returned as an `xarray` `Dataset`, a `pandas` `DataFrame`, or a `geopandas` `GeoDataFrame`, depending on the user's needs.
`xagg` fulfills this need, by providing a simple interface for aggregating raster data stored in rectangular grids in `xarray` [@hoyer_xarray_2017] `Datasets` or `DataArrays` onto polygons stored in `geopandas` [@bossche_geopandasgeopandas_2024] `geodataframes`, weighted by the fractional area overlap between the raster grid and the polygon, and optionally additionally weighted by a secondary gridded variable (see \autoref{fig1} for a sample workflow). Fractional area weights are generated by constructing polygons for each grid cell and using `geopandas`' `gpd.overlay()` function to calculate the overlaps between input polygons and grid cells. Aggregated data is then returned as an `xarray` `Dataset`, a `pandas` `DataFrame`, or a `geopandas` `GeoDataFrame`, depending on the user's needs.


# Statement of need
Expand Down

0 comments on commit 297aecd

Please sign in to comment.