Release v0.5

[nkeim]

pims v0.4.1 was released in 2017. Support for some formats, especially still images, continues to work great in that release, but there have been many improvements, bug fixes, and high-profile API changes since then, most notably a fix for PyAV support.

I'm creating this thread to help us (maintainers and contributors) decide what minimally needs to be done, and what decisions must be made before we can proceed with a release. Actually doing a release and documenting the procedure again will make it easier to do minor releases as more work is done.

Here's what I see as the key steps:

• Rebase and merge ENH Add crop pipeline #247 since it's a nice enhancement with few or no side effects.
• Even though Speed up random access time of PyAVReaderIndexed. #340 is relatively new, we should try to merge it because it's such a huge performance increase.
• Fix the problem with bioformats in Jpype1 0.7 breaks bioformat integration #330 , at least by requiring Jpype ≤ 0.6.3.
• Get more help with bioformats! Bump loci_tools to 6.4.0 #301 may be obsolete, and I know almost nothing about bioformats. Update Bioformats #318 is related and looks important. If anyone (maintainer, or contributor) knows whether this is still an important fix, it would be great to find out!
• Review and merge a PR I'm preparing to update the release notes.
• Publish the release and copy the relevant portions of the release instructions in the trackpy wiki.

There are other PRs that are worth attention but are probably not ready for a timely release:

• Better support for numpy interface. #254 looks like it's still cooking, and @danielballan may be evaluating other approaches. He can correct me if I'm wrong.
• Base ImageIOReader on FramesSequenceND #320 seems worthwhile but it's unclear to me how big an API change this is; it at least needs to be documented. So I'm inclined to leave it until v0.6 unless @rbnvrw wants to finish it soon.
• WIP: Ensure open handles lists correctly #316 is likewise worthwhile but needs some work. I suggest we leave it out.

Note that I am not (yet) volunteering to do this release! I just want us to start by getting organized. Please comment on this plan — what am I missing?

[GenevieveBuckley]

Get more help with bioformats! #301 may be obsolete, and I know almost nothing about bioformats. #318 is related and looks important. If anyone (maintainer, or contributor) knows whether this is still an important fix, it would be great to find out!

Yes, this is still an important fix, imo. I think the plan you've suggested on those issues sounds appropriate.

[rbnvrw]

Awesome @nkeim! Thank you for taking the time to do this.

• Regarding ENH Add crop pipeline #247: yes, that sounds good to me. @caspervdw do you have time to update the PR maybe?
• Regarding Speed up random access time of PyAVReaderIndexed. #340: yes, though I'm a little hesitant to review it myself, as I have never used any of the PyAV functionality before.
• Regarding the Bioformats issues / PRs: @caspervdw nows more about this, he also created PR Bump loci_tools to 6.4.0 #301. If he has time to upgrade that PR, that would be great, otherwise we can try to do it. Also great that @GenevieveBuckley is helping with this! 👍

About my PR #320: all the work is basically done. It is just about properly documenting it in the release notes. Should I add it to #345 ?

[danielballan]

#254 looks like it's still cooking, and @danielballan may be evaluating other approaches. He can correct me if I'm wrong.

That's right.

[rbnvrw]

Hi @nkeim I just wanted to check in with you: what is the status of this? I think most of the points are done? Do you think we're ready for a release?

[nkeim]

Yes, I think we are ready to go! Sorry I haven't been able to spend much time on this in the past few weeks.

I put a draft of the release instructions in the wiki, based on the process for the most recent trackpy release. @rbnvrw do you want to take the lead on this? I'll have some time to help next week but probably not enough to make sure it happens.

[nkeim]

Update: v0.5 is available on PyPI! I am still waiting for the conda-forge bot to act on this. I’m headed to bed and if it hasn’t happened by morning, I’ll take care of it manually. Stay tuned…

[nkeim]

I think we're done! The conda-forge package is built and should be in the channel momentarily. Thanks especially to @GenevieveBuckley , @tacaswell , @jakirkham , @rbnvrw , and @caspervdw for their assistance. Please let me know if anything looks amiss!

This wiki page is based on the trackpy instructions and will hopefully let any maintainer carry out a release in the future.

[jakirkham]

Thanks @nkeim! 😄

[danielballan]

Yes, thanks!

[rbnvrw]

Awesome, thank you @nkeim 🥇

[caspervdw]

Thanks for getting this done @nkeim!

[GenevieveBuckley]

This is great, thank you!