Using the degauss/geocoder image allows the user to
bypass this manual installation. Below are the manual instructions as an
alternative to degauss/geocoder.
This software was designed and tested on Linux Ubuntu. The following install instructions are for Ubuntu. CentOS install instructions are also below, but are not throughly tested.
Install required software:
sudo apt-get install sqlite3 libsqlite3-dev flex ruby-full ruby-rubyforge libssl-dev libssh2-1-dev libcurl4-openssl-dev curl libxml2-devInstall ruby gems:
sudo gem install sqlite3
sudo gem install json
sudo gem install TextInstall R:
sudo sh -c 'echo "deb http://cran.rstudio.com/bin/linux/ubuntu trusty/" >> /etc/apt/sources.list'
sudo apt-get update
sudo apt-get install r-base-core
sudo sh -c 'echo "deb http://mirrors.ocf.berkeley.edu/ubuntu/ trusty-backports main restricted universe" >> /etc/apt/sources.list'
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E084DAB9
sudo apt-get update
sudo apt-get install r-base-devInstall R packages:
sudo su - -c "R -e \"install.packages('devtools', repos='https://cran.rstudio.com/')\""
sudo su - -c "R -e \"devtools::install_github('cole-brokamp/CB')\""
sudo su - -c "R -e \"install.packages('argparser', repos='https://cran.rstudio.com/')\""Download the git repo to the home directory and then compile the SQLite3 extension and the Geocoder-US Ruby gem:
cd ~
git clone https://github.com/degauss-org/geocoder
cd geocoder
sudo make -f Makefile.ruby install
sudo gem install Geocoder-US-2.0.4.gemThe program relies on a sqlite3 database created from TIGER/Line
files that is about 4.6 GB. Download the compiled database based on 2015
TIGER/Line files into the /opt directory so it is
accessible by all users.
sudo wget https://colebrokamp-dropbox.s3.amazonaws.com/geocoder.db -P /optAlternatively, build your own database (see the section below for details).
The program takes in one character string and parses address components in order to search the database. To geocode an address, call ruby to run the program with the address string as the argument:
ruby ~/geocoder/bin/geocode.rb "3333 Burnet Ave Cincinnati Ohio 45229"This results in a file called temp.json being written to
the current directory with the results. It is possible to pipe this
output into another file, but the user will likely be geocoding more
than one file at a time, using batch geocoding.
The geocode.R program uses the argparser
package to take in command line arguments which define both the name of
the CSV file and name of the column in that file which contain the
address strings.
For batch geocoding, run geocoder/bin/geocode.R, which
relies on Rscript to run the R program from the command
line with arguments. The R program serves as a wrapper to read the file,
iterate over the address strings, output a progress bar, and write the
results file as a CSV.
The first argument defines the name of the CSV file and the second argument defines the name of the column in that file which contains the address strings.
Don’t forget to chmod this file and optionally, symmlink
it somewhere (ln -s ~/geocoder/bin/geocode.R ~/geocode.R)
or add it to your path. Run the program without any arguments for
help:
> ./geocode.R
usage: ./geocode.R [--] [--help] file_name column_name
offline geocoding, returns the input file with geocodes appended
positional arguments:
file_name name of input csv file
column_name the name of the column in the csv file that contains the address strings
flags:
-h, --help show this help message and exitTest the the program out on some sample addresses that are included in the git repo:
bin/geocode.R test_addresses.csv addressThe program will output a progress bar to the terminal. The output
will be merged to the original input file and written as a CSV file with
_geocoded appended to the end of the file name. Address
fields not used for an address string will be NA.
Although a compiled database created from 2015 TIGER/Line files is available for download, it is possible to create your own database using alternative years for example.
mkdir TIGER2015 && cd TIGER2015
wget -nd -r -A.zip ftp://ftp2.census.gov/geo/tiger/TIGER2015/ADDR/
wget -nd -r -A.zip ftp://ftp2.census.gov/geo/tiger/TIGER2015/FEATNAMES/
wget -nd -r -A.zip ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/If the download fails, rerun with -c option to continue
where it left off.
sudo build/tiger_import /opt/geocoder.db TIGER2015After making the database, it is safe to remove all of the TIGER files
rm -r TIGER2015Create ruby metaphones
sudo bin/rebuild_metaphones /opt/geocoder.dbConstruct database indexes
sudo chmod +x build/build_indexes
sudo build/build_indexes /opt/geocoder.dbCluster the database accorindg to indexes, making lookups faster
sudo chmod +x build/rebuild_cluster
sudo build/rebuild_cluster /opt/geocoder.dbBefore installation (all takes place under sudo)
sudo su -Install software dependencies:
yum install -y sqlite sqlite-devel.x86_64 flex ruby git-core zlib zlib-devel gcc-c++ patch readline readline-devel libyaml-devel libffi-devel openssl-devel make bzip2 autoconf automake libtool bison curl sqlite-devel libcurl-devel libxml2-devel.x86_64 ruby-rdoc ruby-develInstall Ruby gems:
gem install sqlite3 json TextInstall R:
rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
yum update
yum install ROpen R:
R --vanillaWithin R, install packages:
install.packages(c('devtools','argparser'),repos='https://cran.rstudio.com')
devtools::install_github('cole-brokamp/CB')Download the git repo to the home directory and then compile the SQLite3 extension and the Geocoder-US Ruby gem:
cd ~
git clone https://github.com/cole-brokamp/geocoder
cd geocoder
sudo make install
sudo gem install Geocoder-US-2.0.4.gemMake sure to install the database as described above.