wolfhece.scenario.config_manager

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

wolfhece.scenario.config_manager.ACCEPTED_PREFIX = ['bath_', 'mann_', 'infil_', 'roof_']

wolfhece.scenario.config_manager.delete_folder(pth: pathlib.Path)

class wolfhece.scenario.config_manager.GPU_2D_file_extensions

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

TIF = '.tif'

TIFF = '.tiff'

PY = '.py'

NPY = '.npy'

BIN = '.bin'

JSON = '.json'

TXT = '.txt'

class wolfhece.scenario.config_manager.IC_scenario

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

WATERDEPTH = 'h.npy'

DISCHARGE_X = 'qx.npy'

DISCHARGE_Y = 'qy.npy'

BATHYMETRY = 'bathymetry.npy'

wolfhece.scenario.config_manager.ALL_EXTENSIONS

wolfhece.scenario.config_manager.WOLF_UPDATE = 'Wolf update'

wolfhece.scenario.config_manager.WOLF_BC = 'Wolf boundary conditions'

wolfhece.scenario.config_manager.OTHER_SCRIPTS = 'Other scripts'

wolfhece.scenario.config_manager.IS_SIMUL = 'is_simul'

wolfhece.scenario.config_manager.IS_SCENARIO = 'is_scenario'

wolfhece.scenario.config_manager.IS_RESULTS = 'is_results'

wolfhece.scenario.config_manager.HAS_RESULTS = 'has_results'

wolfhece.scenario.config_manager.MISSING = 'missing'

wolfhece.scenario.config_manager.SUBDIRS = 'subdirs'

wolfhece.scenario.config_manager.DISCHARGES = 'discharges'

wolfhece.scenario.config_manager.INITIAL_CONDITIONS = 'initial_conditions'

wolfhece.scenario.config_manager._gpu_file

class wolfhece.scenario.config_manager.GPU_2D_file

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

PARAMETERS

BATHYMETRY

WATER_DEPTH

DISCHARGE_X

DISCHARGE_Y

MANNING

COMPUTATION_MASK

INFILTRATION

wolfhece.scenario.config_manager.RESULT_DIR = 'simul_gpu_results'

class wolfhece.scenario.config_manager.Hydrograph_scenario(fname: pathlib.Path, sep: str = '\t', decimal='.')

Hydrograph for a scenario

property name: str

property data: pandas.DataFrame

plot(figax=None)

class wolfhece.scenario.config_manager.InitialConditions_scenario(dir: pathlib.Path)

Initial conditions for a scenario

property z_elevation: numpy.ndarray

Return the elevation of the water surface

set_h_from_z(z: numpy.ndarray)

Set the water depth from the elevation of the water surface

save(dir: pathlib.Path)

Save the initial conditions

class wolfhece.scenario.config_manager.Config_Manager_2D_GPU(workingdir: str = '', mapviewer: wolfhece.PyDraw.WolfMapViewer = None, python_venv: pathlib.Path = None)

Gestionnaire de configurations 2D - code GPU

property epsilon

property filter_independent

property txtctrl

find_wolfgpu()

Find the wolfgpu Path from wolfgpu package

_test_ui()

Test if the UI is available

load_data()

Chargement/Rechargement des données

_scan_dir(wd: pathlib.Path, curdict: dict)

Scan récursif d’un répertoire de base et création de sous-dictionnaires

scan_wdir()

Récupération de tous les répertoires et sous-répertoires et placement dans le dictionnaire self.configs

get_header() → wolfhece.wolf_array.header_wolf

Get header from .tif file

_get_header(filearray: pathlib.Path) → wolfhece.wolf_array.header_wolf

Get header from .tif file

get_all_numpy() → list[pathlib.Path]

Get all numpy files

get_all_tif() → list[pathlib.Path]

Get all tif files

get_all_sims() → list[pathlib.Path]

Get all simulation files

_flatten_configs() → list[dict]

flatten configs

check_prefix(list_tif: list[pathlib.Path]) → str

Check if all files have the right prefix

check_consistency() → str

Check consistency of all files

All numpy files must have the same shape as the tif file in the root directory All hydrographs must have the same number of columns

_find_files_subdirs(wd: pathlib.Path, curdict: dict, erase_cache: bool = True)

Recherche des fichiers de simulation/scenario dans un répertoire

_recursive_find_files(wd: pathlib.Path, curdict: dict, erase_cache: bool = True)

Recherche récursive des fichiers de simulation/scenario dans les répertoires dont la structure a été traduite en dictionnaire

_prefill_dict(curdict: dict)

Création des listes pour toutes les extensions

_test_is_simul(curdict: dict)

Teste si le répertoire contient des fichiers de simulation

_test_is_scenario(curdict: dict)

Teste si le répertoire contient des fichiers de scénario

_test_is_results(curdict: dict)

Teste si le répertoire contient des fichiers de résultats

find_files()

Recehrche des fichiers de simulation/scenario dans les répertoires dont la structure a été traduite en dictionnaire

get_tree(from_path: pathlib.Path) → list[pathlib.Path]

Get tree from a path

Fnd all directories from the current path to the working directory

get_dicts(from_tree: list[pathlib.Path]) → list[dict]

Get dicts from a tree

_select_tif_partname(curdict: dict, tifstr: Literal[bath_, mann_, infil_, roof_])

Select tif files with a ‘str’ as name’s prefix

check_nodata(from_path: pathlib.Path)

Check nodata in a path

create_vrt(from_path: pathlib.Path)

Create a vrt file from a path

create_vec(from_path: pathlib.Path, which: Literal[bath_, mann_, infil_, roof_] = 'bath_') → wolfhece.PyVertexvectors.Zones

Create a vec file from a path

translate_vrt2tif(from_path: pathlib.Path)

Translate vrt to tif

apply_scripts_bath_mann_inf_roof(from_path: pathlib.Path)

Apply all scripts

_import_scripts(from_path: pathlib.Path, which) → list[types.ModuleType]

List all modules in structure and import them.

As multiple files with a same name can be found in the structure, a copy of the file is made in the same folder with a unique name and then imported.

So, if a file is required in the script, the relative import can be used. If we cache the file in an other folder, the relative import will not work.

After the import, the copied files are deleted.

_import_scripts_topo_manning_inf_roof(from_path: pathlib.Path) → list[types.ModuleType]

import all topo and manning scripts from a path

_apply_scripts_update_topo_maning_inf_roof(modules: list[types.ModuleType] | pathlib.Path | str, array_bat: wolfhece.wolf_array.WolfArray, array_mann: wolfhece.wolf_array.WolfArray, array_inf: wolfhece.wolf_array.WolfArray, array_roof: wolfhece.wolf_array.WolfArray)

Apply all scripts from a list of modules

_import_scripts_bc(from_path: pathlib.Path) → list[types.ModuleType]

Import all BC’s scripts from a path

_apply_scripts_bc(modules: list[types.ModuleType] | pathlib.Path | str, sim: wolfgpu.simple_simulation.SimpleSimulation)

Apply all scripts from a list of modules

load_hydrograph(path: pathlib.Path, toplot=True) → tuple[Hydrograph_scenario, matplotlib.pyplot.Figure, matplotlib.pyplot.Axes]

Load hydrograph from a path

load_ic(path: pathlib.Path) → InitialConditions_scenario

Load initial conditions from a path

get_hydrographs() → list[wolfhece.PyHydrographs.Hydrograph]

Get all hydrographs

get_initial_conditions() → list[InitialConditions_scenario]

Get all initial conditions

get_names_hydrographs() → list[str]

get_name_initial_conditions() → list[str]

create_void_infil()

create void infiltration_zones file

create_void_roof()

create void roof file

create_simulation(dir: pathlib.Path, idx_hydros: list[int] = [-1], delete_existing: bool = False, preserve_ic: bool = False, callback=None) → list[pathlib.Path]

Create a simulation from different hydrographs

create_batch(path: pathlib.Path, allsims: list[pathlib.Path]) → str

Create a batch file

run_batch(batch: pathlib.Path)

run a batch file in a subprocess

get_mapviewer()

Get the mapviewer object

transfer_ic(dir1: pathlib.Path, dir2: pathlib.Path)

Transfer IC from one sim to another

extract_tif(from_path: pathlib.Path, to_path: pathlib.Path)

Extract tif files from IC

class wolfhece.scenario.config_manager.UI_Manager_2D_GPU(data: dict, parent: Config_Manager_2D_GPU)

User Interface for scenario 2D GPU

refill_data(data: dict)

Fill tree with data

create_UI()

Création de l’interface graphique

Partie latérale gauche - arbre des simulations Partie latérale droite - boutons d’actions Partie inférieure - affichage des informations

onchange_epsilon(e: wx.KeyEvent)

Change epsilon value

onchange_filter(e: wx.MouseEvent)

Change filter independent zones value

reload()

Reload the structure

onupdate_structure(e: wx.MouseEvent)

Mise à jour de la structure

oncreate_void_infil(e: wx.MouseEvent)

Création d’un fichier d’infiltration vide

oncreate_void_roof(e: wx.MouseEvent)

Création d’un fichier de toit de pont vide

oncreate_void_scripts(e: wx.MouseEvent)

Création d’un script vide

oncreatevrt(e: wx.MouseEvent)

Création d’un fichier vrt

oncreatevec(e: wx.MouseEvent)

Création d’un fichier vec

ontranslatevrt2tif(e: wx.MouseEvent)

Traduction d’un fichier vrt en tif

onapply_scripts(e: wx.MouseEvent)

Application des scripts sur les fichiers tif

oncheck_prefix(e: wx.MouseEvent)

Vérification des préfixes des fichiers tif

oncheck_consistency(e: wx.MouseEvent)

Vérification de la cohérence des fichiers

choice_hydrograph() → list[int]

onextract_tif(e: wx.MouseEvent)

Extraction des fichiers tif

ontransfer_ic(e: wx.MouseEvent)

Transfert des conditions initiales

oncreate_simulation(e: wx.MouseEvent)

Creation d’une simulation

onrun_batch(e: wx.MouseEvent)

run batch file

onlist_simulation(e: wx.MouseEvent)

List all simulations and print infos in text control

get_sims_only(force=False)

Get paths to all or selected simulations

OnCheckItem(e)

All levels under the item are checked/unchecked

_callbackwp()

Callback for wolfparam

_callbackwp_destroy()

Callback for wolfparam

OnActivateTreeElem(e)

If you double click on a tree element

filter_independent_zones(n_largest: int = 1, icpath: pathlib.Path = None)

Filtre des zones indépendantes et conservation des n plus grandes

clear_text()

Reset txt control

_open_script(mydata: pathlib.Path, wolf: bool = False)

Open the script in the editor

_append_configs2tree(curdict: dict, root: wx.dataview.TreeListItem)

Ajout des éléments du dictionnaire dans l’arbre sur base de la racine fournie