pyHMT2D API¶

pyHMT2D base classes, constants, and tools¶

class HydraulicData(name)¶

Hydraulic data base class

name¶

name of the hydraulic mode that this data is for, e.g., SRH-2D, HEC-RAS, or just the name of the data set, e.g., terrain, flow

Type: str

clear_data()¶: clear the data

init_data()¶: Initialize the data

modify_ManningsN(materialID, newManningsNValue, materialName)¶

Modify materialID’s Manning’s n value to new value

Parameters

materialID (int) – material ID
newManningsNValue (float) – new Manning’s n value
materialName (str) – name of the material

reset_data()¶: Reset the data

class HydraulicModel(name, version)¶

Hydraulic model base class

name¶

name of the hydraulic model, e.g., SRH-2D, HEC-RAS

Type: str

version¶

version of the hydaulic model, e.g., 3.3, 5.0.7, 6.0

Type: str

exit_model()¶: Exit the model

init_model()¶: Initialize the model

run_model()¶: Run the model

gMax_Nodes_per_Element¶: maximum number of nodes for an element

gMax_Elements_per_Node¶: maximum number of elements for a node

SRH-2D related classes and tools¶

Package summary for SRH-2D:

class SRH_2D_Data(srhhydro_filename)¶

A class for SRH-2D data I/O, manipulation, and format conversion

This class is designed to read SRH-2D results in format other than VTK. It can save SRH-2D results into VTK format for visualization in Paraview, parse SRH-2D mesh information and convert/save to other formats, query SRH-2D results (e.g., for calibration), etc.

hdf_filename¶

The name for the HDF result file generated by HEC-RAS

Type: str

srhhydro_obj¶

An object to hold information in the SRHHYDRO file

Type: SRH_2D_SRHHydro

srhgeom_obj¶

An object to hold information in the SRHGEOM file

Type: SRH_2D_SRHGeom

srhmat_obj¶

An object to hold information in the SRHMAT file

Type: SRH_2D_SRHMat

Constructor for SRH_2D_Data

srhgeom_filename and srhmat_filename are contained in the SRHHydro file.

Parameters: srhhydro_filename (str) – Name of the SRHHydro file

buildManningN_cells_nodes()¶

Build Manning’s n values at cell centers and nodes

This calculation is based on the srhhydro and srhgeom files, not interpolation from a GeoTiff file. This is the Manning’s n value used by SRH-2D.

cell_center_to_vertex(cell_data, vertex_data)¶

Interpolate result from cell center to vertex

Not implemented yet.

get_case_name()¶

Get the “Case” name for this current case (“Case” in srhhyro file)

Returns: case_name – Case name
Return type: str

outputVTK(vtkFileName, resultVarNames, resultData, bNodal)¶

Output result to VTK file

The supplied resultVarNames and resultData should be compatible with the mesh. If resultVarNames is empty, it only outputs the mesh with no data.

Parameters

vtkFileName (str) – name for the output vtk file
resultVarNames (str) – result variable names
resultData (numpy.ndarray) – 2D array containing result data
bNodal (bool) – whether the data is nodal (True) or at cell center (False)

outputXMDFDataToVTK(bNodal, timeStep=- 1, lastTimeStep=False, dir='')¶

Output XMDF result data to VTK

This has to be called after the XMDF data have been loaded by calling readSRHXMDFFile(…).

Parameters

bNodal (bool) – whether export nodal data or cell center data. Currently, it can’t output both.
timeStep (int) – optionly only the specified time step will be saved
lastTimeStep (bool) – optionally specify only the last time step
dir (str, optional) – directory to write to

Returns

vtkFileNameList – a list of vtkFileName (for each time step)

Return type

list

output_2d_mesh_to_vtk(flatMeshVTKFileName, bFlat=False, dir='')¶

output the flat mesh to vtk

Parameters

flatMeshVTKFileName (str) – file name for the flat mesh
bFlat (bool) – whether to make the 2d mesh flat (node’s z coordinate -> 0)
dir (str, optional) – directory to write to

output_boundary_manning_n_profile(nodeStringID, nodeStringFileName, dir='')¶

Output Manning’s n profile for a specified boundary

Parameters

nodeStringID (int) – nodeString ID of specified boundary
nodeStringFileName (str) – name of output file
dir (str, optional) – directory for the output file

readSRHFile(srhFileName)¶

