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

WIP: Add 2D (polar) maps of structure functions #22

Merged
merged 26 commits into from
Jul 24, 2024
Merged

Conversation

BrodiePearson
Copy link
Collaborator

@BrodiePearson BrodiePearson commented Jul 5, 2024

This PR will allow the creation of 2D polar maps of structure functions, showing how the functions vary with both separation distance and separation direction.

This generalizes the current software functionality, which can diagnose the effects of separation distance in the directions of the data-grid.

Copy link

codecov bot commented Jul 5, 2024

Codecov Report

Attention: Patch coverage is 20.58824% with 108 lines in your changes missing coverage. Please review.

Project coverage is 69.61%. Comparing base (3acfbdf) to head (39a36cf).
Report is 4 commits behind head on main.

Files Patch % Lines
fluidsf/generate_2D_SF_maps.py 11.42% 62 Missing ⚠️
fluidsf/calculate_2D_SF_maps.py 8.57% 32 Missing ⚠️
fluidsf/xy_shift_array.py 12.50% 14 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main      #22       +/-   ##
===========================================
- Coverage   99.13%   69.61%   -29.53%     
===========================================
  Files           8       11        +3     
  Lines         232      362      +130     
===========================================
+ Hits          230      252       +22     
- Misses          2      110      +108     

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

@BrodiePearson
Copy link
Collaborator Author

@cassidymwagner I think this PR's code/example is ready for review now! I still need to add all the other SFs of interest, as it currently just does advective SFs, but I think that addition should be pretty quick.

I added an example, which requires the 2layer data set (only uses the final snapshot) and includes:

  1. A validation of its zonal and meridional components against the existing 1-direction SF calculations
  2. A 2D map of the advective structure functions from the final snapshot
  3. A plot of angles and separation distance to visualize how they vary in two dimensions

The plots created are:

2D_1D_Validation 2D_SF_Map Distances_and_angles

@cassidymwagner
Copy link
Owner

I'm going to merge this as well since the features are ready and any additional documentation can be worked on in #23. I'll make a new branch for testing coverage soon to handle testing for all the modules.

@cassidymwagner cassidymwagner merged commit 371127f into main Jul 24, 2024
12 of 16 checks passed
@BrodiePearson BrodiePearson deleted the 2D_Maps branch August 5, 2024 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants