watertap.tools package

Subpackages

• watertap.tools.MPI package
  • Submodules
  • watertap.tools.MPI.dummy_mpi module
  • Module contents
• watertap.tools.analysis_tools package
  • Subpackages
    • watertap.tools.analysis_tools.loop_tool package
      • Submodules
      • watertap.tools.analysis_tools.loop_tool.data_merging_tool module
      • watertap.tools.analysis_tools.loop_tool.loop_tool module
      • Module contents
  • Module contents
• watertap.tools.oli_api package
  • Subpackages
    • watertap.tools.oli_api.core package
      • Submodules
      • watertap.tools.oli_api.core.water_analysis module
      • Module contents
    • watertap.tools.oli_api.util package
      • Submodules
      • watertap.tools.oli_api.util.fixed_keys_dict module
      • watertap.tools.oli_api.util.state_block_helper_functions module
      • watertap.tools.oli_api.util.watertap_to_oli_helper_functions module
      • Module contents
  • Submodules
  • watertap.tools.oli_api.client module
    • OLIApi
      • OLIApi.__init__()
      • OLIApi.call()
      • OLIApi.dbs_file_cleanup()
      • OLIApi.get_dbs_file_id()
      • OLIApi.get_dbs_file_info()
      • OLIApi.get_flash_history()
      • OLIApi.get_user_dbs_files()
      • OLIApi.get_user_summary()
  • watertap.tools.oli_api.conftest module
    • auth_credentials()
  • watertap.tools.oli_api.credentials module
    • CredentialManager
      • CredentialManager.__init__()
      • CredentialManager.delete_oliapi_access_key()
      • CredentialManager.generate_oliapi_access_key()
      • CredentialManager.get_refresh_token()
      • CredentialManager.login()
      • CredentialManager.request_auto_login()
      • CredentialManager.set_access_key()
  • Module contents
• watertap.tools.parallel package
  • Submodules
  • watertap.tools.parallel.concurrent_futures_parallel_manager module
    • ConcurrentFuturesParallelManager
      • ConcurrentFuturesParallelManager.__init__()
      • ConcurrentFuturesParallelManager.combine_data_with_peers()
      • ConcurrentFuturesParallelManager.gather()
      • ConcurrentFuturesParallelManager.gather_arrays_to_root()
      • ConcurrentFuturesParallelManager.get_rank()
      • ConcurrentFuturesParallelManager.is_root_process()
      • ConcurrentFuturesParallelManager.number_of_worker_processes()
      • ConcurrentFuturesParallelManager.results_from_local_tree()
      • ConcurrentFuturesParallelManager.scatter()
      • ConcurrentFuturesParallelManager.sum_values_and_sync()
      • ConcurrentFuturesParallelManager.sync_array_with_peers()
      • ConcurrentFuturesParallelManager.sync_pyobject_with_peers()
      • ConcurrentFuturesParallelManager.sync_with_peers()
  • watertap.tools.parallel.mpi_parallel_manager module
    • MPIParallelManager
      • MPIParallelManager.__init__()
      • MPIParallelManager.combine_data_with_peers()
      • MPIParallelManager.gather()
      • MPIParallelManager.gather_arrays_to_root()
      • MPIParallelManager.get_rank()
      • MPIParallelManager.is_root_process()
      • MPIParallelManager.number_of_worker_processes()
      • MPIParallelManager.results_from_local_tree()
      • MPIParallelManager.scatter()
      • MPIParallelManager.sum_values_and_sync()
      • MPIParallelManager.sync_array_with_peers()
      • MPIParallelManager.sync_pyobject_with_peers()
      • MPIParallelManager.sync_with_peers()
  • watertap.tools.parallel.multiprocessing_parallel_manager module
    • MultiprocessingParallelManager
      • MultiprocessingParallelManager.__init__()
      • MultiprocessingParallelManager.combine_data_with_peers()
      • MultiprocessingParallelManager.gather()
      • MultiprocessingParallelManager.gather_arrays_to_root()
      • MultiprocessingParallelManager.get_rank()
      • MultiprocessingParallelManager.is_root_process()
      • MultiprocessingParallelManager.number_of_worker_processes()
      • MultiprocessingParallelManager.results_from_local_tree()
      • MultiprocessingParallelManager.scatter()
      • MultiprocessingParallelManager.sum_values_and_sync()
      • MultiprocessingParallelManager.sync_array_with_peers()
      • MultiprocessingParallelManager.sync_pyobject_with_peers()
      • MultiprocessingParallelManager.sync_with_peers()
  • watertap.tools.parallel.parallel_manager module
    • ParallelManager
      • ParallelManager.combine_data_with_peers()
      • ParallelManager.gather()
      • ParallelManager.gather_arrays_to_root()
      • ParallelManager.get_rank()
      • ParallelManager.is_root_process()
      • ParallelManager.number_of_worker_processes()
      • ParallelManager.results_from_local_tree()
      • ParallelManager.scatter()
      • ParallelManager.sum_values_and_sync()
      • ParallelManager.sync_array_with_peers()
      • ParallelManager.sync_pyobject_with_peers()
      • ParallelManager.sync_with_peers()
    • build_and_execute()
  • watertap.tools.parallel.parallel_manager_factory module
    • create_parallel_manager()
    • get_mpi_comm_process()
    • has_mpi_peer_processes()
    • should_fan_out()
  • watertap.tools.parallel.ray_io_parallel_manager module
    • RayIoParallelManager
      • RayIoParallelManager.__init__()
      • RayIoParallelManager.combine_data_with_peers()
      • RayIoParallelManager.gather()
      • RayIoParallelManager.gather_arrays_to_root()
      • RayIoParallelManager.get_rank()
      • RayIoParallelManager.is_root_process()
      • RayIoParallelManager.number_of_worker_processes()
      • RayIoParallelManager.results_from_local_tree()
      • RayIoParallelManager.scatter()
      • RayIoParallelManager.shut_down_ray()
      • RayIoParallelManager.sum_values_and_sync()
      • RayIoParallelManager.sync_array_with_peers()
      • RayIoParallelManager.sync_pyobject_with_peers()
      • RayIoParallelManager.sync_with_peers()
  • watertap.tools.parallel.results module
    • LocalResults
      • LocalResults.__init__()
  • watertap.tools.parallel.single_process_parallel_manager module
    • SingleProcessParallelManager
      • SingleProcessParallelManager.__init__()
      • SingleProcessParallelManager.combine_data_with_peers()
      • SingleProcessParallelManager.gather()
      • SingleProcessParallelManager.gather_arrays_to_root()
      • SingleProcessParallelManager.get_rank()
      • SingleProcessParallelManager.is_root_process()
      • SingleProcessParallelManager.number_of_worker_processes()
      • SingleProcessParallelManager.results_from_local_tree()
      • SingleProcessParallelManager.scatter()
      • SingleProcessParallelManager.sum_values_and_sync()
      • SingleProcessParallelManager.sync_array_with_peers()
      • SingleProcessParallelManager.sync_pyobject_with_peers()
      • SingleProcessParallelManager.sync_with_peers()
  • Module contents
• watertap.tools.parameter_sweep package
  • Submodules
  • watertap.tools.parameter_sweep.model_manager module
  • watertap.tools.parameter_sweep.parameter_sweep module
    • ParameterSweep
    • RecursiveParameterSweep
  • watertap.tools.parameter_sweep.parameter_sweep_differential module
    • DifferentialParameterSweep
      • DifferentialParameterSweep.__init__()
  • watertap.tools.parameter_sweep.parameter_sweep_functions module
    • differential_parameter_sweep()
    • parameter_sweep()
    • recursive_parameter_sweep()
  • watertap.tools.parameter_sweep.parameter_sweep_reader module
    • get_sweep_params_from_yaml()
    • set_defaults_from_yaml()
  • watertap.tools.parameter_sweep.parameter_sweep_writer module
  • watertap.tools.parameter_sweep.paramter_sweep_parallel_utils module
    • do_build()
    • do_execute()
    • return_none()
  • watertap.tools.parameter_sweep.sampling_types module
    • FixedSample
    • GeomSample
    • LatinHypercubeSample
    • LinearSample
    • NormalSample
    • PredeterminedFixedSample
    • PredeterminedRandomSample
    • RandomSample
    • ReverseGeomSample
    • SamplingType
    • UniformSample
  • Module contents

Module contents