v2.1.0

[jgostick]

The release notes for Version 2.1 can be found on the releases page. The main highlights are:

• We have renamed the dns module to simulations which is a more general name since dns implies solving flow or diffusion problems on the image, but as mentioned in the next bullet, PoreSpy offers more than that. (Don't worry, the dns module is still there for backwards compatibility).
• We have added porespy.simulations.drainage function, which is an implementation of our new image based drainage algorithm that incorporate gravity¹.
• Several new functions were added to support the drainage function, such as find_h for finding the height of an invasion front, satn_profile for plotting the saturation as a function of position the domain, and several more.
• Examples on the use of drainage with and without gravity can be found here and here.
• The examples section of the website has been extensively updated. There are now solid examples of nearly every function under the Reference tab. We're constantly working on adding new material to the Tutorials tab for each module. Please consider contributing a notebook to the project!

Footnotes

1. Chadwick EA, Hammen LH, Schulz VP, Bazylak A, Ioannidis MA, Gostick JT*. Incorporating the effect of gravity into image-based drainage simulations on volumetric images of porous media. Water Resources Research. 58(3), e2021WR031509 (2022) DOI ↩