config_template.json

{
	"FILES": {
		"DEMAND_GEO": {
			"FILE":"ENTER FILE PATH TO DEMAND GEOGRAPHIC BOUNDARY SHAPEFILE",
			"TYPE":"shape",
			"CRS": "3347",
			"COLUMNS": {
				"ID" : {
					"NAME": "ENTER DEMAND GEOGRAPHIC BOUNDARY ID VARIABLE NAME",
					"TYPE": "geouid",
					"UNIT": "ENTER DATA TYPE (E.G., int)",
					"DESC": "ID"
						},
				"GEOMETRY": {
					"NAME": "geometry",
					"TYPE": "geometry",
					"UNIT": "geometry", 
					"DESC": "geometry"
						}
				}
			},
		"DEMAND_POP": {
			"FILE":"ENTER FILE PATH TO THE DEMAND GEOGRAPHIC BOUNDARY SHAPEFILES' POPULATION CSV",
			"TYPE":"demand",
			"ENCODING":"latin-1",
			"COLUMNS": {
				"ID": {
					"NAME":"ENTER DEMAND GEOGRAPHIC BOUNDARY ID VARIABLE NAME",
					"TYPE":"geouid",
					"UNIT": "ENTER DATA TYPE (E.G., int)",
					"DESC": "ID"
					},
				"DEMAND_ENTER WORD THAT DESCRIBES POPULATION DEMAND VARIABLE OF INTEREST": {
					"NAME": "ENTER THE VARIABLE NAME",
					"TYPE": "ENTER HOW YOU WANT THE VARIABLE NAME TO APPEAR ON THE UI",
					"UNIT": "ENTER DATA TYPE", 
					"DESC": "demand"
				  }
			}
		},
    "DEMAND_GEO_WEIGHT": {
      "FILE": "ENTER FILE PATH TO A MORE GRANULAR DEMAND GEOGRAPHIC BOUNDARY SHAPEFILES. THIIS FILE IS OPTIONAL. REMOVE THIS ENTIRE OBJECT IF NOT NEEDED",
      "TYPE": "shape",
      "CRS": "3347",
      "COLUMNS": {
        "ID" : {
          "NAME": "ENTER SMALLER DEMAND GEOGRAPHIC BOUNDARY ID VARIABLE NAME",
          "TYPE": "geouid",
          "UNIT": "int"},
        "LRG_ID" : {
          "NAME": "ENTER DEMAND GEOGRAPHIC BOUNDARY ID VARIABLE NAME",
          "TYPE": "lrg_id",
          "UNIT": "int"},
				"DEMAND_TOTAL": {
					"NAME":"ENTER VARIABLE NAME TO THAT REPRESENT THE DESIRED POPULATION TO CALCULATE WEIGHTED CENTROIDS",
					"TYPE": "pop_Total",
					"UNIT": "int", 
					"DESC": "demand"
				},
        "GEOMETRY": {
          "NAME": "geometry",
          "TYPE": "geometry",
          "UNIT": "geometry"
          }
        }
    },
		"POI": {
			"FILE":"ENTER FILE PATH TO THE SUPPLY CSV",
			"TYPE":"supply",
			"ENCODING":"latin-1",
			"CRS":"4326",
			"COLUMNS": {
				"ID": {
					"NAME":"ENTER SUPPLY ID VARIABLE NAME",
					"TYPE":"geouid",
					"UNIT": "ENTER DATA TYPE", 
					"DESC": "ID"
					},
				"LATITUDE" : {
					"NAME":"ENTER LATITUDE VARIABLE NAME",
					"TYPE":"latitude",
					"UNIT": "ENTER DATA TYPE OF LATITUDE (E.G., float)", 
					"DESC": "geometry"
				},
				"LONGITUDE" : {
					"NAME":"ENTER LONGITUDE VARIABLE NAME",
					"TYPE":"longitude",
					"UNIT": "ENTER DATA TYPE OF LONGITUDE (E.G., float)", 
					"DESC": "geometry"
				},
				"LRG_ID" : {
					"NAME":"DISCUSS WITH CHELSEA",
					"TYPE":"lrg_id",
					"UNIT": "str", 
					"DESC": "ID"
				},
				"ENTER DESCRIPTIVE WORD OF VARIALBLE TO INCLUDE IN DATABASE TABLE": {
					"NAME":"ENTER VARIABLE NAME",
					"TYPE": "ENTER HOW YOU WANT THE VARIABLE NAME TO APPEAR ON THE UI",
					"UNIT": "ENTER DATA TYPE OF VARIABLE", 
					"DESC": "info"
				},
				"SUPPLY_ENTER DESCRIPTIVE WORD OF VARIABLE TO INCLUDE IN DATABASE TO REPRESENT SUPPLY": {
					"NAME": "ENTER VARIABLE NAME",
					"TYPE": "ENTER HOW YOU WANT THE VARIABLE NAME TO APPEAR ON THE UI",
					"UNIT": "ENTER DATA TYPE OF VARIABLE", 
					"DESC": "supply"
				},
				"CAPACITY_ENTER DESCRIPTIVE WORD OF VARIABLE TO INCLUDES IN DATABASE TO RERESENT CAPACITY": {
					"NAME": "ENTER VARIABLE NAME",
					"TYPE": "ENTER HOW YOU WANT THE VARIABLE NAME TO APPEAR ON THE UI",
					"UNIT": "ENTER DATA TYPE OF VARIABLE", 
					"DESC": "capacity"
				}
			}
		}
	},
	"ORS": {
		"CONNECTION": {
			"CLIENT_URL": "http://[ENTER HOST]:[ENTER PORT]/ors",
			"TIMEOUT": 500
		},
		"ISOCHRONES": {
			"CATCHMENT_RANGE": 3600,
			"CATCHMENT_RANGE_TYPE": "time",
			"PROFILE": "driving-car",
			"SLEEP_TIME": 0
		},
		"DISTANCE_MATRIX": {
			"METRIC": "distance",
			"UNIT": "m" ,
			"SLEEP_TIME": 0
		}
	},
	"DB": {
		"HOST": "ENTER DATABASE HOST",
		"PORT": "ENTER DATABASE PORT",
		"NAME": "ENTER DATABASE NAME",
		"PASSWORD": "ENTER DATABASE PASSWORD",
		"USER": "ENTER DATABASE USER"
	},
	"APP": {
		"SECRET_KEY": "ENTER APP SECRET KEY",
		"HOST": "ENTER APP HOST",
		"PORT": "ENTER APP KEY",
		"THREADS": 4
	},
	"LOGGER": {
		"DEFAULT_LEVEL": "debug",
		"FILE": "ENTER true OR false TO SAVE LOG AS FILE",
		"FILE_PATH": "ENTER A PATH AND FILE NAME (E.G., pass.log) TO SAVE FILE IN (IF FILE IS true)"
	},
	"BASEMAP": {
		"TOKEN": "ENTER API KEY TO BASEMAP. CURRENT URL IN map.js DEPENDS ON MAPBOX API KEY. CHANGE tiles VAR IF WANTING DIFFERENT PROVIDOR"
	},
	"HTML": {
		"META": {
			"TITLE": "PASS",
			"DESCRIPTION": "Potential Accessibility Software Service (PASS), a geographic information system that offers a quantitative approach to measure how spatially accessible population demand is to a given in-person service."
		},
		"NAVBAR": {
			"LOGO": "ENTER LOGO TO APPEAR ON TOP-LEFT NAVBAR",
			"BTNS": [
				{
					"NAME": "ENTER NAME A NAVBAR BTN NAME (E.G., Help)",
					"TITLE": "ENTER A HEADER THAT WILL APPEAR AT THE TOP OF THIS NAVBAR MODAL VIEW",
					"SECTIONS": [
						{
							"HEADER": "ENTER A HEADER THAT WILL APPEAR WITHIN THE BODY OF THE NAVBAR MODAL",
							"CONTENT": [
								{
									"P": "ENTER TEXT THAT WILL APPEAR IN A PARAGRAPH",
									"P": "..."
								}
							]
						},
						{
							"HEADER": "...",
							"CONTENT": [
								{
									"P": "..."
								}
							]
						}
					]
				}
			]
		},
		"MENU": {
			"NAME": "ENTER ANOTHER TERM FOR MENU FOR BTN WHEN TOGGLING MENU",
			"DESC": "ENTER DESCRIPTION OF TOOL THAT WILL APPEAR IN THE MENU",
			"PARAMS": [
				{
					"ID": "transportation",
					"LABEL": "Mode of transportation",
					"TOOLTIP": "Select the commute method.",
					"SELECT": [
						{
							"OPTION": "Car",
							"VALUE": "car"
						},
						{
							"OPTION": "Public Transit",
							"VALUE": "transit"
						}
					]
				},
				{
					"ID": "beta",
					"LABEL": "Willingness to Commute",
					"TOOLTIP": "Select how willing clients are to travel further distance.",
					"SELECT": [
						{
							"OPTION": "Less",
							"VALUE": "1.5"
						},
						{
							"OPTION": "Medium",
							"VALUE": "1.0"
						},
						{
							"OPTION": "More",
							"VALUE": "0.5"
						}
					]
				},
				{
					"ID": "demand",
					"LABEL": "Population Group",
					"TOOLTIP": "Select the variable to represent the population demand."
				},
				{
					"ID": "supply",
					"LABEL": "POI Supply",
					"TOOLTIP": "Select the variable to represent the supply of the service locations (POIs) that meets the demand."
				},
				{
					"ID": "capacity",
					"LABEL": "POI Capacity",
					"TOOLTIP": "Select the variable to represent the capacity of the service locations (POIs) that would influences the likelihood of demand going to the POI."
				},
				{
					"ID": "threshold",
					"LABEL": "Distance Travel Threshold: ",
					"TOOLTIP": "Select the max distance clients are willing to travel to the service. Consider mode of transportation."
				}
			],
			"SUBMIT": "ENTER TEXT TO APPEAR IN THE BUTTON THAT RUNS THE MODEL"
		}
	}
}