Merge pull request #57 from Urban-Analytics-Technology-Platform/56-wr…

…ite-output-to-matsim-format

* Adds writing output to MATSim format (#56)

* Adds configurable output CRS (#72)

config/base.toml

@@ -1,9 +1,9 @@
 [parameters]
 seed = 0
-region = "leeds"  # this is used to query poi data from osm and to load in SPC data
-number_of_households = 5000  # how many people from the SPC do we want to run the model for? Comment out if you want to run the analysis on the entire SPC populaiton
-zone_id = "OA21CD" # "OA21CD": OA level, "MSOA11CD": MSOA level
-travel_times = true  # Only set to true if you have travel time matrix at the level specified in boundary_geography
+region = "leeds"            # this is used to query poi data from osm and to load in SPC data
+number_of_households = 5000 # how many people from the SPC do we want to run the model for? Comment out if you want to run the analysis on the entire SPC populaiton
+zone_id = "OA21CD"          # "OA21CD": OA level, "MSOA11CD": MSOA level
+travel_times = true         # Only set to true if you have travel time matrix at the level specified in boundary_geography
 boundary_geography = "OA"
 # NTS years to use
 nts_years = [2019, 2021, 2022]
@@ -16,10 +16,13 @@ nts_regions = [
     'West Midlands',
     'East of England',
     'South East',
-    'South West']
+    'South West',
+]
 # nts day of the week to use
 # 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday
 nts_day_of_week = 3
+# what crs do we want the output to be in? (just add the number, e.g. 3857)
+output_crs = 3857
 
 [matching]
 # for optional and required columns, see the [iterative_match_categorical](https://github.com/Urban-Analytics-Technology-Platform/acbm/blob/ca181c54d7484ebe44706ff4b43c26286b22aceb/src/acbm/matching.py#L110) function
@@ -35,12 +38,12 @@ optional_columns = [
 n_matches = 10 # What is the maximum number of NTS matches we want for each SPC household?
 
 [work_assignment]
-commute_level = "MSOA"
-use_percentages = true  # if true, optimization problem will try to minimize percentage difference at OD level (not absolute numbers). Recommended to set it to true
+commute_level = "OA"
+use_percentages = true # if true, optimization problem will try to minimize percentage difference at OD level (not absolute numbers). Recommended to set it to true
 # weights to add for each objective in the optimization problem
 weight_max_dev = 0.2
 weight_total_dev = 0.8
-max_zones = 8   # maximum number of feasible zones to include in the optimization problem (less zones makes problem smaller - so faster, but at the cost of a better solution)
+max_zones = 8          # maximum number of feasible zones to include in the optimization problem (less zones makes problem smaller - so faster, but at the cost of a better solution)
 
 [postprocessing]
 pam_jitter = 30

data/external/README.md

@@ -38,9 +38,9 @@ The structure of the folder is as follows:
 │   │   │           ├── trip_eul_2002-2022.tab
 │   │   │           └── <other_nts_tables>.tab
 |   |   └── travel_times
-|   |   │   │       ├── oa
+|   |   │   │       ├── OA
 |   |   │   │       |   ├── travel_time_matrix.parquet
-|   |   |   |       └── msoa
+|   |   |   |       └── MSOA
 |   |   │   │           └── travel_time_matrix.parquet
 │   │   ├── ODWP01EW_OA.zip
 │   │   ├── ODWP15EW_MSOA_v1.zip