Read SRH-2D result file in SRHC (cell center) or SRH (point) format.

Note: SRH-2D outputs an extra “,” to each line. As a result, Numpy’s genfromtext(…) function adds a column of “nan” to the end. Need to take care of this.

Parameters: srhFileName (str) – file name for the SRH result file

readSRHXMDFFile(xmdfFileName, bNodal)¶

Read SRH-2D result file in XMDF format (current version 13.1.6 of SMS only support data at node).

Parameters

xmdfFileName (str) – file name for the XMDF data
bNodal (bool) – whether it is nodal (True) or at cell center (False)

readTECFile(tecFileName)¶

Read SRH-2D results in Tecplot format

Parameters: tecFileName (str) – Tecplot file name

vertex_to_cell_center(vertex_data, cell_data)¶

Interpolate result from vertex to cell center

Not implemented yet.

class SRH_2D_Model(version, srh_pre_path, srh_path, extra_dll_path, faceless=False)¶

SRH-2D Model which can control simulation runs.

SRH_2D_Model controls the run of SRH-2D. A case can be loaded and executed. Currently SRH_2D_Model has very limited capability to modify geometry, mesh, and flow data. One of the main use scenarios is for calibration or Monte Carlo simulations.

_faceless¶: bool whether show the SRH-2D window when it is running

_srh_path¶: str path to the SRH_2D program (e.g., srh_2d.exe depending on the version)

_srh_pre_path¶: str path to the SRH_2D preprocessing program (e.g., srh_2d_pre.exe depending on the version)

_extra_dll_path¶: str path for library Dlls, such as XMDL, zlib, hdf5, and msvcr used by SRH-2D.

_srh_2d_data¶: SRH_2D_Data a SRH_2D_Data object to hold the simulation case data.

SRH_2D_Model constructor

Parameters

version (str) – version number of SRH-2D
srh_pre_path (str) – path to the SRH_2D preprocessing program (e.g., srh_2d_pre.exe depending on the version)
srh_path (str) – path to the SRH_2D program (e.g., srh_2d.exe depending on the version)
extra_dll_path (str) – path for library Dlls, such as XMDL, zlib, hdf5, and msvcr used by SRH-2D
faceless (bool, optional) – whether show the SRH-2D window when it is running

close_project()¶

Close the opened SRH-2D project (if any)

It will set _srh_2d_data to None.

exit_model()¶: Exit the model (SRH-2D specific)

get_simulation_case()¶

Get the simulation case to srh_2D_data

Returns: srh_2d_data – an object from class SRH_2D_Data, which should be created before calling
Return type: SRH_2D_Data

init_model()¶

Initialize SRH-2D model

It will check the existance of SRH-2D executable files and add extra DLL path to the system PATH environment.

open_project(srhhydro_filename)¶

Open a SRH-2D project with the specified srhhydro file

A SRH_2D_Data object will be created to hold the project information.

Parameters: srhhydro_filename (str) – name of the srhhydro file (which contains srhgeom_filename and srhmat_filename)

run_model()¶

Run the SRH-2D model

It will run the current SRH-2D project (case) and show a progress bar. The case has to be created before with open_project(…) or set_simulation_case().

run_pre_model()¶

Run SRH-2D Pre to preprocess the simulation case

Run SRH-2D’s preprocessing step for current case.

set_simulation_case(srh_2d_data)¶

Set the simulation case to srh_2D_data (if it has been created already)

Parameters: srh_2d_data (SRH_2D_Data) – an object from class SRH_2D_Data, which should be created before calling

class SRH_2D_SRHGeom(srhgeom_filename, bcDict)¶

A class to handle srhgeom file for SRH-2D

Notes

In SMS (SRH-2D), monitoring lines (ML) and monitoring points (MP) are treated seperately and differently. ML is created in the same way as boundary lines. Nodes closest to the line are recorded as a NodeString in SRHGEOM file. MP is created as a feature point and its coordiantes are recorded in the “srhmpoint” file. Interpolation is done to probe the results at MPs.

This potentially have some drawbacks:
1. The MLs and MPs have to be defined before the simulation is run, not afterwards. One can use plot over a line or point, but it is not convenient and it is limited. For example, to calculate flow over a line, one has to cut a line and then integrate.
2. The way MLs are defined if slightly limited by the mesh (node locations). To be exactly at a ML, one has to interpolate the simulated solution to the points on MLs.
Becasue BC and ML are mixed together, we need to separate them. However, this can only be done with the BC information in the srhhydro file. That is why we need to pass in bcDict in the constructor.

Constructor for SRH_2D_SRHGeom

Parameters

srhgeom_filename (str) – Name of the SRHGeom file
bcDict (dict) – Boundary condtion dictionary

buildEdgesAndBoundaryEdges()¶: Build edges and boundaryEdges dictionaries

buildNodeElements()¶: Build node’s element list for all nodes

extrude_to_3D(layerHeights, mshFileName, bTerrainFollowing=False, dir='')¶

Extrude the 2D mesh to 3D with layers

When extruded: node -> line, edge -> face, 2D element-> volume, boundary line -> boundary face

The extruded mesh is written to a GMSH MSH file. Tried MSH version 4. But it seems too complicated (entities etc.). They are not necessary for our purpose. Therefore, we will stick with version 2 and OpenFOAM takes this version well.

Ref: https://gmsh.info/doc/texinfo/gmsh.html#MSH-file-format-version-2-_0028Legacy_0029

Parameters

layerHeights (list) – a list with strictly increasing heights for the layers. If bTerrainFollowing is True, only the last value is used as the top elevation.
mshFileName (str) – name of the GMSH MSH file to be written
bTerrainFollowing (bool) – whether to follow the terrain. If False, the bottom will be at z = 0, and the layer heights are specified in layerHeights. If True, the bottom will key the terrain elevation, the top will be at layerHeights[-1] and interpolation inbetween.

getNumOfElementsNodes()¶

Get the number of elements and nodes in srhgeom mesh file

Returns

output_2d_mesh_to_vtk(flatMeshVTKFileName, bFlat=False, dir='')¶

output the 2D mesh to vtk

Parameters

flatMeshVTKFileName (str) – VTK file name for the flat mesh
bFlat (bool, optional) – whether to make a flat mesh (z=0)
dir (str, optional) – directory to write the VTK file to

output_as_gmsh(gmshFileName, dir='')¶

Output SRH-2D mesh in GMESH format

Not implemented yet.

Parameters

gmshFileName (str) – GMSH MSH file name to write to
dir (str, optional) – directory name to write to

output_nodeString_line_coordinates(nodeStringID, nodeStringFileName, dir='')¶

Output the nodeString line coordinates into a text file

Parameters

nodeStringID (int) – the ID of the nodeString to be written out
nodeStringFileName (str) – the name of the file to be written to
dir (str, optional) – directory to write the output file to

readSRHGEOMFile()¶: Get mesh information by reading the srhgeom file

class SRH_2D_SRHHydro(srhhydro_filename)¶

A class to handle srhhydro file for SRH-2D

srhhydro_filename¶

name for the srhhydro file

Type: str

srhhydro_content¶

a dictionary to hold all information in the srhhydro file

Type: dictionary

Methods

Constructor for SRH_2D_SRHHydro

The SRH_2D_SRHHydro file contains all information for a SRH-2D run.

Parameters: srhhydro_filename (str) – The name of the SRHHydro file

get_grid_file_name()¶

Get grid file name (shoudl be like “xxx.srhgeom”)

Returns: value – Name of the grid file
Return type: str

get_mat_file_name()¶

Get material file name (shoudl be like “xxx.srhmat”)

Returns: value – Name of the material file
Return type: str

get_simulation_start_end_time()¶

Get the start and end time of simulation (in hours, from the “SimTime” entry)

Returns

startTime (float) – start time in hours
endTime (float) – end time in hours

get_simulation_time_step_size()¶

Get the time step size of simulation (in seconds, from the “SimTime” entry)

Returns: deltaT – time step size in seconds
Return type: float

modify_ManningsN(materialIDs, newManningsNValues, ManningN_MaterialNames)¶

Modify materialID’s Manning’s n value to new value

Parameters

materialIDs (list) – material ID list
newManningsNValues (list) – new Manning’s n value list
ManningN_MaterialNames (list) – name of materials list

parse_srhhydro_file()¶

Parse the SRHHydro file

It will read the SRHHydro file and build the dictionary self.srhhydro_content

write_to_file(new_srhhydro_file_name)¶

Write to a SRHHydro file (useful for modification of the SRHHydro file)

