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

Update documentation to include what input Quantities are expected when using Pint #51

Closed
DocOtak opened this issue Jun 24, 2022 · 10 comments
Assignees
Milestone

Comments

@DocOtak
Copy link
Owner

DocOtak commented Jun 24, 2022

Now that pint support has landed, the expected inputs should be documented on that big long list of functions with the attribute outputs.

I'd like to evaluate switching to the py:func sphinx domain for these functions.

@DocOtak DocOtak self-assigned this Jun 24, 2022
@DocOtak DocOtak added this to the Version 0.3.0 milestone Jun 24, 2022
@DocOtak
Copy link
Owner Author

DocOtak commented Aug 30, 2022

@rcaneill do we have any lingering concerns about pint support? Is TEOS-10/GSW-Python#97 an issue for how we did pint support? do we need to revert back to positional arguments when finally calling the upstream functions?

@rcaneill
Copy link
Collaborator

I already implemented the reversion back to positional / keyword arguments when calling the upstream function:

# the upstream gsw does not treat equally args and kwargs so we get
# back the original args
o_args = list(kwargs.values())[: len(args)]
o_kwargs = {i: kwargs[i] for i in list(kwargs)[len(args) :]}

I think this was done in PR #47 (hence closing issue #49)

So we don't have any problems

@DocOtak
Copy link
Owner Author

DocOtak commented Aug 31, 2022

Oof, yep, failure on my part to notice that. 😞

I'll work on this issues (#51) and on some automated release stuff so we can release when things are tagged on GH. I'll probably use https://test.pypi.org/ while getting this set up.

@rcaneill
Copy link
Collaborator

I'll work on this issues (#51) and on some automated release stuff so we can release when things are tagged on GH. I'll probably use https://test.pypi.org/ while getting this set up.

Great! I wanting to do it but never got time...

@DocOtak
Copy link
Owner Author

DocOtak commented Sep 9, 2022

Every time I think I'll have time to work on this... I seem to get delayed. Well I made sure to have some time today.

  • Docs are updated with expected input units: https://gsw-xarray.readthedocs.io/en/latest/attrs.html
  • An automatic publisher is setup to publish on tag (or manually), I tested it with the test.pypi site everything seems good to go.
  • Not related to publishing, but I was convinced/persuaded to give a small talk about this project to the ESIP Marin Data Cluster. I've included the jupyter notebook I used in an examples directory.

Other than doing the actual "release", is there anything else blocking 0.3.0?

@rcaneill
Copy link
Collaborator

rcaneill commented Sep 9, 2022

Great news! I think that the only thing missing before releasing is changing the changelog.
Thanks for your great work :)

@DocOtak
Copy link
Owner Author

DocOtak commented Sep 9, 2022

Awesome, great catch.

Here we go! 🤞

@DocOtak
Copy link
Owner Author

DocOtak commented Sep 9, 2022

Looks to be... not broken!

How do we update the conda forge version?

@DocOtak
Copy link
Owner Author

DocOtak commented Sep 10, 2022

I guess we just approve the PR made by the robot?

@rcaneill
Copy link
Collaborator

Yes I think so

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

No branches or pull requests

2 participants