API reference#

Version: 1.1.0

This reference manual details functions, modules, and objects included in RockVerse. Make sure you also check our tutorials and the example gallery.

Library-Wide#

`mpi_comm`	The runtime Message Passing Interface (MPI) communicator.
`mpi_rank`	The rank of the calling process in the MPI communicator.
`mpi_nprocs`	The total number of processes in the MPI communicator.
`config`	The lib-wide instance of the `configuration class` containing the configuration settings and parameters.

open(store, *[, path])

Opens RockVerse data.

`voxel_image`	Handles the basic class for RockVerse Digital Rock Petrophysics, the `VoxelImage` class.
`region`	Provides classes to define abstract Regions of Interest (ROIs) within `VoxelImage` objects.
`dect`	Provides classes and functions for managing Dual Energy Computed Tomography (DECT) Monte Carlo processing.

Provides tools for visualizing various types of data and images.

Manages runtime settings for the RockVerse library.