Quantify and categorize city bike networks.
Administration tasks are being provided as convenience in a justfile
.
More information about Just can be find in their repository. The installation section of their documentation will guide you through the setup process.
Run just -l
to see the list of provided tasks.
- data: stores the shapefiles (not to be commited) to process
- docs: the Sphinx documentation of the project
- measure: project source code
- notebooks: notebooks relevant to the project
- results: stores the results of the operations
- tests: project unit tests
Measure uses Poetry as its project management tool. The installation section of their documentation will guide you through the setup process.
Setup the project:
poetry install
This will create or update the environment.
Then, place the shape files to process in the data
directory. For now, only
the files ending with neighborhood_ways.zip
will be detected. The shape files
must be retrieved from the bna site.
For instance, for the city of Austin, TX:
- Go to https://bna.peopleforbikes.org/#/places/02fa7cef-bfb9-494e-9ae9-cdbaeb15f11f/
- Click the "Download" button
- Click "Neighborhood Ways (shp)"
- Save it into the
data
directory
Finally, run the project to process the file(s):
poetry run python measure/main.py