gsw-xarray icon indicating copy to clipboard operation
gsw-xarray copied to clipboard

add citation, update readthedoc config, add 3.12 in CI

Open rcaneill opened this issue 1 year ago • 7 comments

Closes #66

rcaneill avatar May 10 '24 15:05 rcaneill

https://support.zenodo.org/help/en-gb/24-github-integration/96-how-does-a-citation-cff-file-affect-metadata-of-my-github-release

For our needs, the CITATION.cff file seems more relevant that the .zenodo.json file

rcaneill avatar May 10 '24 15:05 rcaneill

@DocOtak I let you add your email address if you wish so

rcaneill avatar May 10 '24 15:05 rcaneill

(The readthedoc error seems to come from an update of sphinx to version 7.3.7, version 7.2 was working)

rcaneill avatar May 10 '24 15:05 rcaneill

https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry

rcaneill avatar May 10 '24 15:05 rcaneill

The python 3.12 error seems to come from:

  1. the fact the numpy version that supports 3.12 dropped 3.8
  2. jupyterlab needs to be updated

rcaneill avatar May 10 '24 16:05 rcaneill

Looks like xarray also dropped 3.8 support, we should do the same.

Some versions policies: SPEC0, NEP 29, Xarray follows NEP 29 for now but I know they discuss switching to SEPC0. If I recall correctly, SPEC0 is faster to drop support for things.

I personally usually keep my python one point release behind, so when 3.12 came out, I migrated my personal work from 3.10 to 3.11.

DocOtak avatar May 10 '24 20:05 DocOtak

Seems ready to merge for me. I dropped python 3.8 and added python 3.12. I added a test to verify that the minimal version available in the pyproject file are passing the tests (and I discovered that we need pint>=0.20)

rcaneill avatar May 13 '24 16:05 rcaneill

@DocOtak could you review?

rcaneill avatar May 24 '24 13:05 rcaneill

Nothing jumped out at me reading the changes with my eyes, which is the classic "looks good to me" type response I suppose. I'll poke at the actual code tomorrow morning (UTC-7). It might be worth experimenting with switching things as much as possible to ruff in a later PR. Absolutely support you being "first author" on anything related to this if the ordering in that citation.cff file matters.


P.S. I did see your PhD advisor at Ocean Sciences, he was quite busy with folks interested in his poster so I didn't actually get the opportunity to introduce myself.

DocOtak avatar May 25 '24 03:05 DocOtak

@DocOtak I moved everything to ruff instead of fixing stuff that we would have removed later. Can you review?

rcaneill avatar May 28 '24 09:05 rcaneill

Awesome, I think this is ready to go in. I guess there hasn't been a black run for a while as the style is slightly changing. And I don't know if isort as ever been run on the project.

This should close #70 since flake8 will basically be dropped.

DocOtak avatar May 28 '24 13:05 DocOtak