Parameters: new_srhhydro_file_name (str) – name of the new srhhydro file

class SRH_2D_SRHMat(srhmat_filename)¶

A class to handle srhmat file for SRH-2D

srhmat_filename¶

name of the srhmat file

Type: str

numOfMaterials¶

number of materials defined in the srhmat file

Type: int

matZoneCells¶

each material zone’s cell list (in a dictionary: material zone ID and cell list)

Type: dict

Methods

SRH_2D_SRHMat constructor from a srhmat file

Parameters: srhmat_filename (str) – name of the srhmat file

buildMaterialZonesData()¶: Build the data for material zones from reading the srhmat file

find_cell_material_ID(cellID)¶

Given a cell ID, find its material (Manning’s n) ID

Parameters: cellID (int) – cell ID to find material ID for

HEC-RAS related classes and tools¶

Package summary for RAS-2D:

class HEC_RAS_Model(version, faceless=False)¶

HEC-RAS Model class

HEC-RAS Model controls the run of HEC-RAS. A plan can be loaded and executed. Currently HEC_RAS_Model has very limited capability to modify HEC-RAS project, plan, geometry, and flow data. It is mainly used for calibration and Monte Carlo simulations.

_faceless¶: bool whether show the HEC-RAS GUI

_ras_path¶: str path to the HEC-RAS program (Ras.exe)

_RASController¶: object RASController

_project_file_name¶: str HEC-RAS project name (including the full path)

_project¶: HEC_RAS_Project HEC_RAS_Project object corresponding to current project

HEC_RAS_Model constructor

Parameters

version (str) – HEC-RAS version
faceless (bool, optional) – whether to run HEC-RAS without GUI

close_project()¶: Close the current project (if any)

exit_model()¶: Exit the model (HEC-RAS specific)

get_current_project()¶: Get the current opened project

get_plan_names(IncludeOnlyPlansInBaseDirectory)¶

Get the list of plan names in the current project

Based on this COM object function: Plan_Names(self, PlanCount=defaultNamedNotOptArg, PlanNames=defaultNamedNotOptArg, IncludeOnlyPlansInBaseDirectory=defaultNamedNotOptArg)

Parameters

IncludeOnlyPlansInBaseDirectory (bool) – whether only include plans in the base directory

Returns

PlanCount (int) – number of plans in the current project
PlanNames (list) – a list of plan names in the current project

get_simulation_case()¶

Get the simulation case to RAS_2D_data

Returns: ras_2d_data – an object from class RAS_2D_Data, which should be created before calling
Return type: RAS_2D_Data

init_model()¶: Initialize a HEC-RAS instance

open_project(projectFileName, terrainFileName)¶

open the specified HEC-RAS project

Parameters

projectFileName (str) – project file name including the path
terrainFileName (str) – file name for the terrain (not necessarily the terrain used by HEC-RAS for the project). This terrain file (in GeoTiff format) is used to interpolate the elevation at face points (which HEC-RAS does not export to result HDF files). This GeoTiff terrain file can be converted from the terrain used in the HEC-RAS project. (TODO: convert in this function internally without user input).

Returns

currentPlanFile (str) – name of current plan file
currentPlanName (str) – name of current plan

run_model()¶

Run the HEC-RAS model

A project and a plan have to be defined and selected before the run.

save_project()¶: Save the current project

class RAS_2D_Data(hdf_filename, terrain_filename)¶

A class for HEC-RAS 2D data I/O, manipulation, and format conversion

This class is designed to read HEC-RAS results in HDF format. It can save RAS2D results into VTK format for visualization in Paraview, parse RAS2D mesh information and convert/save to SRH-2D format, query RAS2D results (e.g., for calibration), etc.

hdf_filename¶

the name for the HDF result file generated by HEC-RAS

Type: str

plan_filename¶

the name for the HEC-RAS run plan file

Type: str

plan¶

the name of the HEC-RAS run plan

Type: str

short_identifier¶

the short name of the run, called “Short Identifier” in HEC-RAS

Type: str

RAS_2D_Data class constructor

Parameters

