DA.cathy_DA.DA

Contents

DA.cathy_DA.DA#

class DA.cathy_DA.DA(dirName=None, prj_name='my_cathy_prj', notebook=False, version='1.0.0', verbose=True, **kwargs)[source]#
__init__(dirName=None, prj_name='my_cathy_prj', notebook=False, version='1.0.0', verbose=True, **kwargs)#

Create CATHY object.

..note:

All variables in CAPITAL LETTERS use the semantic from the CATHY legacy fortran codes, while the others are created exclusively for the wrapper.

..note:

All file variable are self dictionnary objects; example: soil file is contained in self.soil

Methods

__init__([dirName, prj_name, notebook, ...])

Create CATHY object.

assign_mesh_bc_df(BCtypName[, times])

backup_results_DA([meta_DA])

Save minimal dataframes of the simulation for result visualisation within python

backup_simu()

Save a copy of the simulation for reuse within python

check_DEM_versus_inputs()

Check shape consistency between attributes and DEM

check_for_inconsistent_BC()

create_mesh_bounds_df(BCtypName, grid3d, ...)

Create a dataframe with flag for different boundary condtions assigned to each nodes

create_mesh_vtk([verbose])

Create custum mesh THIS SHOULD BE MOVED TO MESHTOOLS

create_mesh_vtkris3d_vtk2(verbose)

Create mesh for vtk format version 2

create_mesh_vtkris3d_vtk9()

Create mesh for vtk format version 9

create_output([output_dirname])

Create output directories

display_time_run()

find_nearest_node(node_coords[, grid3d])

Find nearest mesh node

get_outer_nodes(x, y, z)

init_boundary_conditions(BCtypName, time, ...)

load_pickle_backup([filename])

map_prop2mesh(dict_props)

Add a given physical property to the CATHY mesh

map_prop2zone(dict_props, prop)

map_prop_veg(dict_props)

map_states2Observations([...])

Translate (map) the state values (pressure head or saturation) to observations (or predicted) values

read_inputs(filename, **kwargs)

Read CATHY format input file

read_outputs(filename, **kwargs)

Read CATHY format output file

recompileSrc([verbose])

Other option is self.run_processor(runProcess=False)

rich_display([title])

Describe the variable state and fate during the simulation with a rich table

run_DA_sequential(DA_type, dict_obs, ...[, ...])

Run Data Assimilation

run_preprocessor([KeepOutlet, verbose])

Run cppp.exe 1.

run_processor([recompile, runProcess, verbose])

Run cathy.exe

selec_atmbc_window(NENS, ENS_times)

Select the time window of the hietograph == time between two assimilation observations

set_Archie_parm([porosity, rFluid_Archie, ...])

Dict of Archie parameters.

set_BC_laterals(time[, BC_type, val])

Set all sides expect surface one

set_SOIL_defaults([FP_map_default, ...])

show([prop])

Call and parse to cathy.plotter from the main CATHY class

show_bc([BCtypName, time, ax])

Show bc

show_input([prop, ax])

Call and parse to cathy.plotter from the main CATHY class

spatialize_parameters(list_update_parm, parm)

Extend the number of parameters according to the number of zones (useful for the heteregeneous case)

transform_parameters(list_update_parm[, ...])

Parameter (back) transformation before analysis (log, bounded log, ...)

update_ENS_files(dict_parm_pert, ...)

Update by overwriting ensemble files (usually after analysis step or initially to build the ensemble) - update state - update model parameters: - initial conditions - Archie - Hydraulic conductivity ks - Feddes parameters - Atmbc boundary conditions :returns: Overwritten files.

update_atmbc([HSPATM, IETO, time, VALUE, ...])

Atmospheric forcing term (atmbc - IIN6)

update_cathyH([verbose])

Update CathyH file input based on **kwargs parameters.

update_dem([DEM])

Update zone file

update_dem_parameters(**kwargs)

Update DEM parameters - if no args reset to default values

update_hapin(Lines, hapin, tmp_lnb, ...)

update_ic([INDP, IPOND, WTPOSITION, verbose])

The initial conditions file contains the pressure heads distribution for the study area (INDP) For example, to simulate a uniform water table depth or 0.5 m or 1.0 m from the ground surface, INDP=3 and WTHEIGHT=4.5 are selected

update_mesh_boundary_cond(time[, ...])

update_mesh_bounds

update_mesh_vtk([prop, prop_value, replaceVTK])

https://docs.pyvista.org/api/core/_autosummary/pyvista.ExplicitStructuredGrid.add_field_data.html#pyvista.ExplicitStructuredGrid.add_field_data

update_nansfdirbc([time, NDIR, NDIRC, NQ3, ...])

Dirichlet Boundary conditions (or specified pressure) at time t

update_nansfneubc([time, NQ, ZERO, ...])

Neumann boundary conditions (or specifed flux) at time t

update_parm(**kwargs)

Update parm file .. note: - create object zone parm - Updated CATHYH file (NPRT and NUMVP).

update_pert_parm_dict(update_key, ...)

update dict of perturbated parameters i.e. add a new entry with new params.

update_prepo_inputs([DEM, verbose, show])

Update default prepro inputs i.e. hap.in and dtm_13.val files based on kwargs.

update_sfbc([time, sfbc, no_flow])

Seepage face boundary conditions at time t

update_soil([IVGHU, FP, FP_map, SPP, ...])

Soil parameters (soil - IIN4).

update_veg_map([indice_veg, show])

Contains the raster map describing which type of vegetation every cell belongs to.

update_zone([zone])

Update zone file
Contents