Skip to content

Commit 9de3ec1

Browse files
committed
Cleaned up README + docs
1 parent 4548763 commit 9de3ec1

2 files changed

Lines changed: 115 additions & 109 deletions

File tree

README.md

Lines changed: 52 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,45 @@
11
# GeoWave 0.8.5
22
## About
33

4-
<a href="https://travis-ci.org/ngageoint/geowave">
5-
<img alt="Travis-CI test status"
6-
src="https://travis-ci.org/ngageoint/geowave.svg?branch=master"/>
7-
</a>
8-
<br/>
9-
<a href="https://scan.coverity.com/projects/3371">
10-
<img alt="Coverity Scan Build Status"
11-
src="https://scan.coverity.com/projects/3371/badge.svg"/>
12-
</a>
13-
14-
<a href='https://coveralls.io/r/ngageoint/?branch=master'>
15-
<img src='https://coveralls.io/repos/ngageoint/geowave/badge.png?branch=master'
16-
alt='Coverage Status' />
17-
</a>
18-
19-
4+
| Integration Server | Code Coverage | Static Analysis | Chat |
5+
|:------------------:|:-------------:|:---------------:|:----:|
6+
| <a href="https://travis-ci.org/ngageoint/geowave"><img alt="Travis-CI test status" src="https://travis-ci.org/ngageoint/geowave.svg?branch=master"/></a> | <a href='https://coveralls.io/r/ngageoint/?branch=master'><img src='https://coveralls.io/repos/ngageoint/geowave/badge.png?branch=master' alt='Coverage Status' /></a> | <a href="https://scan.coverity.com/projects/3371"><img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/3371/badge.svg"/></a> | [![Join the chat at https://gitter.im/ngageoint/geowave](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ngageoint/geowave?utm_source=badge&utm_medium=badge&utm_content=badge) |
207

218
GeoWave is an open source set of software that:
229

23-
* Adds multi-dimensional indexing capability to [Apache Accumulo](https://accumulo.apache.org)
24-
* Adds support for geographic objects and geospatial operators to [Apache Accumulo](https://accumulo.apache.org)
25-
* Contains a [GeoServer](http://geoserver.org/) plugin to allow geospatial data in Accumulo to be shared and visualized via OGC standard services
26-
* Provides Map-Reduce input and output formats for distributed processing and analysis of geospatial data
27-
28-
Basically, GeoWave attempts to do for Accumulo as PostGIS does for PostgreSQL.
29-
30-
See [GeoWave io page](http://ngageoint.github.io/geowave/) for more detailed documentation, quickstart, examples, etc.
31-
32-
[GeoWave](https://wiki.eclipse.org/Google_Summer_of_Code_2015_Ideas) is on the project list for the [Google Summer of Code](https://www.google-melange.com/gsoc/homepage/google/gsoc2015).
33-
34-
## Screenshots
10+
* Capabilities
11+
* Adds multi-dimensional indexing capability to [Apache Accumulo](https://accumulo.apache.org)
12+
* Adds support for geographic objects and geospatial operators to [Apache Accumulo](https://accumulo.apache.org)
13+
* Provides Map-Reduce input and output formats for distributed processing and analysis of geospatial data
14+
* Geospatial software plugins
15+
* [GeoServer](http://geoserver.org/) plugin to allow geospatial data in Accumulo to be shared and visualized via OGC standard services
16+
* [PDAL](http://www.pdal.io/) plugin for working with point cloud data
17+
* [Mapnik](http://mapnik.org/) plugin for generating map tiles and generally making good looking maps.
18+
19+
Basically, GeoWave is working to bridge geospatial software with distributed compute systems.
20+
21+
## The Docs
22+
* Check out our [GeoWave io page](http://ngageoint.github.io/geowave/) page for detailed documentation.
23+
* A [changelog is available](http://ngageoint.github.io/geowave/changelog.html) which detailes the changes and features for each of our [github releases](https://github.com/ngageoint/geowave/releases)
24+
25+
## The Software
26+
* We have a [RPM repository](http://s3.amazonaws.com/geowave-rpms/index.html)
27+
* See [Documentation: Installation from RPM](http://ngageoint.github.io/geowave/documentation.html#installation-from-rpm) for more info.
28+
* Deb packages if enough people request them
29+
* We have [Maven artifact repositories](http://ngageoint.github.io/geowave/documentation.html#maven-repositories) (indexes not enabled, but it works in a maven repo fragment)
30+
* Releases: http://geowave-maven.s3-website-us-east-1.amazonaws.com/release
31+
* Snapshots: http://geowave-maven.s3-website-us-east-1.amazonaws.com/snapshot (nightly)
32+
* We have a [vagrant dev environment](https://github.com/ngageoint/geowave/tree/master/vagrant)
33+
* We have a development all in one RPM package: "geowave-repo-dev"
34+
* And you can always [build from source](http://ngageoint.github.io/geowave/documentation.html#installation-from-source)
35+
36+
37+
## Community
38+
39+
* [GeoWave](https://wiki.eclipse.org/Google_Summer_of_Code_2015_Ideas) is on the project list for the [Google Summer of Code](https://www.google-melange.com/gsoc/homepage/google/gsoc2015).
40+
* Geowave is currently in the process of moving to a permanent home under [LocationTech and the Eclipse Foundation](https://locationtech.org/proposals/geowave)
41+
42+
## Some GeoWave rendered eye candy
3543

3644
<p align="center">
3745
<a href="https://raw.githubusercontent.com/ngageoint/geowave/master/docs/content/images/geolife-density-13.jpg" target="_blank"><img align="center" src="https://raw.githubusercontent.com/ngageoint/geowave/master/docs/content/images/geolife-density-13-thumb.jpg" alt="Geolife data at city scale"></a><br/><br/>
@@ -40,97 +48,32 @@ See [GeoWave io page](http://ngageoint.github.io/geowave/) for more detailed doc
4048

4149
</p>
4250

43-
See [Screenshots](http://ngageoint.github.io/geowave/documentation.html#screenshots-2) for more information.
44-
45-
## Origin
46-
47-
GeoWave was developed at the National Geospatial-Intelligence Agency (NGA) in collaboration with [RadiantBlue Technologies](http://www.radiantblue.com/) and [Booz Allen Hamilton](http://www.boozallen.com/). The government has ["unlimited rights"](https://github.com/ngageoint/geowave/blob/master/NOTICE) 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](http://www.apache.org/licenses/LICENSE-2.0.html) license.
48-
49-
50-
## Pull Requests
51-
52-
All pull request contributions to this project will be released under the Apache 2.0 license.
53-
54-
Software source code previously released under an open source license and then modified by NGA staff is considered a "joint work" (see *17 USC  101*); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open source license.
55-
56-
##In the News###
57-
[Federal IT Innovation Depends On Being Open](http://www.informationweek.com/government/open-government/federal-it-innovation-depends-on-being-open/a/d-id/1297521), Information Week, 7/24/2014 mentions GeoWave.
58-
59-
## *Ultra* Quickstart
60-
61-
### Dependencies: Software and Versions
62-
This *ultra* quickstart assumes you have [Apache Maven](http://maven.apache.org/), [Git](http://git-scm.com/), and [Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (>= 1.7) installed on your system and on the path.
63-
64-
To view the data (via standard [OGC](http://www.opengeospatial.org/) services) a [GeoServer](http://geoserver.org/) instance >= 2.5 is required due to [GEOT-4587](http://jira.codehaus.org/browse/GEOT-4587).
65-
[GeoServer](http://geoserver.org/) 2.5.2 with [Geotools](http://www.geotools.org/) 11.2 the most tested version.
66-
67-
[Apache Accumulo](https://accumulo.apache.org) version 1.5 or greater is required. 1.5.0, 1.5.1, and 1.6.0 have all been tested.
68-
69-
[Apache Hadoop](http://hadoop.apache.org/) versions 1.x and 2.x *should* all work. The software has specifically been run on [Cloudera](http://cloudera.com/content/cloudera/en/home.html) CDH4 and [Hortonworks Data Platform](http://hortonworks.com/hdp/) 2.1.
51+
See [Screenshots](http://ngageoint.github.io/geowave/documentation.html#screenshots-2) in the documentation for more information.
7052

71-
MapReduce v2 + YARN is the currently preferred MR implementation / scheduler.
53+
## Supported versions of core libraries
7254

73-
[Java Advanced Imaging](http://download.java.net/media/jai/builds/release/1_1_3/) and [Java Image I/O](http://download.java.net/media/jai-imageio/builds/release/1.1/) are also both required to be installed on the GeoServer instance(s) *as well* as on the Accumulo nodes. The Accumulo support is only required for certain functions (distributed rendering) - so this may be skipped in some cases.
55+
We work to maintain a N and N-1 tested and supported version pace for the following core libraries.
7456

75-
### Building: Maven!
57+
| Geoserver | Geotools | Accumulo | Hadoop | PDAL | Mapnik | Java |
58+
|:---------:|:--------:|:--------:|:------:|:----:|:------:|:----:|
59+
| 2.5.x, 2.6.x | 11.x, 12.x | 1.5.x, 1.6.x | 2.x | 0.9.9 | 2.2.0 | Java7, Java8 |
7660

77-
Since GeoWave isn't currently in maven central we will build and install a local copy
61+
* [Apache Maven](http://maven.apache.org/) 3.x or greater is required for building
62+
* [Java Advanced Imaging](http://download.java.net/media/jai/builds/release/1_1_3/) and [Java Image I/O](http://download.java.net/media/jai-imageio/builds/release/1.1/) should both be installed on geoserver (license prohibits us redistributing)
63+
* See our [.travis.yml](https://github.com/ngageoint/geowave/blob/master/.travis.yml) file for the currently tested build matrix.
7864

79-
$ git clone git@github.com:ngageoint/geowave.git
80-
$ cd geowave && mvn install
8165

8266

83-
### Deploy: GeoServer
84-
85-
First we need to build the geoserver plugin - from the geowave root directory:
86-
87-
$ cd geowave-deploy
88-
$ mvn package -P geotools-container-singlejar
89-
90-
let's assume you have geoserver deployed in a tomcat container in /opt/tomcat
91-
92-
$ cp target/geowave-deploy-0.8.5-geoserver-singlejar.jar /opt/tomcat/webapps/geoserver/WEB-INF/lib/
93-
94-
and re-start tomcat
95-
96-
### Deploy: Accumulo
97-
98-
This should be very familiar by now; from the geowave root directory:
99-
100-
$ cd geowave-deploy
101-
$ mvn package -P accumulo-container-singlejar
102-
103-
This distributable needs to be in the Accumulo classpath on every tablet server.
104-
105-
See: [Installation Page](http://ngageoint.github.io/geowave/documentation.html#installation-from-rpm) for more information about deployment.
106-
107-
### GeoWave System Integration Test
108-
109-
The geowave-test module will run end-to-end integration testing on either a configured Accumulo instance or a temporary MiniAccumuloCluster. It will ingest both point and line features spatially and temporally from shapefiles and test that spatial and spatial-temporal queries match expected results.
110-
111-
A specific Accumulo instance can be configured either directly within this pom.xml or as Java options -DzookeeperUrl=&lt;zookeeperUrl&gt; -Dinstance=&lt;instance&gt; -Dusername=&lt;username&gt; -Dpassword=&lt;password&gt;
112-
113-
If any of these configuration parameters are left unspecified the default integration test will use a MiniAccumuloCluster created within a temporary directory. For this to work on Windows, make sure Cygwin is installed and a "CYGPATH" environment variable must reference the &lt;CYGWIN_HOME&gt;/bin/cygpath.exe file.
114-
115-
### Supported Versions
116-
117-
See the <a href="https://github.com/ngageoint/geowave/blob/master/.travis.yml" target="_blank">travis test matrix</a> for currently tested configurations, but basically:
118-
119-
Accumulo: N and N-1 (1.6.x and 1.5.x currently);
120-
Hadoop: Apache 2.6, CDH 4.7 -> 5.3, Hortonworks 2.6
121-
GeoTools/GeoServer: 11.4, 12.2/2.5.4, 2.6.2
122-
123-
We have dropped support for hadoop < 2.x; it's should still work if you want to backport, but no guarantees.
124-
125-
### Ingest Data
67+
## Origin
12668

127-
*Coming Soon! With useful details!*
69+
GeoWave was developed at the National Geospatial-Intelligence Agency (NGA) in collaboration with [RadiantBlue Technologies](http://www.radiantblue.com/) and [Booz Allen Hamilton](http://www.boozallen.com/). The government has ["unlimited rights"](https://github.com/ngageoint/geowave/blob/master/NOTICE) 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](http://www.apache.org/licenses/LICENSE-2.0.html) license.
12870

129-
(basically run geowave-ingest::mil.nga.giat.geowave.ingest.IngestMain with the geowave-types module included in the classpath - geowave-ingest uses SPI to discover supported formats and geowave-types provides a set of basic formats)
13071

72+
## Contributing
13173

132-
### View in GeoServer
74+
All pull request contributions to this project will be released under the Apache 2.0 or compatible license.
75+
Software source code previously released under an open source license and then modified by NGA staff is considered a "joint work" (see *17 USC  101*); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open source license.
13376

134-
*Coming Soon! With screenshots as well!*
77+
## Everything else
13578

136-
(basically add a GeoWave data store through the add datastore menu and configure the layer like normal)
79+
Did I mention our [documentation!](http://ngageoint.github.io/geowave/)
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
[[maven-repositories]]
2+
<<<
3+
== Maven Repositories
4+
5+
=== Overview
6+
7+
There are public maven repositories available for both release and snapshot geowave artifacts (no transitive dependencies).
8+
Automated deployment is available, but requires a S3 access key (typically added to your ~/.m2/settings.xml)
9+
10+
=== Maven POM fragments
11+
==== Releases
12+
[source, xml]
13+
----
14+
<repository>
15+
<id>geowave-maven-releases</id>
16+
<name>GeoWave AWS Release Repository</name>
17+
<url>http://geowave-maven.s3-website-us-east-1.amazonaws.com/release</url>
18+
<releases>
19+
<enabled>true</enabled>
20+
</releases>
21+
<snapshots>
22+
<enabled>false</enabled>
23+
</snapshots>
24+
</repository>
25+
----
26+
27+
==== Snapshots
28+
[source, xml]
29+
----
30+
<repository>
31+
<id>geowave-maven-snapshot</id>
32+
<name>GeoWave AWS Snapshot Repository</name>
33+
<url>http://geowave-maven.s3-website-us-east-1.amazonaws.com/snapshot</url>
34+
<releases>
35+
<enabled>false</enabled>
36+
</releases>
37+
<snapshots>
38+
<enabled>true</enabled>
39+
</snapshots>
40+
</repository>
41+
----
42+
43+
=== Maven settings.xml fragments
44+
(you probably don't need this unless you are deploying official GeoWave artifacts)
45+
46+
==== Snapshots
47+
[source, xml]
48+
----
49+
<servers>
50+
<server>
51+
<id>geowave-maven-releases</id>
52+
<username>ACCESS_KEY_ID</username>
53+
<password>SECRET_ACCESS_KEY</password>
54+
</server>
55+
<server>
56+
<id>geowave-maven-snapshots</id>
57+
<username>ACCESS_KEY_ID</username>
58+
<password>SECRET_ACCESS_KEY</password>
59+
</server>
60+
</servers>
61+
----
62+
63+

0 commit comments

Comments
 (0)