|
1 | | -<img src="src/main/paradox/_template/images/RasterFramesLogo.png" width="300px"/><sup style="vertical-align: top;">™</sup> |
| 1 | +<img src="docs/src/main/paradox/_template/images/RasterFramesLogo.png" width="300px"/><sup style="vertical-align: top;">™</sup> |
2 | 2 |
|
3 | | -[  ](https://bintray.com/s22s/maven/raster-frames/_latestVersion) [](https://travis-ci.org/s22s/raster-frames) [](https://codecov.io/gh/s22s/raster-frames) |
| 3 | +[](http://search.maven.org/#search%7Cga%7C1%7Craster-frames) [](https://travis-ci.org/s22s/raster-frames) [](https://codecov.io/gh/s22s/raster-frames) |
4 | 4 | [](https://gitter.im/s22s/raster-frames?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
5 | 5 |
|
6 | 6 | _RasterFrames™_ brings the power of Spark DataFrames to geospatial raster data, empowered by the map algebra and tile layer operations of [GeoTrellis](https://geotrellis.io/). |
7 | 7 |
|
8 | | -<img src="src/main/tut/RasterFramePipelineOverview.png" width="600px"/> |
| 8 | +<img src="docs/src/main/tut/RasterFramePipeline.svg" width="600px"/> |
9 | 9 |
|
10 | | -> **RasterFrames™ is a new project under active development**. Feedback and contributions are welcomed |
11 | | -as we continue to improve it. |
12 | | - |
13 | | -## Getting Started |
14 | | - |
15 | | -## Quick Start |
16 | | - |
17 | | -### macOS |
18 | | - |
19 | | -1. If not already, install [Homebrew](https://brew.sh/) |
20 | | -2. Run `brew install sbt` |
21 | | -3. Run `sbt new s22s/raster-frames.g8` |
22 | | - |
23 | | -### Linux |
24 | | - |
25 | | -1. Install [sbt](http://www.scala-sbt.org/release/docs/Installing-sbt-on-Linux.html) |
26 | | -2. Run `sbt new s22s/raster-frames.g8` |
27 | | - |
28 | | -### Windows |
29 | | - |
30 | | -1. Install [sbt](http://www.scala-sbt.org/release/docs/Installing-sbt-on-Windows.html) |
31 | | -2. Run `sbt new s22s/raster-frames.g8` |
32 | | - |
33 | | -## General Setup |
34 | | - |
35 | | -*RasterFrames* is published via Bintray's JCenter server. In sbt you introduce it with this build setting: |
36 | | - |
37 | | -``` |
38 | | -resolvers += Resolver.jcenterRepo |
39 | | -``` |
40 | | - |
41 | | -(See [this](https://bintray.com/bintray/jcenter) for use of JCenter with other build tools.) |
42 | | - |
43 | | -To use RasterFrames, add the following library dependency: |
44 | | - |
45 | | -sbt: |
46 | | - |
47 | | -```scala |
48 | | -libraryDependencies += "io.astraea" %% "raster-frames" % "x.y.z" |
49 | | -``` |
50 | | - |
51 | | -Maven: |
52 | | - |
53 | | -```xml |
54 | | -<dependency> |
55 | | - <groupId>io.astraea</groupId> |
56 | | - <artifactId>raster-frames</artifactId> |
57 | | - <version>x.y.z</version> |
58 | | -</dependency> |
59 | | -``` |
60 | | - |
61 | | -Note: It assumes that SparkSQL 2.1.1 is available in the runtime classpath. |
| 10 | +Please see the [Getting Started](http://rasterframes.io/getting-started.html) section of the Users' Manual to start using RasterFrames. |
62 | 11 |
|
63 | 12 | ## Documentation |
64 | 13 |
|
65 | 14 | * [Users' Manual](http://rasterframes.io/) |
66 | 15 | * [API Documentation](http://rasterframes.io/latest/api/index.html) |
67 | 16 | * [List of available UDFs](http://rasterframes.io/latest/api/index.html#astraea.spark.rasterframes.ColumnFunctions) |
68 | 17 |
|
69 | | - |
70 | 18 | ## Copyright and License |
71 | 19 |
|
72 | | -All code is available to you under the Apache 2.0 License, copyright Astraea, Inc. 2017. |
| 20 | +RasterFrames is released under the Apache 2.0 License, copyright Astraea, Inc. 2017. |
73 | 21 |
|
74 | 22 |
|
0 commit comments