First Release?

[andersy005]

Now that we have xwrf in a usable state, should we consider cutting its first release soon (later this week or next week)? We already have the infrastructure in place for automatically publishing the package to PyPI. One missing piece is the documentation. The infrastructure for authoring the docs is already in place (uses markdown via myst + furo theme, and the current template follows this documentation system guide). I am opening this issue to keep track of other outstanding issues that need to be addressed before the first release. Feel free to add to this list (cc @ncar-xdev/xwrf)

• Update documentation
• Publish to PyPI
• Publish to conda-forge

[kmpaul]

Not to be too excited, but YES, YES, YES!!! I'm a huge fan of releasing early and getting feedback (and possibly more collaborators!) from interested users.

As a good example, I think we should write a blog that we can put on the ESDS site (or elsewhere, such as the Pangeo Medium blog) on the release and demonstrating what it can do. @jthielen, @lpilz, @bsu-wrudisill: Would any of you (or collaboratively, all of you?) be interested in writing a very simple notebook demonstration of the current state of xwrf?

@ncar-xdev/all: Does anyone feel that there is anything critical that should be implemented before we release? I've added a v0.0.1 milestone to this issue, and *anything that people feel should be implemented before a first release should be added as Issues to this repo with the v0.0.1 milestone.

[lpilz]

I actually wanted to write an Email about this today :D Let's do it! I could also definitely contribute to the demonstration.

The potential blockers I see for the minute are:

• some more documentation in the form of docstrings for the API reference
• maybe the destagger function from First draft "destagger" function #37 merged? (however, I also sucessfully used XGCM with xwrf already so it's not a real blocker)

[andersy005]

https://github.com/orgs/ncar-xdev/teams/all: Does anyone feel that there is anything critical that should be implemented before we release? I've added a v0.0.1 milestone to this issue, and *anything that people feel should be implemented before a first release should be added as Issues to this repo with the v0.0.1 milestone.

@kmpaul, with v.0.0.1 milestone, are you suggesting we use semantic versioning? I'm curious to know whether folks have any preference between Calendar Versioning and Semantic Versioning?

[kmpaul]

@kmpaul, with v.0.0.1 milestone, are you suggesting we use semantic versioning? I'm curious to know whether folks have any preference between Calendar Versioning and Semantic Versioning?

Oh, no. I'm not suggesting semantic versioning. I just don't want to fix a "due date" to the release. So, maybe we could rename the milestone v2022.3.X?

[jthielen]

Sorry for the delay in getting around to this, but I just created #57, which I think would be a critical thing to get in prior to initial release!

[lpilz]

I actually wanted to write an Email about this today :D Let's do it! I could also definitely contribute to the demonstration.

Unfortunately, I have to caveat this a bit. I'm currently busy with a conference I have to prepare, so this contrib would probably happen last week of March/early April at the earliest.

[kmpaul]

No worries, @lpilz. Do what you have to do for your conference. Do you want to wait to release until you can get back to this?

[lpilz]

That's very nice of you to offer, thanks :) I'd say: if you have some constraints and want to get it released earlier rather than later, then go for it. If not, I can definitely try my hand at a draft for the tutorial

[kmpaul]

Ok. My thinking is that the current functionality is still nice. I say, let's not wait to release. We can always mint a new release later with new additions.

[andersy005]

@ncar-xdev/xwrf, the gentlest of bumps on this to see if there's anything i can help with in order to get this release out the door

[mgrover1]

@ncar-xdev/xwrf, the gentlest of bumps on this to see if there's anything i can help with in order to get this release out the door

Happy help with an example notebook (could essentially rework the original blog post from ESDS/walk through the API)

[lpilz]

Was quite busy the last weeks but I will have some time this weekend to also work on some examples :)