deps: get the right serialbox dependency (and make it optional)#121
Open
romanc wants to merge 1 commit intoNOAA-GFDL:developfrom
Open
deps: get the right serialbox dependency (and make it optional)#121romanc wants to merge 1 commit intoNOAA-GFDL:developfrom
romanc wants to merge 1 commit intoNOAA-GFDL:developfrom
Conversation
Serialbox is a serialization library that is used to build a validation framework against reference runs. The library is not strictly needed to run tests. I thus removed it from the tests extra. It is used to serialize data and can thus be helpful to be installed with pyFV3. I thus left it as an optional dependency. The currently configured "serialbox" package is about generating and distributing serial numbers. The fact that this misconfiguration never bothered anyone is surprising and hints at the fact that the serialbox serialization library is probably unused as part of the pyFV3 installation.
romanc
commented
Mar 3, 2026
| "pyfv3[test]" | ||
| ] | ||
| ndsl = ["ndsl @ git+https://github.com/NOAA-GFDL/NDSL.git@2026.01.00"] | ||
| serialbox = ["serialbox @ git+https://github.com/FlorianDeconinck/serialbox.git@feature/data_ijkbuff"] |
Collaborator
Author
There was a problem hiding this comment.
Actually, this won't work because the python interface of serialbox is in a subfolder of the repo.
Suggested change
| serialbox = ["serialbox @ git+https://github.com/FlorianDeconinck/serialbox.git@feature/data_ijkbuff"] | |
| serialbox = ["serialbox @ git+https://github.com/FlorianDeconinck/serialbox.git@feature/data_ijkbuff#subdirectory=src/serialbox-python"] |
FlorianDeconinck
requested changes
Mar 3, 2026
Collaborator
FlorianDeconinck
left a comment
FlorianDeconinck
left a comment
There was a problem hiding this comment.
Pulling back here - we should not have serialbox as a dependency at all.
@oelbert : the only use of the serialbox python package is in acoustics.py, a one-file example on how to use the acoustics time step that uses some long lost serialbox data: can we burn that file?
fmalatino
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Serialbox is a serialization library that is used to build a validation framework against reference runs. At NASA/NOAA, we use this branch, which includes a couple of custom commands.
The library is not strictly needed to run tests. I thus removed it from the tests extra. It is used to serialize data and can thus be helpful to be installed with pyFV3. I thus left it as an optional dependency.
The currently configured serialbox package is about generating and distributing serial numbers. The fact that this misconfiguration never bothered anyone is surprising and hints at the fact that the serialbox serialization library is probably unused as part of the pyFV3 installation.
/cc @FlorianDeconinck as discussed
How Has This Been Tested?
Self-review of code plus passing existing tests.
Checklist: