Doc: VolumeRendererOp and VolumeLoaderOp updates
#304
Merged
Conversation
This file contains 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
AndreasHeumann
approved these changes
May 7, 2024
jjomier
approved these changes
May 7, 2024
Update `VolumeRendererOp` and consuming app documentation to provide an overview and details for the ClaraViz JSON configuration file approach, including how to create a config file for new datasets. co-authored-by: Andreas Heumann <[email protected]> Signed-off-by: Tom Birdsong <[email protected]>
Update `VolumeLoaderOp` documentation to indicate that only detached-header volume formats are currently supported. co-authored-by: Andreas Heumann <[email protected]> Signed-off-by: Tom Birdsong <[email protected]>
tbirdso
force-pushed
the
volume_loader_formats_Doc
branch
from
78274c9
to
4fbb5c5
Compare
|
Rebased on |
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.
Update
VolumeRendererOpand consuming app documentation to provide an overview and details for the ClaraViz JSON configuration file approach, including how to create a config file for new datasets.Update
VolumeLoaderOpdocumentation to indicate that only detached-header volume formats are currently supported.Note: we plan to eventually expand upstream API documentation in ClaraViz to reflect config parameter settings. In the meantime we've pointed at ClaraViz gRPC sources with inline comments to help understand what each configuration field means. (thank you @AndreasHeumann )
Closes #302
Supports discussion in #301
Supports discussion in NVIDIA/clara-viz#47