Add unit-aware Param() field and with_units()/to_example() to meshly#24
Merged
afshawnlotfi merged 2 commits intomainfrom Apr 17, 2026
Merged
Add unit-aware Param() field and with_units()/to_example() to meshly#24afshawnlotfi merged 2 commits intomainfrom
Param() field and with_units()/to_example() to meshly#24afshawnlotfi merged 2 commits intomainfrom
Conversation
afshawnlotfi
added a commit
that referenced
this pull request
Apr 17, 2026
…eshly (#24) * Add unit-aware parameter support with Param() and update README for installation instructions * Bump version to 3.5.0-alpha in pyproject.toml
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.
Summary
Adds
Param(), a drop-in replacement forpydantic.Field()that carries units, shape, and example metadata through to the JSON schema. Also adds two new methods onPackable:to_example()(build an instance from example/default values) andwith_units()(clone with numeric fields converted topint.Quantityobjects). This enables downstream packages like hypersim to declare physical units on simulation parameters and have them appear in tool schemas, MCP integrations, and UI forms without any manual filtering or schema post-processing.Usage Example