API reference

exception lsmaker.lsmaker.EmptyDataFrame

Bases: Exception

exception lsmaker.lsmaker.InputFileMissing(infile)

Bases: Exception

class lsmaker.lsmaker.LinesinkData(infile=None, GFLOW_lss_xml=None)

Bases: object

adjust_zero_gradient(df, increment=0.01)

drop_crossing_lines(df)

drop_duplicates(df)

dtypes = {'AutoSWIZC': <class 'numpy.int64'>, 'DefaultResistance': <class 'float'>, 'Depth': <class 'float'>, 'Drain': <class 'numpy.int64'>, 'EndInflow': <class 'numpy.int64'>, 'EndStream': <class 'numpy.int64'>, 'EndingHead': <class 'float'>, 'Evapotranspiration': <class 'float'>, 'Farfield': <class 'bool'>, 'Gallery': <class 'numpy.int64'>, 'HeadSpecified': <class 'float'>, 'InletStream': <class 'numpy.int64'>, 'Label': <class 'str'>, 'Lake': <class 'numpy.int64'>, 'OutletStream': <class 'numpy.int64'>, 'OutletTable': <class 'str'>, 'OverlandFlow': <class 'numpy.int64'>, 'Precipitation': <class 'float'>, 'Resistance': <class 'float'>, 'Routing': <class 'numpy.int64'>, 'ScenFluxName': <class 'str'>, 'ScenResistance': <class 'str'>, 'StartingHead': <class 'float'>, 'TotalDischarge': <class 'numpy.int64'>, 'Width': <class 'float'>, 'chkScenario': <class 'bool'>}

fcodes = {'Intermittent': 46003, 'Perennial': 46006, 'Uncategorized': 46000}

int_dtype

alias of str

list_updown_comids(df)

classmethod load_configuration(infile)

Load Linesink-maker YAML configuration into a dictionary.

Parameters:

infilestr or pathlike

Linesink-maker configuration file in YAML format.

Returns:

cfgdict

Configuration dictionary

load_poly(shapefile, dest_crs=None)

Load a polygon shapefile and return a multipolygon of multiple features, or single polygon of one feature, projected in the destination coordinate system.

make_linesinks(reuse_preprocessed_lines=False, shp=None)

map_confluences()

map_outsegs()

from Mat2, returns dataframe of all downstream segments (will not work with circular routing!)

maxlines = 4000

preprocess(save=True)

This method associates attribute information in the NHDPlus PlusFlowVAA and Elevslope tables, and the model domain configuration (nearfield, farfield, and any other polygon areas) with the NHDPlus Flowlines and Waterbodies datasets. The following edits are made to the Flowlines and waterbodies: * remove farfield streams lower than <min_farfield_order> * remove waterbodies that aren’t lakes, and lakes smaller than <min_waterbody_size> * convert lakes from polygons to lines; merge the lakes with the with flowlines

prototype(nftol=[10, 50, 100, 200, 500], fftol=500)

Function to compare multiple simplification distance tolerance values for the model nearfield.

read_lsmaker_xml(infile)

read_lss(lss_xml)

read a linesink string (lss) XML file exported by GFLOW

run_diagnostics()

Run the diagnostic suite on the LinesinkData instance.

set_configuration(cfg)

Set the Linesink-maker configuration from a configuration dictionary.

Parameters:

cfgdict

Configuration dictionary, as produced by the LinesinkData.set_configuration_from_yaml method.

set_configuration_from_yaml(infile)

Set the Linesink-maker configuration from a YAML file.

Parameters:

infilestr or pathlike

Linesink-maker configuration file in YAML format.

set_crs(crs=None, prjfile=None)

Set the projected coordinate reference system, and the BasemapUnits. If no arguments are supplied, default to existing BasemapUnits.

Parameters:

crsobj

A Python int, dict, str, or pyproj.crs.CRS instance passed to pyproj.crs.CRS.from_user_input() Can be any of:

• PROJ string

• Dictionary of PROJ parameters

