pyfracval.environments ====================== .. py:module:: pyfracval.environments .. autoapi-nested-parse:: Environment variables used by PyFracVAL. This module centralizes the environment variables that influence runtime behavior in PyFracVAL. Environment Variables --------------------- PYFRACVAL_DISABLE_PARALLEL_SUBCLUSTERS : str When set to ``"1"``, disables multiprocessing for PCA subcluster generation and forces sequential execution. PYFRACVAL_INSTALLED_WHEEL : str Records the wheel filename installed on Dask workers during remote package registration. PYFRACVAL_EXPECTED_VERSION : str Records the package version expected on Dask workers after installation. OMP_NUM_THREADS : str Controls the number of OpenMP threads used by NumPy/SciPy-backed code. MKL_NUM_THREADS : str Controls the number of Intel MKL threads used by NumPy/SciPy-backed code. OPENBLAS_NUM_THREADS : str Controls the number of OpenBLAS threads used by NumPy/SciPy-backed code. NUMEXPR_NUM_THREADS : str Controls the number of NumExpr threads used by NumPy/SciPy-backed code. Module Contents --------------- .. py:class:: EnvironmentConfig Runtime environment configuration for PyFracVAL. :param disable_parallel_subclusters: Whether PCA subcluster generation should run sequentially. :type disable_parallel_subclusters: bool :param installed_wheel: Wheel filename recorded when a package installation is performed on a Dask scheduler or worker. :type installed_wheel: str | None :param expected_version: Expected package version recorded during remote installation. :type expected_version: str | None :param omp_num_threads: Value of ``OMP_NUM_THREADS``. :type omp_num_threads: str | None :param mkl_num_threads: Value of ``MKL_NUM_THREADS``. :type mkl_num_threads: str | None :param openblas_num_threads: Value of ``OPENBLAS_NUM_THREADS``. :type openblas_num_threads: str | None :param numexpr_num_threads: Value of ``NUMEXPR_NUM_THREADS``. :type numexpr_num_threads: str | None .. py:function:: get_env_config() Return the PyFracVAL runtime environment configuration. :returns: Snapshot of the environment variables used by PyFracVAL. :rtype: EnvironmentConfig