prepare for legacy output file deprecation with future version 2.2. #293
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.
The behavior of the legacy NetCDF output format option, and the new file output format is expected to change in version 2.2.0.
With v2.2.0 the default output file comply with the sandsuet data specification, and the legacy_output=True` option will output the current configuration. The core data will not change with v2.2, but the names and attributes of components of the data output is expected change.
I don't expect dropping the current legacy option to affect any users. Current users will be able to maintain the current file format with
legacy_netcdf=Truefor versions moving forward from v2.2. They will be encouraged to adapt scripts to the new format, but we will maintain backwards compatibility.See sandsuet data specification for expected file format.