Sandsuet output

[amoodie]

summary

Format the default pyDeltaRCM output to be compliant with the sandpiper-toolchain sandsuet data specification.

Previous output format (2.1.9) is maintained via the legacy_netcdf=True specification and this backwards compatibility will be maintained for at least one minor version. Drops support for what was the legacy version (outputs prior to 2.1.0; #233); this change was announced with #293.

Changes to the output file:

• the temporal dimension is called seconds instead of time
• the subgroup is called auxdata instead of meta (note: the internal model reference for this subgroup is still meta and metadata; this could be addressed in a future?)

Changes to the model i/o:

• if legacy_netcdf is False (default) then any custom output grids or metadata or auxdata must provide information for the long_name field of the netcdf file

TODO:

• update tests
• update documentation and examples
• This PR starts a process of specifying the attributes of output data (e.g., this output info) as a dictionary instead of a list. I think this would be much easier to document and explain. I will try to make this a non-breaking change slated for deprecation, and if successful, may include it in this PR. infrastructure is implemented, but will make change in next PR (does not directly affect sandsuet). See specifying the attributes of output data as dictionary instead of list #301
• rename the internal meta listing and references to metadata to auxdata. At first, we should just make meta an alias to auxdata internally, and then could maintain backwards compatability for any custom subclasses. Not necessary, just stylistic

[codecov]

Codecov Report

❌ Patch coverage is 92.68293% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.72%. Comparing base (16e776b) to head (259e4ee).

Files with missing lines	Patch %	Lines
pyDeltaRCM/init_tools.py	90.00%	6 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #299      +/-   ##
===========================================
+ Coverage    78.49%   78.72%   +0.22%     
===========================================
  Files           12       12              
  Lines         2674     2726      +52     
===========================================
+ Hits          2099     2146      +47     
- Misses         575      580       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.