Cleaning up the documentation with proofreading and a more detailed user's guide.#151
Merged
rcjackson merged 4 commits intoopenradar:mainfrom Mar 5, 2026
Merged
Conversation
This release includes critical fixes to the smoothness cost and gradient functions that were causing inconsistent behavior between JAX and NumPy/SciPy engines. Key changes in this release: - Fixed incorrect axis parameters in smoothness second derivative calculations - Removed duplicate Cx, Cy, Cz coefficient scaling in gradient functions - Simplified JAX gradient function to use automatic differentiation exclusively Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Fix typos throughout README, ROADMAP, user guide, and contributor guide - Replace defunct Travis CI badge with GitHub Actions badge - Replace deprecated `python setup.py install` with `pip install -e .` - Fix broken/incorrect URLs (Discourse link, Contributor Covenant, test file) - Align minimum Python version to 3.9 consistently - Replace discontinued ERA Interim reference with ERA5 - Remove stray merge-conflict `=======` separators from README - Fix duplicate toctree entries and add missing nesting_wind_retrieval.rst stub - Expand empty overview.rst and visualizing_winds.rst with real content - Correct radar description (X-SAPR → NEXRAD KTLX/KICT) in user guide - Fix duplicate J_o cost function label in retrieving_winds.rst - Add pydda.io module to dev reference index; fix "initalization" typo there - Fix docstring errors: v_back description, max_bca direction, max_wind_mag name, initial guess typos, and capability spelling in wind_retrieve.py - Fix "jax inport" comment typo in cost_functions.py Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Corrected a typo in the recommendation for optimizing the wind retrieval process.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #151 +/- ##
=======================================
Coverage 68.85% 68.85%
=======================================
Files 32 32
Lines 5141 5141
=======================================
Hits 3540 3540
Misses 1601 1601
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
I am providing edits to the documentation, fixing numerous spelling and grammar errors. There is also more information about PyDDA's wind retrieval in the user guide as well as documentation on the one-way nested retrievals.