simulate

This module contains the main function to run a Network Simulation simulation()

Functions

simulation(pts, net_layout, cost_dict, …) Generates a network of paths.
simulation(pts, net_layout, cost_dict, netsim_dict)[source]

Generates a network of paths.

Parameters:
  • pts (dataframe) – contains the identifier, row and column of each location
  • net_layout (dataframe) – dataframe specifying origin and destination of each path in the network
  • cost_dict (dictionary) – contains parameters used for calculate_iwdt()
  • netsim_dict (dictionary) – contains parameters needed to execute network simulation
Returns:

  • Gt (2D numpy array) – final ground potential
  • paths (2D numpy array) – sum of all network paths
  • paths_dict (dictionary) – dictionary with the track of every path in network

Notes

simulate() generates a network of paths using the net_layout dataframe generated with the functions from the generate module.

The netsim_dict{} must contain the following entries:

  • ‘i: ‘ - float effect of new path. Default: 1.0
  • ‘Gmax: ‘ - float maximum ground potential.
  • ‘T: ‘ - float 1/T represents the residuality of a path.
  • ‘alpha: ‘ - float coefficient calculated from \(\alpha_1 = \frac {d_0} {ln(1 - NC_0)}\)

While the cost_dict{} must contain the same entries as iwdt_dict{} see cost module