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.

Sign up for GitHub

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

Jump to bottom

[Doc]: Update README and other related documentation to clarify concisely what xCDAT is targeted at doing and provide example use cases #651

Open

tomvothecoder opened this issue Apr 30, 2024 · 0 comments

Labels

type: docs

Milestone

FY24Q3 (4/01/24 -...

Collaborator

tomvothecoder commented Apr 30, 2024

Describe your documentation update

We've had some questions and feedback regarding explaining what xCDAT does concisely in the documentation.

One example I can find in the README.rst is under the "Project Motivation" section.

The goal of xCDAT is to provide generalizable features and utilities for simple and robust analysis of climate data. xCDAT's design philosophy is focused on reducing the overhead required to accomplish certain tasks in xarray.

We should more clearly describe what those "certain tasks" are. Steve posted a nice summary here on Pangeo

tomvothecoder added the type: docs label

tomvothecoder changed the title ~~[Doc]: Update README and other related documentation to clarify concisely what xCDAT is targeted at doing and example use cases~~ [Doc]: Update README and other related documentation to clarify concisely what xCDAT is targeted at doing and provide example use cases

tomvothecoder added this to the FY24Q3 (4/01/24 - 06/30/24) milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment