Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rgeo/rgeo-shapefile
RGeo component for reading ESRI shapefiles
https://github.com/rgeo/rgeo-shapefile
Last synced: 2 months ago
JSON representation
RGeo component for reading ESRI shapefiles
- Host: GitHub
- URL: https://github.com/rgeo/rgeo-shapefile
- Owner: rgeo
- License: bsd-3-clause
- Created: 2010-12-06T22:21:25.000Z (about 14 years ago)
- Default Branch: main
- Last Pushed: 2024-10-10T10:58:00.000Z (3 months ago)
- Last Synced: 2024-10-20T06:32:19.218Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 281 KB
- Stars: 97
- Watchers: 13
- Forks: 31
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE.txt
Awesome Lists containing this project
- -awesome-agriculture - rgeo-shapefile - RGeo Shapefile is an optional module for RGeo for reading geospatial data from ESRI shapefiles in Ruby. (Geospatial and GIS / Shapefiles)
README
# RGeo::Shapefile
[](http://badge.fury.io/rb/rgeo-shapefile)
[](https://github.com/rgeo/rgeo-shapefile/actions?query=workflow%3ACI+branch%3Amain+event%3Apush)
`RGeo::Shapefile` is an optional module for [RGeo](https://github.com/rgeo/rgeo)
for reading geospatial data from ESRI shapefiles.
## Summary
RGeo is a key component for writing location-aware applications in the
Ruby programming language. At its core is an implementation of the
industry standard OGC Simple Features Specification, which provides data
representations of geometric objects such as points, lines, and polygons,
along with a set of geometric analysis operations. See the README for the
`rgeo` gem for more information.
`RGeo::Shapefile` is an optional RGeo add-on module for reading geospatial
data from ESRI shapefiles. The shapefile format is a common file format
for geospatial data sets. It is specified in
[this ESRI whitepaper](http://www.esri.com/library/whitepapers/pdfs/shapefile.pdf).
Example:
```ruby
require 'rgeo/shapefile'
RGeo::Shapefile::Reader.open('myshpfil.shp') do |file|
puts "File contains #{file.num_records} records."
file.each do |record|
puts "Record number #{record.index}:"
puts " Geometry: #{record.geometry.as_text}"
puts " Attributes: #{record.attributes.inspect}"
end
# If using version 3.0.0 or earlier, rewind is necessary to return to the beginning of the file.
# file.rewind
record = file.next
puts "First record geometry was: #{record.geometry.as_text}"
end
```
### Skipping validity checks
If you have shapefiles that are failing [rgeo validity checks](https://github.com/rgeo/rgeo/blob/main/doc/Geometry-Validity.md) you can skip validity checks by passing `allow_unsafe: true` to the `RGeo::Shapefile::Reader#open` method:
```ruby
RGeo::Shapefile::Reader.open('myshpfil.shp', allow_unsafe: true) do |file|
# ...
end
```
## Install
`RGeo::Shapefile` has the following requirements:
* Ruby 2.4.0 or later
* rgeo 1.0.0 or later.
* dbf 4.0 or later.
If you need support for older Rubies, please use 2.x version
Include in your bundle:
```ruby
gem 'rgeo-shapefile'
```
Install `RGeo::Shapefile` as a gem:
```sh
gem install rgeo-shapefile
```
See the [`rgeo`](https://github.com/rgeo/rgeo) gem, a required dependency,
for further installation information.
If you are using Ruby 2.3, use version `2.0.x` of this gem.
If you are using Ruby 2.0-2.2, use version `1.0.x` of this gem.
If you are using Ruby 1.9, use version `0.3.x` of this gem.
If you are using Ruby 1.8, use version `0.2.x` of this gem.
## Development and support
Documentation is available at https://www.rubydoc.info/gems/rgeo-shapefile
Source code is hosted on Github at https://github.com/rgeo/rgeo-shapefile
Contributions are welcome. Fork the project on Github.
Report bugs on Github issues at https://github.com/rgeo/rgeo-shapefile/issues
## Acknowledgments
`rgeo-shapefile` was orginally written by Daniel Azuma (http://www.daniel-azuma.com).
Development is supported by:
* [Pirq](http://www.pirq.com)
* [Neighborland](https://neighborland.com)
Although we don't use shapelib (http://shapelib.maptools.org) to read
ESRI shapefiles, we did borrow a bunch of their test cases.
## License
Copyright Daniel Azuma, Tee Parham
https://github.com/rgeo/rgeo-shapefile/blob/main/LICENSE.txt