bycycle.core/INSTALL at dev · bycycle-org/bycycle.core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
byCycle Core Installation
+++++++++++++++++++++++++

This document focuses on installation for development.

Packages
========

- Python 3.8
- PostgreSQL 12
- PostGIS 3
- GEOS
- Proj

Installation
============

- First, clone the repository using git:
  ``git clone git@github.com:bycycle-org/bycycle.core``
- Change into the ``bycycle.core`` directory
- If you've got ``make`` installed, ``make init` should do the trick
- If you don't have ``make``, the basic steps are:
  - Create a virtualenv
  - Install this package into the virtualenv
  - Create a PostGIS-enabled PostgreSQL database
  - Import USPS street suffixes
  - Get some OSM data and create a routing graph

PostgreSQL Configuration
========================

- Create bycycle user
- Create bycycle database owned by bycycle user
- Install PostGIS
- Create tables

Once the ``bycycle.core`` package is installed, the easiest way to do this is
to run ``run create-db create-schema``.

USPS Street Suffix Import
=========================

Once the ``bycycle.core`` package is installed, the easiest way to do this is
to run ``run load-usps-street-suffixes``.

OSM Data Import
===============

- Fetch data within a specified bounding box
- Import that OSM data into the database
- Create a routing graph from the imported OSM data

Once the ``bycycle.core`` package is installed, the easiest way to do this is
to run ``run fetch-osm-data load-osm-data create-graph``