• PROJ keyword arguments for parameters

• JSON string with PROJ parameters

• CRS WKT string

• An authority string [i.e. ‘epsg:4326’]

• An EPSG integer code [i.e. 4326]

• A tuple of (“auth_name”: “auth_code”) [i.e (‘epsg’, ‘4326’)]

• An object with a to_wkt method.

• A pyproj.crs.CRS class

prjfile: str

File path to projection (.prj) file identifying CRS for features in df.geometry (optional)

Returns:

sets the LinesinkData.pyproj_crs attribute.

setup_linesink_lakes(df)

simplify_lines(nearfield_tolerance=None, routed_area_tolerance=None, farfield_tolerance=None, nearfield_refinement={})

Reduces the number of vertices in the GIS linework representing streams and lakes, to within specified tolerances. The tolerance values represent the maximum distance in the coordinate system units that the simplified feature can deviate from the original feature.

Parameters:

nearfield_tolerancefloat

Tolerance for the area representing the model nearfield

farfield_tolerancefloat

Tolerance for the area representing the model farfield

Returns:

dfDataFrame

A copy of the df attribute with a ‘ls_geom’ column of simplified geometries, and a ‘ls_coords’ column containing lists of coordinate tuples defining each simplified line.

tf2flag(intxt)

write_lss(df, outfile)

write GFLOW linesink XML (lss) file from dataframe df

write_lss_by_huc(df)

write_shapefile(outfile=None, use_ls_coords=True)

lsmaker.lsmaker.add_projection(line, point)

Add vertex to line at point, if the closest point on the line isn’t an end.

Parameters:

lineLineString

pointPoint

Returns:

newlineLineString

Line with point added, or original line, if point coincides with end.

lsmaker.lsmaker.add_vertices_at_testpoints(lssdf, tpgeoms, tol=200)

Add vertices to LinesinkData at locations of testpoints (so that modeled flow observations are correct)

Parameters:

lssdfDataFrame

DataFrame of linesink strings. Must contain ‘geometry’ column of shapely LineStrings defining geometries of linesink strings, in same coordinate system as testpoints.

tpgeomslist

List of testpoint geometries.

tolfloat

Tolerance, in coordinate system units, for considering lines near the testpoints.

Returns:

geomslist of geometries

New geometry column with added vertices.

lsmaker.lsmaker.closest_vertex_ind(point, shape_coords)

Returns index of closest vertices in shapely geometry object Ugly but works

lsmaker.lsmaker.get_elevation_from_epqs(lon, lat, units='feet')

Returns an elevation value at a point location.

Notes

example url for -91, 45:

http://nationalmap.gov/epqs/pqs.php?x=-91&y=45&units=Feet&output=json

Examples

>>> get_elevation_from_epqs(-91, 45)
1139.778277

lsmaker.lsmaker.get_elevations_from_epqs(points, units='feet')

From list of shapely points in lat, lon, returns list of elevation values

lsmaker.lsmaker.lake_width(area, total_line_length, lmbda)

Estimate conductance width from lake area and length of flowlines running through it

class lsmaker.lsmaker.linesinks(*args, **kwargs)

Bases: LinesinkData

lsmaker.lsmaker.move_point_along_line(x1, x2, dist)

lsmaker.lsmaker.name(x)

Abbreviations for naming LinesinkData from names in NHDPlus GFLOW requires linesink names to be 32 characters or less

lsmaker.lsmaker.uniquelist(seq)

lsmaker.lsmaker.w_parameter(B, lmbda)

Compute w parameter for estimating an effective conductance term (i.e., when simulating Lakes using Linesinks instead of GFLOW’s lake package)

If only larger lakes are simulated (e.g., > 1 km2), w parameter will be = lambda

see Haitjema 2005, “Dealing with Resistance to Flow into Surface Waters”

lsmaker.lsmaker.width_from_arboate(arbolate, lmbda)

Estimate stream width in feet from arbolate sum in meters, using relationship described by Feinstein et al (2010), Appendix 2, p 266.