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

Documentation Updates 📖 #35

Merged
merged 25 commits into from
Oct 27, 2023
Merged

Conversation

negin513
Copy link
Contributor

@negin513 negin513 commented Aug 17, 2023

Hey Everyone,

This PR includes a comprehensive rehaul/updates of cupy-xarray documentation.
It should cover all the topic discussed in issue/#33 and much more (including demos).

It includes an update index page and the following topics :

  • Basics of CuPy
  • Introduction to CuPy-Xarray
  • High-level Xarray Functions: CuPy vs. NumPy
  • Applying Custom Kernels with CUPY-Xarray
  • Xarray and CuPy (Demo case)

The inspiration for this documentation update came from the materials we presented for cupy-xarray at SciPy 2023. Thanks to @dcherian for suggesting to update the documentations here.

Special thanks to @maxrjones and @dcherian!

@negin513 negin513 requested a review from dcherian August 17, 2023 10:35
@negin513
Copy link
Contributor Author

I have make some slight changes to fix the issue with some of the badges in the README links to address #36. I also modified the admonition box at the top the README looking for maintainers for this project.

Copy link
Contributor

@dcherian dcherian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took a quick look and it's looking nice.

Instead of adding author names & emails to each one, shall we remove that and add "Co-authored-by" to the git commit message instead?

Copy link
Collaborator

@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is awesome, thank you for taking the time to improve the docs here!

A few nitpicky comments :).

@dcherian
Copy link
Contributor

@maxrjones, @negin513 I removed the explicit names from each notebook. Instead I added Max as a co-author on the git commit. Since we squash merge it will help everyone get credit.

@negin513
Copy link
Contributor Author

Sounds good! Thanks!

@dcherian
Copy link
Contributor

Negin, this is an amazing improvement. Thank you again!

@dcherian dcherian merged commit 64643da into xarray-contrib:main Oct 27, 2023
dcherian added a commit to dcherian/cupy-xarray that referenced this pull request Nov 3, 2023
* upstream/main:
  Documentation Updates  📖 (xarray-contrib#35)
  [pre-commit.ci] pre-commit autoupdate (xarray-contrib#37)
  [pre-commit.ci] pre-commit autoupdate (xarray-contrib#34)
  [pre-commit.ci] pre-commit autoupdate (xarray-contrib#32)
  Update .pre-commit-config.yaml (xarray-contrib#28)
  Expand installation doc (xarray-contrib#27)
@weiji14 weiji14 mentioned this pull request Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants