karannewatia/geowave

GeoWave provides geospatial and temporal indexing on top of Accumulo, HBase, BigTable, Cassandra, and DynamoDB

About

Continuous Integration	License	Chat

GeoWave is an open source set of software that:

• Capabilities
  • Adds multi-dimensional indexing capability to key-value stores (currently Apache Accumulo, Apache HBase, Apache Cassandra, AmazonDynamoDB, Cloud BigTable, Redis, RocksDB, and Apache Kudu)
  • Adds support for geographic objects and geospatial operators to these stores
  • Provides Map-Reduce input and output formats for distributed processing and analysis of geospatial data
• Geospatial software plugins
  • GeoServer plugin to allow geospatial data in various key-value stores to be shared and visualized via OGC standard services

Basically, GeoWave is working to bridge geospatial software with modern key-value stores and distributed compute systems.

The Docs

• Check out our GeoWave io page page for detailed documentation.
• A changelog is available which details the changes and features for each of our github releases
• The underlying principles employed in GeoWave are outlined in recent academic publications to include largely the background theory in Advances in Spatial and Temporal Databases 2017 and a derivative, more applied paper in FOSS4G Conference Proceedings 2017.

The Software

• We have multi-platform standalone installers for the GeoWave's commandline tools to help get started
  • This is often the quickest and easiest way to get started using GeoWave on your own machine
• We have a RPM repository
  • This contains various packages including puppet modules, best used for distributed environments.
  • See Documentation: Installation from RPM for more info.
• Maven artifacts are available on Maven Central
• And you can always build from source

Community

• Community support is available on chat and on our mailing list.

Getting Started

Programmatic Access

You can use maven to reference pre-built GeoWave artifacts with the following pom.xml snippet (replacing ${keyvalue-datastore} with your datastore of choice and ${geowave.version} with the geowave version you'd like to use):

	<dependencies>
		<dependency>
			<groupId>org.locationtech.geowave</groupId>
			<artifactId>geowave-datastore-${keyvalue-datastore}</artifactId>
			<version>${geowave.version}</version>
		</dependency>
		<dependency>
			<groupId>org.locationtech.geowave</groupId>
			<artifactId>geowave-adapter-vector</artifactId>
			<version>${geowave.version}</version>
		</dependency>
		<dependency>
			<groupId>org.locationtech.geowave</groupId>
			<artifactId>geowave-adapter-raster</artifactId>
			<version>${geowave.version}</version>
		</dependency>
	</dependencies>

Use the libraries available in the api package to leverage GeoWave's capabilities (where <data store options> might be AccumuloRequiredOptions or HBaseRequiredOptions and simple examples of creating the data type and index can be found in SimpleIngest within the examples directory):

DataStore store = DataStoreFactory.createDataStore(<data store options>);
store.addType(<my data type>, <my index>);
try(Writer writer = store.createWriter()){
  //write data
  writer.writer(<data);
}
 
//this just queries everything
try(CloseableIterator it = store.query(QueryBuilder.newBuilder().build())){
  while(it.hasNext()){
    //retrieve results matching query criteria and do something
    it.next();
  }
}

Commandline Access

Alternatively, you can always use the GeoWave commandline to access the same capabilities. Install the geowave-$VERSION-apache-tools RPM as instructed here. Then geowave store add ... and geowave index add ... are used to create named configurations for connecting to a key-value store (geowave store add) and describing how you want the data indexed (geowave index add). You can use --help at any time such as geowave store add --help or furthermore get additional help after specifying the type with -t such as geowave store add -t accumulo --help to understand accumulo specific parameters. Once you have the indexing and store specified you can use geowave ingest localtogw <file or directory> <store name> <index name(s)> to ingest data into the key-value store. For the most basic walkthrough with minimal setup, run through the quickstart guide locally using RocksDB.

Some GeoWave rendered eye candy

See Screenshots in the documentation for more information.

Supported versions of core libraries

We work to maintain a N and N-1 tested and supported version pace for the following core libraries.

Geoserver	Geotools	Accumulo	HBase	Hadoop	Java
2.14.x	20.x	[1.7.x,1.9.x]	[1.1.x,1.4.x]	2.x	Java8

• Apache Maven 3.x or greater is required for building
• See our .travis.yml file for the currently tested build matrix.

Origin

GeoWave was developed at the National Geospatial-Intelligence Agency (NGA) in collaboration with RadiantBlue Technologies (now Maxar Technologies) and Booz Allen Hamilton. The government has "unlimited rights" and is releasing this software to increase the impact of government investments by providing developers with the opportunity to take things in new directions. The software use, modification, and distribution rights are stipulated within the Apache 2.0 license.

Contributing

All pull request contributions to this project will be released under the Apache 2.0 or compatible license. Contributions are welcome and guidelines are provided here.

Did I mention our documentation!