search

E3SM-Project / polaris

Testing and analysis for OMEGA, MPAS-Ocean, MALI and MPAS-Seaice
BSD 3-Clause "New" or "Revised" License
6 stars 13 forks source link

Add a tutorial for adding a new test group #48

Closed xylar closed 1 year ago

xylar commented 1 year ago

Checklist

xylar commented 1 year ago

@cbegeman, if you can have a look before the hackathon, that would be great! But no rush.

xylar commented 1 year ago

@cbegeman, I'm fine with all of your suggestions. I do feel like it might be easier for you to make a commit to my branch with these changes, as long as you're okay with doing that. I'll make sure you have permission. Then, I can take a look at your changes and iterate.

xylar commented 1 year ago

@cbegeman, I'm going to go ahead and follow your suggestions. I think they're easy enough to implement.

xylar commented 1 year ago

Maybe we can focus on this type of activity in person and leave the sections where you walk them through existing code for later, or go through them only if there is time. I realize we didn't really chat yet about you intended to use this tutorial in the hackathon, so correct me if you had a completely different vision.

Yes, my vision with the original tutorial that this is the basis for was that no in-person component was necessary. I agree with you that going through the full tutorial in the hackathon isn't useful. In fact, it would be better if folks have a chance to go through it ahead of time so they're at least familiar enough with it to know where to look as they build their own test groups.

But during the hackathon, I was planning to go through the steps and just to follow the flow of the tutorial, describing things at a higher level. I didn't intend to go into the code in detail except maybe where it helps illustrate a higher level point. We can chat about that more in the next 3 weeks.

xylar commented 1 year ago

@cbegeman, I believe I have addressed all of your requested changes. Given that you rightly pointed out that the rpe_test is too complicated to be useful for an initial tutorial, I think it is nevertheless useful to include an example of adding a second test case. I was initially thinking of the restart_test but it's a little complicated. The decom_test seems like the easiest to add, so I've gone ahead and one this. Let me know if that looks okay.

I appreciate your feedback so far and welcome more when you have time.

xylar commented 1 year ago

@cbegeman, these are some really excellent suggestions. Keep them coming as you see them. I'm going to call it a night on this work.

cbegeman commented 1 year ago

@xylar Yep! No need to respond right away. Glad you're ok with this kind of thing and I'm not just being obnoxious :)

xylar commented 1 year ago

Thanks again! I'm fine with simplifying the initial condition. Please feel free to make suggestions there. I won't have time to think about how to do that until the week after next, most likely.

xylar commented 1 year ago

@cbegeman, I'm going to merge this as is for now, and simplify the initial state later if I have time.