Document how to save programmatic TORAX simulation outputs to disk. - #2435
Merged
Conversation
copybara-service
Bot
force-pushed
the
test_977187684
branch
from
September 7, 2026 15:57
c9e02f0 to
a62de8d
Compare
This CL updates the documentation for TORAX simulation outputs to clarify that programmatic runs return an in-memory xarray.DataTree instead of automatically writing to disk. It adds instructions and code examples for saving these outputs to a NetCDF file using the to_netcdf() method. Additionally, it updates the CLI output documentation to reflect the new default output directory and filename format. PiperOrigin-RevId: 977497292
copybara-service
Bot
force-pushed
the
test_977187684
branch
from
September 7, 2026 16:10
a62de8d to
a73fcd9
Compare
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
1 participant
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.
Document how to save programmatic TORAX simulation outputs to disk.
This CL updates the documentation for TORAX simulation outputs to clarify that programmatic runs return an in-memory xarray.DataTree instead of automatically writing to disk. It adds instructions and code examples for saving these outputs to a NetCDF file using the to_netcdf() method. Additionally, it updates the CLI output documentation to reflect the new default output directory and filename format.