Add analysis task for waves #869
Conversation
|
Hello @sbrus89! Thanks for opening this PR. We checked the lines you've touched for PEP 8 issues, and found:
|
|
@xylar, we should talk about how to clean this up before merging, but I wanted to get a PR started so I don't forget about it. |
| if field['mpas'] == 'timeMonthly_avg_peakWaveFrequency': | ||
| maskedVar = (cellMasks*(1.0/ds[field['prefix']])).compute() | ||
| varRange=(0.0,15.0) | ||
| else: | ||
| maskedVar = (cellMasks*ds[field['prefix']]).compute() | ||
| varRange=(0.0,10.0) |
There was a problem hiding this comment.
varRange shouldn't be hard coded here. It should come from a config option.
field['prefix'] is not the variable you want with the changes I suggested above:
| if field['mpas'] == 'timeMonthly_avg_peakWaveFrequency': | |
| maskedVar = (cellMasks*(1.0/ds[field['prefix']])).compute() | |
| varRange=(0.0,15.0) | |
| else: | |
| maskedVar = (cellMasks*ds[field['prefix']]).compute() | |
| varRange=(0.0,10.0) | |
| var = ds[mpas] | |
| if mpas == 'peakWaveFrequency': | |
| var = 1.0/var | |
| varRange=(0.0,15.0) | |
| else: | |
| varRange=(0.0,10.0) | |
| maskedVar = (cellMasks*var).compute() |
| varRange=(0.0,10.0) | ||
|
|
||
| for index, regionName in enumerate(regionNames): | ||
| print(' '+regionName) |
There was a problem hiding this comment.
| print(' '+regionName) | |
| print(f' {regionName}') |
| plt.savefig(outDirectory+'/'+field['prefix']+'_'+self.season+'_'+regionName.replace(' ','_')+'.png') | ||
| f = open(outDirectory+'/'+field['prefix']+'_'+self.season+'_'+regionName.replace(' ','_')+'.txt','w') | ||
| heights = [patch.get_height() for patch in ax.patches] | ||
| widths = [patch.get_width() for patch in ax.patches] | ||
| xloc = [patch.get_xy()[0] for patch in ax.patches] | ||
| for h,w,x in zip(heights,widths,xloc): | ||
| f.write('{} {} {}\n'.format(x,w,h)) | ||
| f.close() |
There was a problem hiding this comment.
| plt.savefig(outDirectory+'/'+field['prefix']+'_'+self.season+'_'+regionName.replace(' ','_')+'.png') | |
| f = open(outDirectory+'/'+field['prefix']+'_'+self.season+'_'+regionName.replace(' ','_')+'.txt','w') | |
| heights = [patch.get_height() for patch in ax.patches] | |
| widths = [patch.get_width() for patch in ax.patches] | |
| xloc = [patch.get_xy()[0] for patch in ax.patches] | |
| for h,w,x in zip(heights,widths,xloc): | |
| f.write('{} {} {}\n'.format(x,w,h)) | |
| f.close() | |
| regionSuffix = regionName.replace(' ','_') | |
| filePrefix = os.path.join( | |
| outDirectory, f'{prefix}_{self.season}_{regionSuffix}') | |
| plt.savefig(f'{filePrefix}.png') | |
| with open(f'{filePrefix}.txt', 'w') as f: | |
| heights = [patch.get_height() for patch in ax.patches] | |
| widths = [patch.get_width() for patch in ax.patches] | |
| xloc = [patch.get_xy()[0] for patch in ax.patches] | |
| for h, w, x in zip(heights, widths, xloc): | |
| f.write(f'{x} {w} {h}\n') |
|
@sbrus89, it looks like you rebased onto |
|
@xylar, yes. thanks for catching that. Force of habit, I guess. |
- Started with climatology_map_antarctic_melt.py - Partially complete
- Hack to get around standard region group
|
@xylar - I hope this is getting closer, but I'm sure it needs another round of suggestions from you when you have a chance. If you want to test, I have a config file here: Here's an example of what this should produce for |
|
Yay, with my latest suggestions, I'm no longer seeing seams in the Arctic/Antarctic observational plots: |
|
@xylar, I incorporated all your suggestions and tested again. The output is here: |
|
@sbrus89, one thing I forgot is that you need to add some documentation. Could you find a similar analysis tasks in the docs and make a copy? The observations also need to be documented. That's a process we should talk through. |
|
@xylar, I was going to ask about that. Yes, I'll take care of that documentation for the analysis task and follow up with you on the observations. |
There was a problem hiding this comment.
I'm seeing failures in main vs. control analysis. The issue is that the gallery title includes the obs_type, but that isn't defined when you aren't comparing with obs.
It also might not make sense to have galleries for both sets of obs (and the names of the gallery groups may also not make sense) when you are doing a main vs. control run since the obs aren't included in the plots.
|
The situation with the obs isn't actually all that complicated. You need to fill in something in this XML file: Then, we need to run the python script there to generate the readme and the bibtex file that we'll put in the WAVES directory next to the obs files. Some documentation will also get generated automatically from the xml file. You should refer to that in your documentation for the analysis task. Again, find an example of another analysis task with obs to use as a template. |
|
@sbrus89, could you please change the |
|
Retesting looks good. I reran the same analysis I had done before and the changes look fine. I also ran the test suite again and everything except the docs worked as expected, and the docs were fine when I ran them manually so I think it's a fluke. |
|
Docs are also fine in CI here. |
|
Excellent work on this, @sbrus89! |
This adds climatology and regional analyses for E3SM runs with WAVEWATCH III.
Checklist (for @xylar) before merging:
/lcrc/group/e3sm/diagnostics/observations/Ocean/*to/lcrc/group/e3sm/public_html/diagnostics/observations/Ocean/obs.xmland copy to/lcrc/group/e3sm/public_html/diagnostics/observations/Ocean/*