hdf_filename (str) – name of the HDF file that contains HEC-RAS results
terrain_filename (str) – name of the terrain file (HEC-RAS’s result HDF file does not have elevation in point coordinates (up to v6; may change in future).

build2DAreaBoundaries()¶: Build boundaries with their point list

build2DAreaCellFaceList()¶: Build cell’s face list

build2DAreaFaceHydraulicInformation()¶: For 2D flow area, build face hydraulic information table (face area elevation)

build2DAreaFacePointCoordinatesList()¶: Build face point coordinates list

build2DAreaFaceProfile()¶

Build face profile

Face profile in HEC-RAS represents the sub-grid terrain.

build2DInterpolatorFromGeoTiff(geoTiffFileName)¶

Build 2D interpolator for from geoTiff file, e.g., terrain and Manning n ID, using Python interpolate.interp2d

Assume the data is in band 1.

This method is too slow (use with caution if the case is large).

geoTiffFileName¶

name for the geoTiff file

Type: str

build2DManningNZones()¶

Build 2D flow area’s Manning n zones from the land cover (Manning’s n) HDF file

Assume that there is “Land Cover Filename” and “Land Cover Layername” in the result HDF file. If they don’t exist (mostly for the case that the whole domain uses the default, constant Manning’s n value in [“Geometry”][“2D Flow Areas”][0][1]), just use that constant.

buildCellManningNFromGeoTiffHDF()¶

Build 2D flow area cell’s Manning n value from HEC-RAS’s GeoTiff and HDF files for Manning n.

This method is more accurate than interpolateManningN_face_to_cell(), which uses a face to cell interpolation.

Also need to consider the case where the “Land Cover Filename” is empty and the whole domain uses the default constant Manning’s n.

buildFace_FacePoints()¶: Build face’s facepoint list

dump_all_data()¶: Dump all data to screen (for debugging purpose)

exportBoundariesToVTK(boundaryVTKFileName, dir='', twoDAreaNumber=0)¶

Export boundaries of 2D area to VTK (for visual inspection in Paraview and check the ID of NodeString)

Parameters

boundaryVTKFileName (str) – name of the VTK file for output
twoDAreaNumber (int, optional) – 2D flow area number (default is 0)

exportFaceProfilesToVTK(faceProfileVTKFileName, dir='', twoDAreaNumber=0)¶

Export face profile of 2D area to VTK (for visual inspection in Paraview)

Parameters

faceProfileVTKFileName (str) – name of VTK file to write to
dir (str, optional) – directory to write to
twoDAreaNumber (int, optional) – 2D flow area number (default is 0)

exportSRHGEOMFile(srhgeomFileName, twoDAreaNumber=0)¶

Export srhgeom file

Parameters

srhgeomFileName (str) – name of the srhgeom file
twoDAreaNumber (int, optional) – 2D flow area number (default = 0)

exportSRHMATFile(srhmatFileName)¶

Export the SRHMAT file

Parameters: srhmatFileName (str) – name of the srhmat file to write to

get2DAreaBoundaryNamesTypes()¶

Get 2D Flow Area boundary names, which 2D area it belongs to, type (External or Internal), and Length

Returns: hdf2DAreaBoundaryNamesTypes – the content of the “Attributes” table in HDF, which includes “Name”, “SA-2D”, “Type”, and “Length”
Return type: list

get2DAreaBoundaryPoints()¶

Get 2D Flow Area boundary points (all points on boundaries)

Returns: hdf2DAreaBoundaryPoints – the content of the “External Faces” table in HDF, which include “BC Line ID”, “Face Index”, “FP Start Index”, “FP End Index”, “Station Start”, and “Station End”
Return type: numpy.ndarray

get2DAreaCellCenterCoordiantes(area)¶

Get 2D Flow Area cell center coordinates for a specified 2D area

Note: these coordinates only have (x,y), no z.

Parameters: area (str) – name of area

get2DAreaCellCounts()¶: Get 2D Flow Areas cell counts

get2DAreaCellFacePointsIndexes(area)¶

Get 2D Flow Area cell face points indexes for a specified 2D area

Parameters: area (str) – name of the area

get2DAreaCellPoints()¶: Get 2D Flow Area cell points

get2DAreaCellsFaceOrientationInfo(area)¶

Get cells face and orientation info for a specified 2D area

Parameters: area (str) – name of area

get2DAreaCellsFaceOrientationValues(area)¶

Get cells face and orientation values for a specified 2D area

Parameters: area (str) – name of area

get2DAreaFaceAreaElevationInfo(area)¶

Get faces area elevation info for a specified 2D area

Two columns: first column-starting index, second column-length of record

Parameters: area (str) – name of area

get2DAreaFaceAreaElevationValues(area)¶

Get faces area elevation values for a specified 2D area

Four columns: first column-elevation, second column-area: third column-wetted perimeter, fourth column-Manning’s n (a constant as of now RAS version <=6)

Parameters: area (str) – name of area

get2DAreaFaceFacePointIndexes(area)¶

Get face’s facepoint indexes (two interger IDs)

Parameters: area (str) – name of area

get2DAreaFacePointsCoordinates(area)¶

Get the face points’ coordinates for a specified 2D area

Parameters: area (str) – name of area

get2DAreaNames()¶: Get the names of 2D Flow Areas in the HEC-RAS Plan’s geometry

get2DAreaSolutionTimeDates()¶

Get 2D Flow Area solution time_dates

Returns: hdf2DAreaSolutionTimeDates – list of solution time and dates
Return type: list

get2DAreaSolutionTimes()¶

Get 2D Flow Area solution times

Returns: hdf2DAreaSolutionTimes – list of solution times
Return type: list

get_intervals()¶: Get the computation, output, and map intervals

get_shortID()¶: “Find the short_ID

get_start_end_time()¶: Get the plan_filename and the start_time and end_time

get_time_minutes(interval)¶

pass the interval to this function to get the minute value

Parameters: interval (str) – internal in string format

get_units()¶

Get the units used in the HEC-RAS project

Units used in HEC-RAS can be either ‘Feet’ or ‘Meter’.

hdf2DAreaResultVar(area, varName)¶

Get HEC-RAS solution time series result for a given variable

Parameters

area (str) – name of area
varName (str) – variable name

interpolateManningN_face_to_cell()¶

interpolate Manning’s n from face to cell center

HEC-RAS 2D stores Manning’s n value at faces, not cell centers. We need to interpolate its value from face to cell center. Another option is to use the cell center coordinates and direclty query the Manning’s n layer in RAS Mapper, which might be too complicated because HEC-RAS has default Manning’s n, Land Use Cover, Override polygon, etc. Here, the interpolation from face to cell might not be a bad choice.

For each face, HEC-RAS currently does not support varying Manning’s n (horizontally and veritcally). Thus, effectively, it is a constant value for each face. This may change in the future.

interpolateZcoord2Points(facePointsCoordinates3D)¶

Interpolate the elevation (bathymetry) to 2D area’s points (z-coordinate)

Parameters: facePointsCoordinates3D (numpy.ndarray) – face points coordinates in 3D

interpolatorFromGeoTiff(geoTiffFileName, pointList, dataType=<class 'float'>)¶

Interpolate from a GeoTiff file given a point list.

Parameters

geoTiffFileName (str) – name of the GeoTiff file
pointList (list) – list of points (x,y)
dataType (int, optional) – data type in the GeoTiff (default is numpy.float)

load2DAreaSolutions()¶: Load solutions (cell depth and water surface elevation, node X and Y vel.) for all 2D areas

modify_ManningsN(materialIDs, newManningsNValues, materialNames)¶

Modify materialID’s Manning’s n values to new values

Assume that there is “Land Cover Filename” and “Land Cover Layername” in the result HDF file. If they don’t exist (mostly for the case that the whole domain uses the default, constant Manning’s n value in [“Geometry”][“2D Flow Areas”][0][1]), just use newManningsNValues[0].

Parameters

materialIDs (list) – material ID list
newManningsNValues (list) – new Manning’s n values in a list
materialNames (list) – names of the material in a list

saveHEC_RAS2D_results_to_VTK(timeStep=- 1, lastTimeStep=False, dir='')¶

Save HEC-RAS 2D solutions to VTK files.

Note

Each area saved separately
Each time saved separately

The resulted files will be RAS2D_areaName_timeSequence.vtk, e.g., RAS2D_SpringCreek_0001.vtk, RAS2D_SpringCreek_0002.vtk, etc.

The option lastTimeStep specifies whether only the last time step is saved (default=False). The option timeStep specifies the particular step to be saved. If both lastTimeSTep and timeStep are specified, lastTimeStep has the priority.

Parameters

timeStep (int, optional) – only the specified time step will be saved
lastTimeStep (bool, optional) – specify only the last time step
dir (str, optional) – directory name to write to

Miscellaneous classes and tools¶

Package summary for Misc

class RAS_to_SRH_Converter(RASPlanResultFileName, RASTerrainGeoTiffFileName, SRHCaseName)[source]¶

A Python class to convert HEC-RAS case, mainly mesh and material (Manning’s n), to SRH-2D case

Typical work flow is as follows: 1. create 2D case in HEC-RAS 2. call RAS to SRH converter: create srhgeom and srhmat files 3. manually create and adjust srhhydro file 4. run SRH-2D

RASPlanResultFileName¶

HEC-RAS result from a plan, such as caseName.p01.hdf

Type: str

RASTerrainGeoTiffFileName¶

HEC-RAS Terrain’s GeoTiff file name

Type: str

SRHCaseName¶

Case name for SRH-2D; the resulted files will be SRHCaseName.srhgeom, SRHCaseName.srhmat

Type: str

convert_to_SRH()[source]¶: Convert the case to SRH

class Terrain(name)[source]¶

A Python class for terrain data I/O, creation, and manipulation

Typical work flow is as follows:

create the Terrain object
create the terrain (elevation, pixel_width/height): user can either call some pre-defined terrains such as constant slope, or create the terrain by themsleves and then call set_terrain(…), and set_pixel_size(…)
set the georeferencing by calling set_georeference(…)
save the terrain to file by calling save_terrain_to_file(…)

name¶

name of the terrain

Type: str

elevation¶

elevation of the terrain (2D numpy array)

Type: numpy.ndarray

geoTopLeft_x¶

raster’s top-left corner georeferenced x-coordinate

Type: float

geoTopLeft_y¶

raster’s top-left corner georeferenced y-coordinate

Type: float

pixel_width¶

pixel width (in x), i.e, each pixel is how many meters/feet wide?

Type: float

pixel_height¶

pixel height (in y), i.e, each pixel is how many meters/feet high?

Type: float

EPSGCode¶

EPSG (European Petroleum Survey Group) code that defines the coordinate reference system

Type: int

geoTransform¶

affine transform for the raster image from image pixel to real coordinates

Type: list

supportedGDALDrivers¶

list of supported GDAL drivers (short names only)

Type: list

Terrain class constructor

Parameters: name (str) – name of the terrain

build_supported_GDAL_drivers_list()[source]¶: Build the list of supported GDAL drivers list

create_constant_slope_channel_elevation(slope, channel_lenx, channel_leny, pixel_width, pixel_height, elevation_origin=0, extra_len=0)[source]¶

Create a constant slope channel elevation

The slope is in the x direction only. The slope in the y direction is zero.

Parameters

slope (float) – slope in x
channel_lenx (float) – channel length in x
channel_leny (float) – channel length in y
elevation_origin (float) – the elevation at the origin (top left; does not account for the extra fringe)
extra_len (float) – optional extra fringe length added to the channel domain (to have some free room in developing 2D models in e.g., SMS or HEC-RAS.

get_elevation()[source]¶

Get the elevation array

Returns: elevation – elevation 2D array
Return type: numpy.array

get_terrain_name()[source]¶

Get the terrain name

Returns: name – name of the terrain
Return type: str

save_terrain_to_file(terrainFileName, geoDriverName='GTiff')[source]¶

save terrain to file, such as GeoTiff

Parameters

terrainFileName (str) – file name for the saved terrain
geoDriverName (str) – GDAL raster driver names, such as ‘GTiff’

set_elevation(elevation)[source]¶

Set the elevation array

Parameters: elevation (numpy.ndarray) – elevation 2D array

set_georeference(geoTopLeft_x, geoTopLeft_y, EPSGCode)[source]¶

Set the georeferencing information

Parameters

geoTopLeft_x (float) – raster’s top-left corner georeferenced x location
geoTopLeft_y (float) – raster’s top-left corner georeferenced y location
EPSGCode (int) – EPSG (European Petroleum Survey Group) code that defines the coordinate reference system

set_pixel_size(pixel_width, pixel_height)[source]¶

Set the pixel size in x and y directions

Parameters

pixel_width (float) – the width of each pixel in real world
pixel_height (float) – the height of each pixel in real world

pyHMT2D API¶

pyHMT2D base classes, constants, and tools¶

Backwater-1D related classes and tools¶

SRH-2D related classes and tools¶

HEC-RAS related classes and tools¶

Miscellaneous classes and tools¶