Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xyluo25 committed May 18, 2024
1 parent ee77b26 commit 334ae07
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 8 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,13 @@ if __name__ == "__main__":
# net.net2zone(cell_width=10, cell_height=10, unit="km")

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
net.run_gravity_model(zone_prod_attr, zone_od_distance_matrix)
net.run_gravity_model()

# Save demand, zone, updated node, updated poi to csv
net.save_results_to_csv(overwrite_file=True)
Expand Down Expand Up @@ -99,10 +102,13 @@ if __name__ == "__main__":
net.taz2zone()

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
net.run_gravity_model(zone_prod_attr, zone_od_distance_matrix)
net.run_gravity_model()

# Save demand, zone, updated node, updated poi to csv
net.save_results_to_csv(overwrite_file=True)
Expand Down Expand Up @@ -131,10 +137,13 @@ if __name__ == "__main__":
net.taz2zone()

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
net.run_gravity_model(zone_prod_attr, zone_od_distance_matrix)
net.run_gravity_model()

# Save demand, zone, updated node, updated poi to csv
net.save_results_to_csv(overwrite_file=True)
Expand Down Expand Up @@ -163,10 +172,13 @@ if __name__ == "__main__":
# net.net2zone(cell_width=10, cell_height=10, unit="km")

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
net.run_gravity_model(zone_prod_attr, zone_od_distance_matrix)
net.run_gravity_model()

# Save demand, zone, updated node, updated poi to csv
net.save_results_to_csv(overwrite_file=True)
Expand Down
18 changes: 15 additions & 3 deletions README_pkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,13 @@ if __name__ == "__main__":
# net.net2zone(cell_width=10, cell_height=10, unit="km")

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
net.run_gravity_model(zone_prod_attr, zone_od_distance_matrix)
net.run_gravity_model()

# Save demand, zone, updated node, updated poi to csv
net.save_results_to_csv(overwrite_file=True)
Expand Down Expand Up @@ -80,10 +83,13 @@ if __name__ == "__main__":
net.taz2zone()

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
net.run_gravity_model(zone_prod_attr, zone_od_distance_matrix)
net.run_gravity_model()

# Save demand, zone, updated node, updated poi to csv
net.save_results_to_csv(overwrite_file=True)
Expand Down Expand Up @@ -112,10 +118,13 @@ if __name__ == "__main__":
net.taz2zone()

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
net.run_gravity_model(zone_prod_attr, zone_od_distance_matrix)
net.run_gravity_model()

# Save demand, zone, updated node, updated poi to csv
net.save_results_to_csv(overwrite_file=True)
Expand Down Expand Up @@ -144,6 +153,9 @@ if __name__ == "__main__":
# net.net2zone(cell_width=10, cell_height=10, unit="km")

# Synchronize geometry info between zone, node and poi
# if you want to save updated node, poi, zone without demand,
# you can skip net.run_gravity_model()
# and run net.save_results_to_csv(overwrite_file=True) directly
net.sync_geometry_between_zone_and_node_poi()

# Calculate demand by running gravity model
Expand Down
2 changes: 1 addition & 1 deletion grid2demand/utils_lib/net_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class POI:
poi_type: str = ''
trip_rate: dict = field(default_factory=dict)
geometry: str = ''
zone_id: int = 0
zone_id: int = -1

@property
def as_dict(self):
Expand Down

0 comments on commit 334ae07

Please sign in to comment.