Skip to content

thp-comnets/zyxt

Repository files navigation

#Zyxt - WISP Planning Tool

How to run Zyxt

Resources Required

Before getting started:

  • .csv file containing the locations of customer
  • Format of the customer input file: lat,lng,demand,revenue_from_customer
  • .csv file containing the source (only one supported at the moment)
  • Format of the source input file: lat,lng
You can find some exmaples in /customerNodes directory

There are two scripts available to process your map.

  • processMapsWithRescaling.py (Generally for big maps)
  • processMapWithOriginalResolution.py
Parameteres required to run processMapsWithProportionalReScaling.py
  1. Customer Input File Name
  2. Source Input File Name
  3. Size, you want to rescale the input map.
  4. Node Removal Algorithm c => Clustering Removal r => Random Removal e => Elevation Removal n => No removal
  5. Removal % if removal algorithm is applied
  6. Solver Algorithm fcnf for Fixed-Charge Network Flow mcf for ** Min Cost Flow With Randomized Rounding Technique**
  7. Absolute path of directory where you download zyxt code.
  8. Mounting Height for towers
  9. Absolute path of text file containing comma seprated node pair representing pinned edges i.e already existing edges.
  10. Absolute path of selected equipment file.

Example:

python processMapsWithRescaling.py mapA_sinks.csv mapA_source.csv 400 n 0 mcf /path/of/zyxt 10 /path/of/pinnedEdges /path/of/equipmentsFile
Parameteres required to run processMapWithOriginalResolution.py
  1. Customer Input File Name
  2. Source Input File Name
  3. Node Removal Algorithm c => Clustering Removal r => Random Removal e => Elevation Removal n => No removal
  4. Removal % if removal algorithm is applied
  5. Solver Algorithm fcnf for Fixed-Charge Network Flow mcf for ** Min Cost Flow With Randomized Rounding Technique**
  6. Absolute path of directory where you download zyxt code.
  7. Mounting Height for towers
  8. Text file containing comma seprated node pair representing pinned edges i.e already existing edges.
  9. Absolute path of selected equipment file.

Example:

python processMapsWithRescaling.py mapA_sinks.csv mapA_source.csv n 0 mcf /path/of/zyxt 10 /path/of/pinnedEdges /path/of/equipmentsFile

Please make sure to put the customer and source input file in /customerNodes directory