Subsample checks v2.0!

[Mikejmnez]

Sorry about the repeated PR.

This PR addresses same issue #281 and has almost identical code as PR #282 .

I found a weird behavior that it never happens with the ECCO and LLC4320 datasets available through SciServer, but happens with the testing ECCO dataset and thus may happen with some other dataset, under the right combination of arguments.

The error is associated with the following line:

if type(ARCT[i][0]) == _datype:
    ARCT[i] = _xr.merge(ARCT[i])

where ARCT[i] is a list associated with the i-th face and whose elements are either 0 (int) or dataarrays (_datatype). When there are zeros (the negative of that if-statement) it means data within the i-th face does not survive the cutout. When the if-statement is True, data within that face must be transformed.

The bug:

The if statement above assumes the first element (the 0 element) is characteristic of all the elements, but that is not always true. In particular it gives a False positive when the 1st element, a variable or coordinate, doesn't initially have face as a dimension (for example the k, or time).

This situation happens with the test ECCO dataset but not with the data available through SciServer. Nonetheless, I decided to fix this bug just in case and wrote a test for this scenario.

Everything else is the same as the previous PR.

The solution

The bug is fixed by checking that ALL elements are non-zero (or non-integer). The new line is:

if all(type(item) != int for item in ARCT[i]):

This is the only difference between this PR and PR #282

[codecov]

Codecov Report

Merging #284 (c37accc) into main (6f2f8de) will decrease coverage by 0.10%.
The diff coverage is 87.23%.

@@            Coverage Diff             @@
##             main     #284      +/-   ##
==========================================
- Coverage   95.11%   95.01%   -0.11%     
==========================================
  Files          10       10              
  Lines        3848     3888      +40     
  Branches      812      822      +10     
==========================================
+ Hits         3660     3694      +34     
- Misses        122      125       +3     
- Partials       66       69       +3     

Flag	Coverage Δ
unittests	95.01% <87.23%> (-0.11%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
oceanspy/llc_rearrange.py	88.40% <86.36%> (-0.36%)	⬇️
oceanspy/subsample.py	98.04% <100.00%> (+0.17%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more