Data

Tools

Indexes

Applications

Experiments

Open Source Science

xdggs

Xarray extension for DGGS

https://github.com/xarray-contrib/xdggs

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary

Keywords

dggs discrete-global-grid-system xarray
Last synced: 6 months ago · JSON representation ·

Repository

Xarray extension for DGGS

Basic Info
  • Host: GitHub
  • Owner: xarray-contrib
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://xdggs.readthedocs.io
  • Size: 4.72 MB
Statistics
  • Stars: 123
  • Watchers: 9
  • Forks: 20
  • Open Issues: 37
  • Releases: 5
Topics
dggs discrete-global-grid-system xarray
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation

README.md

CI docs PyPI version codestyle conda-forge


xdggs: discrete global grid systems with xarray

xdggs is an open-source Python package that provides tools for handling geospatial data using Discrete Global Grid Systems (DGGS).

It enables efficient manipulation and analysis of multi-dimensional gridded data within a DGGS framework, supporting spatial data processing, resampling, and aggregation on both global and regional scales.

Inspired by the growing need for scalable geospatial data analysis with DGGS, xdggs is built upon the robust Xarray ecosystem, which simplifies working with labeled multi-dimensional arrays.

As an extension of Xarray, xdggs leverages Xarray's capabilities, including seamless access to formats like NetCDF, Zarr, and parallelization through Dask, to provide a powerful and flexible toolkit for geospatial analysis.

Key Features

  • Seamless Integration with Xarray: Use xdggs alongside Xarray's powerful tools for managing labeled, multi-dimensional data.
  • Support for DGGS: Convert geospatial data into DGGS representations, allowing for uniform spatial partitioning of the Earth's surface.
  • Spatial Resampling: Resample data on DGGS grids, enabling downscaling or upscaling across multiple resolutions.
  • DGGS Aggregation: Perform spatial aggregation of data on DGGS cells.
  • Efficient Data Management: Manage large datasets with Xarray's lazy loading, Dask integration, and chunking to optimize performance.

Documentation

You can find the documentation in https://xdggs.readthedocs.io/en/latest/.

Demo

xdggs demo

Getting Started

As an example, this is how you would use xdggs to reconstruct geographical coordinates from the cell ids then create an interactive plot indicating cell ids, data values and the associated geographical coordinates:

```python import xarray as xr import xdggs

ds = xdggs.tutorial.opendataset("airtemperature", "h3")

Decode DGGS coordinates

ds_idx = ds.pipe(xdggs.decode)

Assign geographical coordinates

dsidx = dsidx.dggs.assignlatloncoords()

Interactive visualization

ds_idx["air"].isel(time=0).compute().dggs.explore(center=0, cmap="viridis", alpha=0.5) ```

Roadmap

We have exciting plans to expand xdggs with new features and improvements. You can check out our roadmap in the design_doc.md file for details on the design of xdggs, upcoming features, and future enhancements.

Contributing

We welcome contributions to xdggs! Please follow these steps to get involved:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and write tests.
  4. Ensure all tests pass (pytest).
  5. Submit a pull request!

License

xdggs is licensed under the Apache License. See LICENSE for more details.

Acknowledgments

This project was initiated using funding from CNES (PANGEO IAOCEA, contract R&T R-S23/DU-0002-025-01) and the European Union (ERC, WaterSmartLand, 101125476, Interreg-BSR, HyTruck, #C031).

Owner

  • Name: xarray-contrib
  • Login: xarray-contrib
  • Kind: organization

xarray compatible projects

Citation (CITATION.cff) 

cff-version: 1.2.0
title: xdggs
message: "If you use this software, please cite it as below."
type: software
authors:
  - family-names: "Magin"
    given-names: "Justus"
    orcid: "https://orcid.org/0000-0002-4254-8002"
  - family-names: "Bovy"
    given-names: "Benoît"
    orcid: "https://orcid.org/0009-0001-4011-3574"
  - family-names: "Kmoch"
    given-names: "Alexander"
    orcid: "https://orcid.org/0000-0003-4386-4450"
  - family-names: "Abernathey"
    given-names: "Ryan"
    orcid: "https://orcid.org/0000-0001-5999-4917"
  - family-names: "Coca-Castro"
    given-names: "Alejandro"
    orcid: "https://orcid.org/0000-0002-9264-1539"
  - family-names: "Strobl"
    given-names: "Peter"
    orcid: "https://orcid.org/0000-0003-2733-1822"
  - family-names: "Fouilloux"
    given-names: "Anne"
    orcid: "https://orcid.org/0000-0002-1784-2920"
  - family-names: "Loos"
    given-names: "Daniel"
    orcid: "https://orcid.org/0000-0002-4024-4443"
  - family-names: "Chan"
    given-names: "Wai Tik"
    orcid: "https://orcid.org/0009-0005-3779-139X"
  - family-names: "Delouis"
    given-names: "Jean-Marc"
    orcid: "https://orcid.org/0000-0002-0713-1658"
  - family-names: "Odaka"
    given-names: "Tina"
    orcid: "https://orcid.org/0000-0002-1500-0156"
repository-code: "https://github.com/xarray-contrib/xdggs"
url: "https://xdggs.readthedocs.io"
keywords:
  - xarray
  - discrete global grid systems
  - dggs
license: Apache-2.0

GitHub Events

Total
  • Create event: 15
  • Release event: 3
  • Issues event: 35
  • Watch event: 50
  • Delete event: 9
  • Issue comment event: 154
  • Push event: 59
  • Pull request review comment event: 17
  • Pull request review event: 22
  • Pull request event: 115
  • Fork event: 8
Last Year
  • Create event: 15
  • Release event: 3
  • Issues event: 35
  • Watch event: 50
  • Delete event: 9
  • Issue comment event: 154
  • Push event: 59
  • Pull request review comment event: 17
  • Pull request review event: 22
  • Pull request event: 115
  • Fork event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 52
  • Total pull requests: 122
  • Average time to close issues: 3 months
  • Average time to close pull requests: 9 days
  • Total issue authors: 11
  • Total pull request authors: 13
  • Average comments per issue: 1.94
  • Average comments per pull request: 1.11
  • Merged pull requests: 107
  • Bot issues: 2
  • Bot pull requests: 18
Past Year
  • Issues: 28
  • Pull requests: 78
  • Average time to close issues: 21 days
  • Average time to close pull requests: 4 days
  • Issue authors: 11
  • Pull request authors: 9
  • Average comments per issue: 1.46
  • Average comments per pull request: 0.92
  • Merged pull requests: 67
  • Bot issues: 2
  • Bot pull requests: 13
View more stats
Top Authors
Issue Authors
  • keewis (17)
  • benbovy (12)
  • tinaok (10)
  • jbusecke (4)
  • github-actions[bot] (2)
  • tik65536 (2)
  • Erin-1919 (1)
  • VeckoTheGecko (1)
  • jules-ch (1)
  • acocac (1)
  • t-ohno0723 (1)
Pull Request Authors
  • keewis (120)
  • pre-commit-ci[bot] (19)
  • annefou (6)
  • benbovy (4)
  • VeckoTheGecko (3)
  • acocac (3)
  • tinaok (2)
  • jbusecke (2)
  • RichardScottOZ (2)
  • dependabot[bot] (2)
  • zawadzl (2)
  • allixender (1)
  • danlooo (1)
Top Labels
Issue Labels
CI (2)
Pull Request Labels
run-upstream (12) dependencies (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 225 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: xdggs

Xarray extension for DGGS

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 225 Last month
Rankings
Dependent packages count: 10.1%
Average: 38.7%
Dependent repos count: 67.4%
Maintainers (1)
benbovy
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
  • h3 *
  • healpy *
  • xarray *
environment.yml pypi