For our main function growbikenet(), think about minimal interface/parameters, **kwargs, keeping in mind orders and optionalities for likely and possible future extensions. Doesn't have to be perfect, but we should at least try to not mess up too much for the future. See https://github.com/mszell/bikenwgrowth/blob/main/parameters/parameters.py etc
For example (potential future options in italic)
- either cityname : str, default "Copenhagen" or filename to a polygon? How to pass the info that a file should be loaded?
- ranking : {"betweenness_centrality", "closeness_centrality", "random", "flowdata", "flowfrompopulation"}, default "betweenness_centrality"
- seed_point_type : {"grid", "railstations", "triangular", "custom_file", "osmnx_custom_query"} - How to load custom multipoint file?
- seed_point_spacing : int, default 1707
- seed_point_delta : int, default 500
- export_plots : bool, default True
- export_video : bool, default False
- export_data : str_ Unclear yet how to implement
- export_path_viz : str?
- export_path_data : str?
- export_crs : str, default "3857"
- plotting-kwargs?
- osmnx-kwargs? For selecting existing bike infra for GrowBikeNetPlus, or for the osmnx_custom_query for selecting OSM POIs as seed points?
- data1 For weighting links in GrowBikeNetPlus
- data2 For weighting links in GrowBikeNetPlus
- alpha For weighting links in GrowBikeNetPlus
- triangulation : {"greedy", "delaunay"}, default "greedy"?
- ...
Some of these could also be part of the future lib (for data/viz export). Probably plotting and osmnx kwargs should be read in from config files instead of as direct parameters.
For our main function growbikenet(), think about minimal interface/parameters, **kwargs, keeping in mind orders and optionalities for likely and possible future extensions. Doesn't have to be perfect, but we should at least try to not mess up too much for the future. See https://github.com/mszell/bikenwgrowth/blob/main/parameters/parameters.py etc
For example (potential future options in italic)
Some of these could also be part of the future lib (for data/viz export). Probably plotting and osmnx kwargs should be read in from config files instead of as direct parameters.