Project

open_topo

0.0
The project is in a healthy, maintained state
A simple Ruby client for interacting with the Open Topography API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 0.11
~> 3.0
~> 1.1.1
~> 1.3
~> 0.9
~> 6.4

Runtime

>= 1.10
>= 0.9
>= 3.17
>= 2.14
 Project Readme

OpenTopo

CodeFactor


  • Installation
    • GDAL
  • Usage
  • Development and contributing
  • License
  • Code of Conduct

Installation

Install as usual gem:

gem "open_topo"

or

gem install open_topo

GDAL

ubuntu quick install with apt-get install gdal-bin

and check with gdalinfo --version or gdal_translate --version

in case of issues check:

Usage

Request an API key via myOpenTopo in the OpenTopography portal. Only #catalog endpoint not required api key

# init client with api key or just set env OPEN_TOPOGRAPHY_API_KEY
client = OpenTopo::Client.new(api_key)

client.globaldem(north:, south:, west:, east:) # => OpenTopo::DemFile
client.usgsdem(south:, north:, west:, east:) # => OpenTopo::DemFile
client.elevation(long:, lat:) # => OpenTopo::Point
client.catalog(west:, south: , east:, north:) # => [OpenTopo::Catalog]
client.catalog(polygon:) # => [OpenTopo::Catalog]

Development and contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/andrew-kh8/open_topo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Everyone interacting in the OpenTopo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

License

The gem is available as open source under the terms of the MIT License.