geophires_x_client

class geophires_x_client.GeophiresXClient(enable_caching=False, logger_name=None)

A thread-safe and process-safe client for running GEOPHIRES simulations. It automatically manages a background process via atexit and provides an explicit shutdown() method for advanced use cases like testing.

get_geophires_result(input_params: GeophiresInputParameters) → GeophiresXResult

Calculates a GEOPHIRES result, using a cross-process cache to avoid re-computing results for the same inputs. Caching is only effective when providing an instance of ImmutableGeophiresInputParameters.

classmethod shutdown()

Explicitly shuts down the background manager process and de-registers the atexit hook to prevent errors if called multiple times. This is useful for test suites or applications that need to precisely control the resource lifecycle.