API Reference¶

voids is organized into focused modules, each with a clearly scoped responsibility.

Module Overview¶

Module	Description
`voids.core`	Network, SampleGeometry, and Provenance data structures
`voids.physics`	Petrophysics and single-phase flow solver
`voids.geom`	Geometry helpers and characteristic-size normalization
`voids.graph`	Graph algorithms: connectivity and metrics
`voids.linalg`	Linear-algebra assembly, solvers, and diagnostics
`voids.io`	HDF5, PoreSpy, and OpenPNM I/O
`voids.generators`	Synthetic and mesh-based network generators
`voids.examples`	Deterministic synthetic networks and images for testing/demos
`voids.image`	Image processing and connectivity helpers
`voids.visualization`	Plotly and PyVista network rendering
`voids.simulators`	Ready-to-run simulation entry points
`voids.benchmarks`	Verification and validation benchmark utilities

If you already know what you want to do, these are the main entry points:

Task	Primary API
Create a minimal synthetic network	`voids.examples.make_linear_chain_network`
Create a structured mesh-like network	`voids.examples.make_cartesian_mesh_network`
Scale an imported network from voxel units	`voids.io.porespy.scale_porespy_geometry`
Infer Cartesian boundary labels	`voids.io.porespy.ensure_cartesian_boundary_labels`
Import a PoreSpy/OpenPNM-style dictionary	`voids.io.porespy.from_porespy`
Compute porosity and connectivity diagnostics	`voids.physics.petrophysics`
Solve single-phase flow	`voids.physics.singlephase.solve`
Save and reload a canonical network	`voids.io.hdf5.save_hdf5`, `voids.io.hdf5.load_hdf5`
Cross-check a workflow against OpenPNM conventions	`voids.benchmarks.crosscheck`

The main voids package re-exports the three primary data structures:

from voids import Network, SampleGeometry, Provenance

The package version is available as:

import voids
print(voids.__version__)

For the data model and interpretation behind these APIs, see Concepts and Conventions and Theoretical Background.