NVIDIA / NVIDIA/simready-foundation
duplicate/redundant (potentially conflicting) information should be removed
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 88
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
The AIF metadata defines the following required fields
aif:core:overallGeometryDimensions | float3 | Overall geometry (WxDxH) in mm
aif:core:height | float | Equipment height in mm
aif:core:width | float | Equipment width in mm
aif:core:depth | float | Equipment depth in mm
Why is overallGeometryDimensions (float3) required when it is a duplicate of the individual width, depth, height values?
Duplicity of data can lead to errors, be they mitakes or numerical representation (rounding/precision) issues and values potentially can get out of sync. Is the float3 really needed here? Information like this can be so easily derived in code at runtime from the core values.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the AIF metadata definitions for overallGeometryDimensions, height, width, and depth, then trace where these required fields are specified or consumed. Compare whether the float3 value is necessary alongside the individual dimensions; done means reaching and recording a clear schema decision about retaining or removing the redundant field.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100