Update README.md

This commit is contained in:
Carla
2015-06-24 18:08:24 +02:00
parent 6f4f65a7c1
commit ac717e4e3d

View File

@@ -1,17 +1,19 @@
Postal code geocoder (polygons)
Postal code geocoder
===============
### Function
This section is divided in geocoding postal codes as points or as polygons. Each option has its own sources and its own functions which are described below.
# Polygons
## Function
By following the next steps a table is populated with zipcodes from Australia, Canada, USA and France (identified by iso3) related with their spatial location in terms of polygons.
### Creation steps
## Creation steps
1. Import the four files attached in the section "Datasources".
2. Run sql/build_data_table.sql. Notice that table "postal_code_polygons" should exist in advance with columns: _the_geom_, _adm0_a3_ and _postal_code_.
### Data Sources
## Data Sources
Australian polygons - http://www.abs.gov.au/AUSSTATS/abs@.nsf/DetailsPage/2033.0.55.0012011?OpenDocument
Download the KMZ for *Postal Area IRSD, SEIFA 2011*. Unzip and upload the kmz
@@ -24,7 +26,7 @@ USA polygons - http://www2.census.gov/geo/tiger/TIGER2013/ZCTA5/tl_2013_us_zcta5
French polygons - http://www.data.gouv.fr/dataset/fond-de-carte-des-codes-postaux
### Preparation details
## Preparation details
The names of the imported files are:
@@ -33,9 +35,9 @@ The names of the imported files are:
- tl_2013_us_zcta510 for USA table
- codes_postaux for France table
# Postal code geocoder (points)
# Postal code geocoder: Points
### Function
## Function
By following the next steps a table is populated with zipcodes of different countries (identified by iso3) related with their spatial location in terms of points.
@@ -48,7 +50,7 @@ IT, LU, SK, LI, PR, IM, NO, PT, PL, FI, JP, CA, DE, HU, PH, SE, VA, YT, MK, FR,
MH, RO, FO, GF, AD, HR, DZ, GT, AU, AS, BE, AT
````
### Creation steps
## Creation steps
1. Download the allCountries.zip file from [GeoNames](www.geonames.org). Import and rename the table as tmp_zipcode_points. You can follow the manual process explained below instead.
@@ -72,12 +74,17 @@ In the first row, add the following columns: iso2, zipcode, lat, long.
Import the file ignoring step 2.
### Data Sources
## Data Sources
All countries points [GeoNames](www.geonames.org) - http://download.geonames.org/export/zip/allCountries.zip
### Preparation details
## Preparation details
_The big size of the dataset may cause interruptions in the processing of the coordinates after uploading the file, manipulating the file before importing is a faster workaround._
# Known issues:
* The name of the countries added in a column are not being sanitized https://github.com/CartoDB/cartodb/issues/3392
# Historic:
* [24/06/2015]:
* Updated readme.md: added information about tables, function, indexes and the known issues section.