Skip to content

Commit

Permalink
Release 0.6.0.
Browse files Browse the repository at this point in the history
Signed-off-by: Simeon H.K. Fitch <fitch@astraea.io>
  • Loading branch information
metasim committed Mar 27, 2018
1 parent b7a7dd7 commit b85a86c
Show file tree
Hide file tree
Showing 176 changed files with 6,251 additions and 1,278 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ metastore_db
.ensime*
tour/jars
tour/*.tiff
scoverage-report*
2 changes: 1 addition & 1 deletion .scalafmt.conf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
maxColumn = 120
maxColumn = 100
continuationIndent.defnSite = 2
binPack.parentConstructors = true
newlines.penalizeSingleSelectMultiArgList = false
Expand Down
62 changes: 5 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,22 @@
<img src="src/main/paradox/_template/images/RasterFramesLogo.png" width="300px"/><sup style="vertical-align: top;">&trade;</sup>
<img src="docs/src/main/paradox/_template/images/RasterFramesLogo.png" width="300px"/><sup style="vertical-align: top;">&trade;</sup>

[ ![Download](https://api.bintray.com/packages/s22s/maven/raster-frames/images/download.svg) ](https://bintray.com/s22s/maven/raster-frames/_latestVersion) [![Build Status](https://travis-ci.org/s22s/raster-frames.svg?branch=develop)](https://travis-ci.org/s22s/raster-frames) [![codecov](https://codecov.io/gh/s22s/raster-frames/branch/develop/graph/badge.svg)](https://codecov.io/gh/s22s/raster-frames)
[![Maven metadata URI](https://img.shields.io/maven-metadata/v/http/central.maven.org/maven2/io/astraea/raster-frames_2.11/maven-metadata.xml.svg)](http://search.maven.org/#search%7Cga%7C1%7Craster-frames) [![Build Status](https://travis-ci.org/s22s/raster-frames.svg?branch=develop)](https://travis-ci.org/s22s/raster-frames) [![codecov](https://codecov.io/gh/s22s/raster-frames/branch/develop/graph/badge.svg)](https://codecov.io/gh/s22s/raster-frames)
[![Join the chat at https://gitter.im/s22s/raster-frames](https://badges.gitter.im/s22s/raster-frames.svg)](https://gitter.im/s22s/raster-frames?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

_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/).

<img src="src/main/tut/RasterFramePipelineOverview.png" width="600px"/>
<img src="docs/src/main/tut/RasterFramePipeline.svg" width="600px"/>

> **RasterFrames™ is a new project under active development**. Feedback and contributions are welcomed
as we continue to improve it.

## Getting Started

## Quick Start

### macOS

1. If not already, install [Homebrew](https://brew.sh/)
2. Run `brew install sbt`
3. Run `sbt new s22s/raster-frames.g8`

### Linux

1. Install [sbt](http://www.scala-sbt.org/release/docs/Installing-sbt-on-Linux.html)
2. Run `sbt new s22s/raster-frames.g8`

### Windows

1. Install [sbt](http://www.scala-sbt.org/release/docs/Installing-sbt-on-Windows.html)
2. Run `sbt new s22s/raster-frames.g8`

## General Setup

*RasterFrames* is published via Bintray's JCenter server. In sbt you introduce it with this build setting:

```
resolvers += Resolver.jcenterRepo
```

(See [this](https://bintray.com/bintray/jcenter) for use of JCenter with other build tools.)

To use RasterFrames, add the following library dependency:

sbt:

```scala
libraryDependencies += "io.astraea" %% "raster-frames" % "x.y.z"
```

Maven:

```xml
<dependency>
<groupId>io.astraea</groupId>
<artifactId>raster-frames</artifactId>
<version>x.y.z</version>
</dependency>
```

Note: It assumes that SparkSQL 2.1.1 is available in the runtime classpath.
Please see the [Getting Started](http://rasterframes.io/getting-started.html) section of the Users' Manual to start using RasterFrames.

## Documentation

* [Users' Manual](http://rasterframes.io/)
* [API Documentation](http://rasterframes.io/latest/api/index.html)
* [List of available UDFs](http://rasterframes.io/latest/api/index.html#astraea.spark.rasterframes.ColumnFunctions)


## Copyright and License

All code is available to you under the Apache 2.0 License, copyright Astraea, Inc. 2017.
RasterFrames is released under the Apache 2.0 License, copyright Astraea, Inc. 2017.


8 changes: 4 additions & 4 deletions bench/build.sbt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
enablePlugins(BenchmarkPlugin)

libraryDependencies ++= Seq(
spark("core"),
spark("sql"),
geotrellis("spark"),
geotrellis("raster")
spark("core").value,
spark("sql").value,
geotrellis("spark").value,
geotrellis("raster").value
)

jmhIterations := Some(5)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import java.util.concurrent.TimeUnit
import geotrellis.raster.Tile
import org.apache.spark.sql.catalyst.InternalRow
import org.apache.spark.sql.catalyst.encoders.ExpressionEncoder
import org.apache.spark.sql.gt.InternalRowTile
import org.apache.spark.sql.rf.InternalRowTile
import org.apache.spark.sql.gt.types.TileUDT
import org.openjdk.jmh.annotations._

Expand Down
28 changes: 15 additions & 13 deletions build.sbt
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
lazy val `raster-frames` = project
addCommandAlias("makeSite", "docs/makeSite")

lazy val root = project
.in(file("."))
.enablePlugins(
SiteScaladocPlugin,
ParadoxSitePlugin,
TutPlugin,
GhpagesPlugin,
BuildInfoPlugin
)
.settings(name := "RasterFrames")
.settings(moduleName := "raster-frames")
.withId("RF")
.aggregate(core, datasource)
.settings(publishArtifact := false)
.settings(releaseSettings)
.settings(docSettings)
.settings(buildInfoSettings)

lazy val core = project

lazy val datasource = project
.dependsOn(core % "test->test;compile->compile")

lazy val docs = project
.dependsOn(core, datasource)

lazy val bench = project
.dependsOn(`raster-frames`)
.dependsOn(core)

initialCommands in console := """
|import astraea.spark.rasterframes._
Expand Down
33 changes: 33 additions & 0 deletions core/build.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
enablePlugins(BuildInfoPlugin)

moduleName := "raster-frames"

libraryDependencies ++= Seq(
"com.chuusai" %% "shapeless" % "2.3.2",
"org.locationtech.geomesa" %% "geomesa-z3" % "1.3.5",
"org.locationtech.geomesa" %% "geomesa-spark-jts" % "2.0.0-astraea.1" exclude("jgridshift", "jgridshift"),
spark("core").value % Provided,
spark("mllib").value % Provided,
spark("sql").value % Provided,
geotrellis("spark").value,
geotrellis("raster").value,
geotrellis("spark-testkit").value % Test excludeAll (
ExclusionRule(organization = "org.scalastic"),
ExclusionRule(organization = "org.scalatest")
),
scalaTest
)

buildInfoKeys ++= Seq[BuildInfoKey](
name, version, scalaVersion, sbtVersion, rfGeotrellisVersion, rfSparkVersion
)

buildInfoPackage := "astraea.spark.rasterframes"

buildInfoObject := "RFBuildInfo"

buildInfoOptions := Seq(
BuildInfoOption.ToMap,
BuildInfoOption.BuildTime
)

13 changes: 13 additions & 0 deletions core/src/main/scala/astraea/spark/rasterframes/MetadataKeys.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package astraea.spark.rasterframes

/**
*
* @since 2/19/18
*/
trait MetadataKeys {
/** Key under which ContextRDD metadata is stored. */
private[rasterframes] val CONTEXT_METADATA_KEY = "_context"

/** Key under which RasterFrame role a column plays. */
private[rasterframes] val SPATIAL_ROLE_KEY = "_stRole"
}
Loading

0 comments on commit b85a86c

Please sign in to comment.