Skip to content

Commit 6396d11

Browse files
committed
Updated README.md
1 parent 80c1069 commit 6396d11

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

Diff for: README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ This package provides helpful utilities for researchers to easily download and r
1818

1919
* [Installation](#installation)
2020
* [Quick start - A brief example of processing data of the "Greater London"](#quick-start)
21-
* [*1.* Download data](#download-data)
22-
* [*2.* Read/parse data](#read-parse-data)
23-
* [*2.1* .osm.pbf](#pbf-data)
24-
* [*2.2* .shp.zip / .shp](#shp-zip-data)
25-
* [*3.* Import and retrieve data with a PostgreSQL server](#import-retrieve-data)
26-
* [*3.1* Import the data to the database](#import-the-data-to-the-database)
27-
* [*3.2* Retrieve data from the database](#retrieve-data-from-the-database)
28-
* [*3.3* Import data of all subregions of a given (sub)region to the database](#import-data-of-all-subregions)
21+
* [1. Download data](#download-data)
22+
* [2. Read/parse data](#read-parse-data)
23+
* [2.1 .osm.pbf](#pbf-data)
24+
* [2.2 .shp.zip / .shp](#shp-zip-data)
25+
* [3. Import and retrieve data with a PostgreSQL server](#import-retrieve-data)
26+
* [3.1 Import the data to the database](#import-the-data-to-the-database)
27+
* [3.2 Retrieve data from the database](#retrieve-data-from-the-database)
28+
* [3.3 Import data of all subregions of a given (sub)region to the database](#import-data-of-all-subregions)
2929
* [Copyright & License](#footnote)
3030

3131
---
@@ -72,7 +72,7 @@ For a quick start, some examples are provided below, which demonstrate a few cor
7272

7373

7474

75-
### *1.* Download data <a name="download-data"></a>
75+
### 1. Download data <a name="download-data"></a>
7676

7777
To download the OSM data for a region (or rather, a subregion) of which the data extract is available, you need to specify the name of the region (e.g. "Greater London"):
7878

@@ -124,13 +124,13 @@ The *.pbf* data file will then be saved to the `download_dir` as specified.
124124

125125

126126

127-
### *2.* Read/parse data <a name="read-parse-data"></a>
127+
### 2. Read/parse data <a name="read-parse-data"></a>
128128

129129
The package can read/parse the OSM data extracts in both *.pbf* and *.shp.zip* (and *.shp*).
130130

131131

132132

133-
#### *2.1* .osm.pbf data <a name="pbf-data"></a>
133+
#### 2.1 .osm.pbf data <a name="pbf-data"></a>
134134

135135
Parsing the *.pbf* data relies mainly on [GDAL/OGR](https://pypi.org/project/GDAL/), using `read_osm_pbf()` function.
136136

@@ -169,7 +169,7 @@ If `update=False`, when you run `read_osm_pbf(subregion_name)` again, the functi
169169

170170

171171

172-
#### *2.2* .shp.zip / **.shp** data <a name="shp-zip-data"></a>
172+
#### 2.2 .shp.zip / **.shp** data <a name="shp-zip-data"></a>
173173

174174
You can read the *.shp.zip* and *.shp* file of the above `subregion_name` (i.e. 'London') by using `read_shp_zip()`, which relies mainly on [GeoPandas](http://geopandas.org/):
175175

@@ -219,7 +219,7 @@ print(default_fp_)
219219

220220

221221

222-
### *3.* Import and retrieve data with a PostgreSQL server <a name="import-retrieve-data"></a>
222+
### 3. Import and retrieve data with a PostgreSQL server <a name="import-retrieve-data"></a>
223223

224224
The package provides a class, named "OSM", which communicates with [PostgreSQL](https://www.postgresql.org/) server.
225225

@@ -243,7 +243,7 @@ If the database "osm_pbf_data_extracts" does not exist before the connection is
243243

244244

245245

246-
#### *3.1* Import the data to the database <a name="import-the-data-to-the-database"></a>
246+
#### 3.1 Import the data to the database <a name="import-the-data-to-the-database"></a>
247247

248248
To import `greater_london` (i.e. the parsed .pbf data of "London") to the database, "osm_pbf_data_extracts":
249249

@@ -257,7 +257,7 @@ Each element (i.e. layer) of `greater_london` will be stored in a different sche
257257

258258

259259

260-
#### *3.2* Retrieve data from the database <a name="retrieve-data-from-the-database"></a>
260+
#### 3.2 Retrieve data from the database <a name="retrieve-data-from-the-database"></a>
261261

262262
To retrieve the dumped data:
263263

@@ -291,7 +291,7 @@ london_lines_mul = osmdb.read_osm_pbf_data('london', 'lines', 'multilinestrings'
291291

292292

293293

294-
#### *3.3* Import data of all subregions of a given (sub)region to the database <a name="import-data-of-all-subregions"></a>
294+
#### 3.3 Import data of all subregions of a given (sub)region to the database <a name="import-data-of-all-subregions"></a>
295295

296296
Find all subregions (without sub-subregions) of a (sub)region. For example, to find [all subregions](https://download.geofabrik.de/central-america.html) of "Central America":
297297

0 commit comments

Comments
 (0)