Skip to content

Conversation

@rytam2
Copy link
Collaborator

@rytam2 rytam2 commented Jul 26, 2024

Closes #833

Overview

Expected Usage

import uxarray as ux

grid_path = "/path/to/grid.nc"
data_path = "/path/to/data.nc"

uxds = ux.open_dataset(grid_path, data_path)

# this is how you use this function
some_output = uxds.some_function()

# this is another way to use this function
other_output = uxds.some_function(some_param = True)

PR Checklist

General

  • An issue is linked created and linked
  • Add appropriate labels
  • Filled out Overview and Expected Usage (if applicable) sections

Testing

  • Adequate tests are created if there is new functionality
  • Tests cover all possible logical paths in your function
  • Tests are not too basic (such as simply calling a function and nothing else)

Documentation

  • Docstrings have been added to all new functions
  • Docstrings have updated with any function changes
  • Internal functions have a preceding underscore (_) and have been added to docs/internal_api/index.rst
  • User functions have been added to docs/user_api/index.rst

Examples

  • Any new notebook examples added to docs/examples/ folder
  • Clear the output of all cells before committing
  • New notebook files added to docs/examples.rst toctree
  • New notebook files added to new entry in docs/gallery.yml with appropriate thumbnail photo in docs/_static/thumbnails/

@philipc2 philipc2 marked this pull request as ready for review July 26, 2024 22:43
@philipc2 philipc2 merged commit 0032870 into UXARRAY:weighted-mean Jul 26, 2024
philipc2 added a commit that referenced this pull request Jan 16, 2025
* boilerplate

* update boilerplate

* fix boilerplate

* add quad hexagon to tests

* write tests, work on api design

* asv benchmark

* update asv benchmark

* Committing weighted mean modifications from rtam/weighted mean to uxarray/weighted-mean (#866)

* updated mean function with weighted arg

* updated weighted-mean functionality in dataarray.py

* edited weights to dask array

---------

Co-authored-by: Rachel Yuen Sum Tam <[email protected]>
Co-authored-by: Rachel Yuen Sum Tam <[email protected]>

* some cleanup

* fix tests

* add initial dask test cases

* use parametrize

* add boilerplate for example in docstring

* update docstring

* added examples to weighted mean API, userguide and test case

* cleaned userguide output

* restarted kernel

* removed duplicate notebook

* run pre-commit

* re-run notebook

* Update uxarray/core/dataarray.py

Co-authored-by: Aaron Zedwick <[email protected]>

* Update uxarray/core/dataarray.py

Co-authored-by: Aaron Zedwick <[email protected]>

* update docstring, api

* update toc

* update notebook

* update docstring

* clean and restart notebook

---------

Co-authored-by: Rachel Tam <[email protected]>
Co-authored-by: Rachel Yuen Sum Tam <[email protected]>
Co-authored-by: Rachel Yuen Sum Tam <[email protected]>
Co-authored-by: Rachel Tam <[email protected]>
Co-authored-by: Aaron Zedwick <[email protected]>
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.

2 participants