Skip to content

Comments

Implement Serialization Messaging (NGWPC-9626)#6

Open
idtodd wants to merge 3 commits intodevelopmentfrom
idt-serialization
Open

Implement Serialization Messaging (NGWPC-9626)#6
idtodd wants to merge 3 commits intodevelopmentfrom
idt-serialization

Conversation

@idtodd
Copy link

@idtodd idtodd commented Feb 2, 2026

To allow for serialization of the BMI data, special variable named used in get_value_ptr and set_value correspond to the BMI creating, loading, and destroying serialized byte data that stores current state values that are changed when the BMI's update method is called. Additionally, to facilitate hindcasting, the set_value message "reset_time" will reset the current time of the BMI to zero after loading a state that includes the timestamp.

Additions

  • Applicable messaging for the serialization variable names "serialization_state" (np.uint8), "serialization_create" (np.uint64), "serializatoin_size" (np.uint64), "serialization_free" (np.intc), and "reset_time" (np.double). These are recognized in get_value_ptr and set_value as well as methods for determining value types and sizes.
  • Storage locations for serialized data and the current size of the serialized data on the lstm_BMI object.
  • Methods on the lstm_BMI class for creating, loading, and freeing properties that update between calls to update().
  • Methods for creating and loading serializable data on the State and EnsembleMember classes.

Removals

Changes

Testing

Screenshots

Notes

Todos

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Windows
  • Linux
  • Browser

Accessibility

  • Keyboard friendly
  • Screen reader friendly

Other

  • Is useable without CSS
  • Is useable without JS
  • Flexible from small to large screens
  • No linting errors or warnings
  • JavaScript tests are passing

@idtodd idtodd self-assigned this Feb 2, 2026
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.

1 participant