Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor "Intended" Functionality in README #888

Closed
philipc2 opened this issue Aug 15, 2024 · 1 comment · Fixed by #977
Closed

Refactor "Intended" Functionality in README #888

philipc2 opened this issue Aug 15, 2024 · 1 comment · Fixed by #977
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@philipc2
Copy link
Member

philipc2 commented Aug 15, 2024

We mention "intended" functionality in our README. However, many of the features here are already supported.

One solution would be outline something similar to xcdat in their README.

We should consider moving away from a set "intended" functionality bullet points and have a "Features" section, similar to what xcdat has.

Below are the sections from our README that I am referring to.

UXarray Functionality

The following intended functionality has been inspired by discussions with
members of the scientific community, within the SEATS Project and Project
Raijin, and on several community platforms such as Xarray GitHub
Repository
. The UXarray team
is receptive to additional functionality requests.

Intended Functionality for Grids

  • Support for reading and writing UGRID, SCRIP ESMF, and Exodus formatted grids.
  • Support for reading and writing shapefiles.
  • Support for arbitrary structured and unstructured grids on the sphere,
    including latitude-longitude grids, grids with only partial coverage of
    the sphere, and grids with concave faces.
  • Support for finite volume and finite element outputs.
  • Support for edges that are either great circle arcs or lines of constant
    latitude.
  • Calculation of face areas, centroids, and bounding latitude-longitude boxes.
  • Triangular decompositions.
  • Calculation of supermeshes (consisting of grid lines from two input grids).

Intended Functionality for DataArrays on Grids

  • Regridding of data between unstructured grids.
  • Global and regional integration of fields, including zonal averages.
  • Application of calculus operations, including divergence, curl, Laplacian
    and gradient.
  • Snapshots and composites following particular features.
@github-project-automation github-project-automation bot moved this to 📚 Backlog in UXarray Development Aug 15, 2024
@philipc2 philipc2 self-assigned this Aug 15, 2024
@philipc2 philipc2 added the documentation Improvements or additions to documentation label Aug 15, 2024
@philipc2 philipc2 moved this from 📚 Backlog to 📝 To-Do in UXarray Development Aug 15, 2024
@philipc2 philipc2 removed their assignment Aug 28, 2024
@philipc2
Copy link
Member Author

@erogluorhan Would you be interested in tackling this?

@erogluorhan erogluorhan self-assigned this Aug 28, 2024
@philipc2 philipc2 linked a pull request Oct 4, 2024 that will close this issue
@github-project-automation github-project-automation bot moved this from 📝 To-Do to ✅ Done in UXarray Development Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants