deps: remove usage of serialbox in pyFV3#121
Merged
oelbert merged 2 commits intoNOAA-GFDL:developfrom Mar 10, 2026
Merged
Conversation
romanc
commented
Mar 3, 2026
FlorianDeconinck
requested changes
Mar 3, 2026
Collaborator
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
previously approved these changes
Mar 5, 2026
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.
8325902 to
b93ac15
Compare
Collaborator
Author
|
@oelbert I've added a commit to see what would be removed following @FlorianDeconinck's suggestion. Please review and give feedback as you see fit. |
jjuyeonkim
approved these changes
Mar 10, 2026
oelbert
approved these changes
Mar 10, 2026
Collaborator
oelbert
left a comment
There was a problem hiding this comment.
You're right, we should strip Serialbox out of the dependencies for everything except NDSL at this point
Collaborator
|
@FlorianDeconinck if you approve we can merge |
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
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 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.
This PR suggests to remove that dependency and delete the one example file which has
serialboxas a dependency. According to @FlorianDeconinck the example file can't run anymore in this configuration because the data saved with serialbox isn't available anymore. An alternative would be to keep the example file and update it to run with currently available data. Either way, we wouldn't need serialbox as a dependency because now we usually serialize to netcdf./cc @FlorianDeconinck as discussed
How Has This Been Tested?
Self-review of code plus passing existing tests.
Checklist: