Skip to main content

hydrogym.jaxfluids.env_core

ConfigError Objects​

class ConfigError(Exception)

Exception raised for configuration-related errors.

JAXFluidsFlowEnv Objects​

class JAXFluidsFlowEnv(JAXFluidsEnv)

Base JAXFluidsFlowEnv with Hugging Face Hub integration for configuration management.

Arguments:

  • environment_name: Required. Name of the environment.

  • hf_repo_id: Hugging Face repository (default: 'dynamicslab/HydroGym-environments')

  • use_clean_cache: Use clean cache directory (default: True)

  • True - Creates fresh workspace copy (recommended for production)
  • False - Uses cached workspace (faster for development/testing)
  • local_fallback_dir: Local directory for offline usage
  • configuration_file: Custom path to MAIA config.yaml (optional)

:param JAXFluidsEnv: description :type JAXFluidsEnv: type