Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vorticity data bugs #144

Merged
merged 6 commits into from
Jan 27, 2025
Merged

Vorticity data bugs #144

merged 6 commits into from
Jan 27, 2025

Conversation

aburrell
Copy link
Owner

@aburrell aburrell commented Jan 27, 2025

Description

Fixes #143 and #142.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

How Has This Been Tested?

import datetime as dt
import numpy as np
import ocbpy
stime = dt.datetime(2000,1,1)
etime = dt.datetime(2005,1,1)
dual = ocbpy.DualBoundary(stime=stime, etime=etime, hemisphere=1)
np.all(dual.eab_ind < dual.eab.records)  # Should be True; if bug exists, this will be False

Test Configuration

  • Operating system: OS X Ventura
  • Version number: Python 3.10
  • Any details about your local setup that are relevant: N/A

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My commits are formatted appropriately (following the SciPy/NumPy style)
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to Changelog.rst, summarising the changes
  • Add yourself to AUTHORS.rst and .zenodo.json

Fixed a bug that incorrectly cycled file lines.  Also:
- added reference for the vorticity data, and
- updated failure type from logging error to IOError.
Updated the vorticity failure tests to identify the new failure type.
Added a summary of the changes to the changelog.
Added a criteria that the EAB index cannot be larger than the maximum valid value.
Added a unit test that verifies the maximum OCB and EAB indices are not larger than the largest valid value.  Adjusted custom test to reflect new results with this new safeguard in place.
Updated the changelog to include this bugfix.
@aburrell aburrell added this to the v0.5.0 milestone Jan 27, 2025
This was linked to issues Jan 27, 2025
@aburrell aburrell added the bug label Jan 27, 2025
@coveralls
Copy link

Coverage Status

coverage: 99.723%. first build
when pulling 157f474 on vort_bug
into 728bfcb on develop.

@aburrell aburrell merged commit e16aa05 into develop Jan 27, 2025
79 checks passed
@aburrell aburrell deleted the vort_bug branch January 27, 2025 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dual boundary class can have a bad pair Vorticity file reading
2 participants