Geocoder::US 2.0 技术文档

1. 安装指南

1.1 系统要求

• 编译工具: gcc/g++, make, bash 或等效工具。
• 解压工具: unzip。
• SQLite 3: 需要 SQLite 3 的可执行文件和开发文件。
• Ruby: 需要 Ruby 环境。
• Ruby Gems: 需要安装 Text 和 fastercsv gem。
• SQLite3-Ruby Gem: 需要一个支持加载扩展模块的 sqlite3-ruby gem，可以从 GitHub 获取。

1.2 安装步骤

1. 下载源码: 从项目仓库下载 Geocoder::US 2.0 的源码。
2. 编译: 解压源码后，进入源码目录，运行 make 命令进行编译。
3. 安装: 运行 make install 以系统范围安装 gem。

2. 项目使用说明

2.1 基本使用

Geocoder::US 2.0 是一个用于地理编码美国街道地址的软件包。它主要用于与美国人口普查局的免费 TIGER/Line 数据集一起使用，但也支持其他来源的美国街道地址范围数据。

2.2 示例代码

require 'geocoder/us'
db = Geocoder::US::Database.new("/opt/tiger/geocoder.db")
p db.geocode("1600 Pennsylvania Av, Washington DC")

2.3 Web 服务

项目包含一个示例 Web 服务，位于 lib/geocoder/rest.rb。运行该服务需要 Sinatra 和设置 GEOCODER_DB 环境变量。

GEOCODER_DB=/path/to/geocoder/geocoder.db ruby /path/to/gem/geocoder/lib/geocoder/us/rest.rb

然后可以通过以下 URL 查询 GeoCommons 地理编码器：

http://localhost:9393/geocode.html?q=303+11th St NE,Washington,DC

3. 项目API使用文档

3.1 初始化数据库

db = Geocoder::US::Database.new("/opt/tiger/geocoder.db", options)

3.2 地理编码

result = db.geocode("1600 Pennsylvania Av, Washington DC")

3.3 可选参数

• dbtype: 数据库几何块编码格式。
• debug: 调试模式。
• cache: SQLite 缓存大小，单位为 KB。

4. 项目安装方式

4.1 源码编译

1. 解压源码: 解压下载的源码包。
2. 编译: 进入源码目录，运行 make 命令。
3. 安装: 运行 make install 以系统范围安装 gem。

4.2 生成数据库

1. 导入 TIGER/Line 数据: 运行 build/tiger_import 命令导入数据。
2. 构建索引: 运行 build/build_indexes 命令构建数据库索引。
3. 集群数据库表（可选）: 运行 build/rebuild_cluster 命令集群数据库表。

4.3 运行单元测试

ruby tests/run.rb

如果有数据库，可以运行：

ruby tests/run.rb /opt/tiger/geocoder.db

通过以上步骤，您可以成功安装并使用 Geocoder::US 2.0 项目。