Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/benjiyamin/pyflo
/ functions
Functions
245 in github.com/benjiyamin/pyflo
⨍
Functions
245
◇
Types & classes
45
↓ 41 callers
Method
create_node
Create a new :class:`Node` instance and house it as a child of the network. Returns: Node: The created instance.
pyflo/networks.py:122
↓ 32 callers
Method
slope
(self)
pyflo/links.py:153
↓ 30 callers
Method
create_reach
Create a new :class:`Reach` and assign the node to the upstream end. Args: node_2 (Node): The node to link at the downstream end.
pyflo/networks.py:29
↓ 22 callers
Method
add_basin
Assign a :class:`Basin` instance as a child of the node. Args: basin (basins.Basin): The instance to add. Warning:
pyflo/networks.py:87
↓ 21 callers
Method
create_pt
(self, station, elevation, length=0.0)
pyflo/geometry/vertical.py:93
↓ 13 callers
Method
elevation
(self, station)
pyflo/geometry/vertical.py:145
↓ 13 callers
Method
g1
(self)
pyflo/geometry/vertical.py:36
↓ 8 callers
Method
flow_area
Get the cross sectional area of flow, given a depth from the invert. Args: depth (float): Depth, in :math:`feet`. Return
pyflo/sections.py:70
↓ 8 callers
Method
g2
(self)
pyflo/geometry/vertical.py:41
↓ 8 callers
Method
storage
Get an volume that corresponds to the defined elevation. Args: stage (float): An elevation, in :math:`feet`. Returns:
pyflo/routing.py:97
↓ 6 callers
Method
normal_flow
Get the flow of a partial flow section, given a depth from the invert. Args: depth (float): In :math:`feet`. Returns:
pyflo/links.py:178
↓ 5 callers
Method
hgl_solution_data
Analyzes hydraulics for each reach in a network and returns result data. Returns: Ditch[links.Link]: A dictionary of data associa
pyflo/rational/hydraulics.py:63
↓ 5 callers
Method
hyd_radius
Get the hydraulic radius of flow, given a depth from the invert. Args: depth (float): Depth, in :math:`feet`. Returns:
pyflo/sections.py:26
↓ 5 callers
Method
r
(self)
pyflo/geometry/vertical.py:46
↓ 4 callers
Method
__init__
(self, diameter, count=1, **kwargs)
pyflo/sections.py:58
↓ 4 callers
Method
critical_depth
Goal seek a the critical depth in a open flow case. Args: flow (float): Flow, in :math:`feet^3/second`. Returns:
pyflo/links.py:269
↓ 4 callers
Method
normal_depth
Goal seek a the depth in a open flow case. Args: flow (float): Flow, in :math:`feet^3/second`. Returns: floa
pyflo/links.py:405
↓ 4 callers
Method
runoff_depth
Get the depth of runoff generated from a defined rainfall and properties of the basin. Args: rain_depth (float): In :math:`inches
pyflo/nrcs/hydrology.py:56
↓ 3 callers
Method
get_y
Get the corresponding output of the evaluated equation string, given an input. Args: x (float): An input value. Returns:
pyflo/distributions.py:75
↓ 3 callers
Method
next_pvt_pt
(self, station)
pyflo/geometry/vertical.py:105
↓ 3 callers
Method
stage
Args: inflow (float): link (links.Link): results (Dict[links.Link]): Returns: List[
pyflo/routing.py:225
↓ 3 callers
Method
velocity
Get the velocity of a partial flow section, given a depth from the invert. Args: depth (float): In :math:`feet`. Returns
pyflo/links.py:165
↓ 2 callers
Method
__init__
(self, **kwargs)
pyflo/links.py:18
↓ 2 callers
Method
energy_1
Get the total energy elevation at the upstream end. Args: depth (float): In :math:`feet`. flow (float): Flow, in :mat
pyflo/links.py:483
↓ 2 callers
Method
energy_2
Get the total energy elevation at the downstream end. Args: depth (float): In :math:`feet`. flow (float): Flow, in :m
pyflo/links.py:500
↓ 2 callers
Method
flood_hydrograph
(self, rain_dist, interval)
pyflo/basins.py:11
↓ 2 callers
Method
flow
(self, stage_1, stage_2)
pyflo/links.py:33
↓ 2 callers
Method
flow
(self, stage_1, stage_2)
pyflo/links.py:55
↓ 2 callers
Method
flow_vertices
Get the new vertices of the cross section including the intersection of ground line with the water surface, given a depth from the lowest
pyflo/sections.py:215
↓ 2 callers
Method
friction_loss
Get the water surface elevation difference, based on frictional properties. Args: depth (float): In :math:`feet`. flo
pyflo/links.py:346
↓ 2 callers
Function
goal_seek
(function, bounds, goal, max_iterations, tolerance, func_args=None)
tests/test_maths.py:7
↓ 2 callers
Method
hgl_2
Get the hydraulic elevation at the downstream end. Args: flow (float): Flow, in :math:`feet^3/second`. stage_2 (float
pyflo/links.py:450
↓ 2 callers
Method
key_stations
(self, decimals, curve_step=None, include=None, extremum=True, pvc=True, pvt=True)
pyflo/geometry/vertical.py:156
↓ 2 callers
Method
minor_loss
Get the water surface elevation difference, based on minor losses. Args: depth (float): In :math:`feet`. flow (float)
pyflo/links.py:359
↓ 2 callers
Method
prev_pvc_pt
(self, station)
pyflo/geometry/vertical.py:99
↓ 2 callers
Method
runoff_depth_incremental
Generate incremental amount of runoff generated from rainfall Args: rain_depths (numpy.ndarray): A 2D array of scaled rainfall de
pyflo/nrcs/hydrology.py:85
↓ 2 callers
Method
surface_width
(self, depth)
pyflo/sections.py:98
↓ 2 callers
Method
unit_hydrograph
Get a hydrograph that represents the time-flow relationship per unit (inch) of depth. Args: interval (float): The amount of time
pyflo/nrcs/hydrology.py:105
↓ 2 callers
Method
velocity_loss
Get the vertical head caused by velocity flowing through a reach. Args: depth (float): The assumed value of the depth, in :math:`
pyflo/links.py:435
↓ 1 callers
Method
add_reservoir
(self, reservoir)
pyflo/networks.py:99
↓ 1 callers
Method
add_shapes
Takes a list of (area, cn) tuples, adding to self.area and weighting a new self.c value. Args: shapes (List[Tuple[float, float]])
pyflo/nrcs/hydrology.py:43
↓ 1 callers
Method
add_shapes
Takes a list of (area, c) tuples, adding to self.area and weighting a new self.c Args: shapes (List[Tuple[float, float]]): A list
pyflo/rational/hydrology.py:37
↓ 1 callers
Method
area
Get an area that corresponds to the defined elevation. Args: stage (float): An elevation, in :math:`feet`. Returns:
pyflo/routing.py:76
↓ 1 callers
Method
create_weir
Create a new :class:`Weir` and assign the node to the upstream end. Args: node_2 (Node): The node to link at the downstream end.
pyflo/networks.py:51
↓ 1 callers
Method
critical_depth_accuracy
Check solution convergence for critical depth given a trial value. Args: depth (float): In :math:`feet`. flow (float)
pyflo/links.py:252
↓ 1 callers
Method
critical_velocity
Goal seek a the critical velocity in a open flow case. Args: flow (float): Flow, in :math:`feet^3/second`. Returns:
pyflo/links.py:298
↓ 1 callers
Method
extremum_station
(self)
pyflo/geometry/vertical.py:70
↓ 1 callers
Method
flood_data
Generate pairs of basin runoff flow generated from rainfall over time. Args: rain_depths (numpy.ndarray): A 2D array of scaled ra
pyflo/nrcs/hydrology.py:119
↓ 1 callers
Method
flood_data
Generate pairs of basin runoff flow generated from rainfall over time. Args: rain_dist (numpy.ndarray): The hydrograph with scale
pyflo/rational/hydrology.py:50
↓ 1 callers
Method
flow_accuracy
(self, flow, stage_1, stage_2)
pyflo/links.py:591
↓ 1 callers
Method
flow_area
(self, depth)
pyflo/sections.py:43
↓ 1 callers
Method
flow_area
Get the cross sectional area of flow, given a depth from the lowest point. Args: depth (float): Depth, in :math:`feet`.
pyflo/sections.py:250
↓ 1 callers
Method
friction_slope
Get the water surface grade, based on frictional properties. Args: depth (float): In :math:`feet`. flow (float): Flow
pyflo/links.py:328
↓ 1 callers
Method
get_data
Generate ordered pairs over the defined range. Args: x_max (float): The maximum input to retrieve values. x_delta (fl
pyflo/distributions.py:99
↓ 1 callers
Method
hgl_1
Get the hydraulic elevation at the upstream end. Args: flow (float): Flow, in :math:`feet^3/second`. stage_2 (float):
pyflo/links.py:466
↓ 1 callers
Method
init_node_solution_results
Returns: Dict[links.Link]
pyflo/routing.py:179
↓ 1 callers
Function
links_down_from_node
Gets a list of links traced downstream from a node, ordered from closest to farthest. Args: node (networks.Node): The most upstream node
pyflo/build.py:79
↓ 1 callers
Function
links_up_from_node
Gets a list of links traced upstream from a node, ordered from closest to farthest. Args: node (networks.Node): The most downstream node
pyflo/build.py:14
↓ 1 callers
Method
next_pt
(self)
pyflo/geometry/vertical.py:29
↓ 1 callers
Method
node_solution_results
(self)
pyflo/routing.py:245
↓ 1 callers
Method
normal_depth
(self, flow)
pyflo/links.py:42
↓ 1 callers
Method
normal_depth_accuracy
(self, depth, flow)
pyflo/links.py:77
↓ 1 callers
Method
normal_depth_accuracy
Check solution convergence for depth in a open flow case. Args: depth (float): The assumed value of the depth, in :math:`feet`.
pyflo/links.py:391
↓ 1 callers
Method
prev_pt
(self)
pyflo/geometry/vertical.py:22
↓ 1 callers
Method
projection
(self, depth)
pyflo/sections.py:103
↓ 1 callers
Method
pvc_elevation
(self)
pyflo/geometry/vertical.py:64
↓ 1 callers
Function
read
(filename)
setup.py:6
↓ 1 callers
Function
readlines
(filename)
setup.py:9
↓ 1 callers
Method
section_time
(self, depth, flow)
pyflo/links.py:36
↓ 1 callers
Method
stage_1
Goal seek the depth where energy is balanced between each end of the reach. Args: flow (float): Flow, in :math:`feet^3/second`.
pyflo/links.py:543
↓ 1 callers
Method
stage_1_accuracy
Check solution convergence for upstream stage_1 elevation. Args: stage_1 (float): The assumed value of the stage_1 elevation, in
pyflo/links.py:525
↓ 1 callers
Method
surface_width
(self, depth)
pyflo/sections.py:199
↓ 1 callers
Function
totaled_basin_data
Get cumulative basin data for each reach ordered downstream to the node. Returns: Dict[links.Link]: A dictionary of data associated to ea
pyflo/rational/hydraulics.py:14
↓ 1 callers
Function
tuple_list_from_csv
Open a csv file and get a list of tuples that represents the data. Args: filename (str): The name of the file to open. Returns:
pyflo/system.py:15
↓ 1 callers
Method
wet_perimeter
(self, depth)
pyflo/sections.py:46
↓ 1 callers
Method
wet_perimeter
Get the wet perimeter of flow, given a depth from the invert. Args: depth (float): Depth, in :math:`feet` Returns:
pyflo/sections.py:84
Method
__init__
(self, count=1, **kwargs)
pyflo/sections.py:14
Method
__init__
(self, span, rise, count=1, **kwargs)
pyflo/sections.py:112
Method
__init__
(self, side, count=1, **kwargs)
pyflo/sections.py:147
Method
__init__
(self, l_slope, b_width, r_slope, count=1, **kwargs)
pyflo/sections.py:163
Method
__init__
(self, points, count=1, **kwargs)
pyflo/sections.py:211
Method
__init__
(self, area)
pyflo/basins.py:5
Method
__init__
(self, eff_eval)
pyflo/inlets.py:7
Method
__init__
(self, invert, k_orif, k_weir, section, **kwargs)
pyflo/links.py:48
Method
__init__
A link between two nodes with hydraulic attributes, dimensions, and methods. Args: section (sections.Section): The cross sectiona
pyflo/links.py:103
Method
__init__
A point where a :class:`Basin`, :class:`Reach`, or :class:`Reservoir` can be assigned. Args: network (Network): The parent.
pyflo/networks.py:16
Method
__init__
A top level container for storing network components
pyflo/networks.py:105
Method
__init__
Represents a relationship between elevation at any given time. Args: time_stages (List[Tuple[float, float]]): Pairs of time (in :
pyflo/routing.py:20
Method
__init__
Represents the 3D geometry of a 'bowl' shaped rainwater collector. Args: contours (List[Tuple[float, float]]): Pairs of elevation
pyflo/routing.py:60
Method
__init__
Args: node (networks.Node): tw (float): duration (float): interval (float): rain
pyflo/routing.py:162
Method
__init__
Generates output data from an equation string. Args: equation (str): A string in Python math format. All variables introduced her
pyflo/distributions.py:59
Method
__init__
A vertical point along a profile. Args: profile (Profile): The parent profile, which can contain other points. statio
pyflo/geometry/vertical.py:7
Method
__init__
A collection of points that represent a vertical alignment
pyflo/geometry/vertical.py:77
Method
__init__
A watershed draining to a node with hydrology attributes, dimensions, and methods. Args: area (float): The delineated region conc
pyflo/nrcs/hydrology.py:15
Method
__init__
References a node and carries attributes necessary to perform network hydraulic analysis. Args: node (networks.Node): The most do
pyflo/rational/hydraulics.py:45
Method
__init__
A watershed draining to a node with hydrology attributes, dimensions, and methods. Args: tc (float): The estimated time of concen
pyflo/rational/hydrology.py:17
Method
add_link
(self, link)
pyflo/networks.py:83
Method
add_node
Add a :class:`Node` instance to the network and house it as a child of the network.
pyflo/networks.py:133
Method
add_reach
Assign a :class:`Reach` instance as a child of the node. Args: reach (links.Reach): The instance to add. Warning:
pyflo/networks.py:69
Function
array_from_csv
Open a csv file and get a numpy array that represents the data. Args: filename (str): The name of the file to open. Returns:
pyflo/system.py:41
next →
1–100 of 245, ranked by callers