v2.3.0

🚀 New features

• Added function to compute diffusive size factor using dns #new
• Added zip_to_stack for converting 2D tiff files in a zip folder into a 3D tiff image #new
• Added folder_to_stack for converting 2D tiff files in a folder into a 3D tiff image #new
• Added random_spheres as a wrapper to rsa for more descriptive name (rsa to be deprecated eventually) #new
• Added show_panels function to visualizations module #new
• Added spheres_from_coords to generators #new
• Added find_bbox to tools #new
• Add better sierpinski foam generator that accepts shape #new

🍰 Enhancements

• Added mode='drainage/imbibition' argument to all seq/size/satn functions, to accomodate upcoming imbibition simulations #enh
• Make Results object more useful by including name of function that produced it, and time #enh
• Added seed argument to all random generators #enh
• Enhanced spheres_from_coords to work with negative coordinates #enh #bug
• Improved the speed of find_bbox #enh
• Added protrusion argument to rsa #enh

🔧 Maintenace

• adding release.yml to package to assist with automatic changelog generation #maint
• Fixed imageio deprecation warnings in 2 examples #doc, #maint
• using _all_ everywhere for imports #maint
• Removed optional dependencies from setup.py #maint

⚠️ API changes

• Changed radius to r in voronoi_edges #api
• Moved ibip percolation functions to simulations module

🐛 Bugfixes

• Included dtype in np.sum calls throughout to ensure it returns the correct value on large images #bug
• Fixed bug in find_trapped_regions when no solid present on outlet face #bug
• Fix parse bug in _parse_pad_width used by snow2 if boundary_width was a list of lists #bug
• Fix divs bug in blobs #bug
• Improved output of Results object when large dicts present #bug
• Enhanced spheres_from_coords to work with negative coordinates #enh #bug
• Fixed some bugs pertaining to numpy deprecations becoming reality #bug
• Fixed bugs in rsa when using clearance #bug
• Fixed dynamically changing loglevel #bug
• tortuosity_fd should raise Exception if all pores are floating pores #bug

📗 Documentation

• Fixed formatting of the Results table in tortuosity notebook #doc
• Fixed imageio deprecation warnings in 2 examples #doc, #maint
• Added tutorial notebook explaining the use of spheres_from_coords on various csv files #doc
• Fix link to installation guide in readme #docs
• Added examples on snow2, regions_to_network, and other network extraction related function #docs
• Added examples on often asked questions in the Discussions #doc

Installation

The txt files below contain the specific packages and their versions to install to get a functioning installation for archival purposes using conda. Instructions for installing are in the top of the file.