This repository has been archived by the owner on Mar 6, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Simeon H.K. Fitch <fitch@astraea.io>
- Loading branch information
Showing
3 changed files
with
128 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributing to RasterFrames | ||
|
||
Thanks for your interest in this project. | ||
|
||
## Project Description | ||
|
||
LocationTech RasterFrames brings the power of Spark DataFrames to geospatial | ||
raster data, empowered by the map algebra and tile layer operations of | ||
GeoTrellis. The underlying purpose of RasterFrames is to allow data scientists | ||
and software developers to process and analyze geospatial-temporal raster data | ||
with the same flexibility and ease as any other Spark Catalyst data type. At its | ||
core is a user-defined type (UDT) called TileUDT, which encodes a GeoTrellis | ||
Tile in a form the Spark Catalyst engine can process. Furthermore, we extend the | ||
definition of a DataFrame to encompass some additional invariants, allowing for | ||
geospatial operations within and between RasterFrames to occur, while still | ||
maintaining necessary geo-referencing constructs. | ||
|
||
* https://projects.eclipse.org/projects/locationtech.rasterframes | ||
|
||
## Eclipse Contributor Agreement | ||
|
||
Before your contribution can be accepted by the project team contributors must | ||
electronically sign the Eclipse Contributor Agreement (ECA). | ||
|
||
* http://www.eclipse.org/legal/ECA.php | ||
|
||
Commits that are provided by non-committers must have a Signed-off-by field in | ||
the footer indicating that the author is aware of the terms by which the | ||
contribution has been provided to the project. The non-committer must | ||
additionally have an Eclipse Foundation account and must have a signed Eclipse | ||
Contributor Agreement (ECA) on file. | ||
|
||
For more information, please see the Eclipse Committer Handbook: | ||
https://www.eclipse.org/projects/handbook/#resources-commit | ||
|
||
## Developer Resources | ||
|
||
The RasterFrames source code is hosted on GitHub: | ||
|
||
* https://github.com/locationtech/rasterframes | ||
|
||
Issues should be submitted via GitHub issues: | ||
|
||
* https://github.com/locationtech/rasterframes/issues | ||
|
||
A user manual may be found here: | ||
|
||
* http://rasterframes.io | ||
|
||
## Building | ||
|
||
RasterFrames uses [sbt](https://www.scala-sbt.org/) as its build tool. Standard build | ||
commands are as follows: | ||
|
||
* Compile: `sbt compile` | ||
* Install packages locally: `sbt publishLocal` | ||
* Run tests: `sbt test` | ||
* Build documentation: `sbt makeSite` | ||
* Spark shell with RasterFrames initialized: `sbt console` | ||
|
||
|
||
## Contribution Process | ||
|
||
RasterFrames uses GitHub pull requests (PRs) for accepting contributions. | ||
Please fork the repository, create a branch, and submit a PR based off the `master` branch. | ||
During the PR review process comments may be attached. Please look out for comments | ||
and respond as necessary. | ||
|
||
|
||
## Contact | ||
|
||
Help, questions and community dialog are supported via Gitter: | ||
|
||
* https://gitter.im/s22s/raster-frames | ||
|
||
Commercial support is available by writing to info@astraea.earth |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Notices for RasterFrames | ||
|
||
This content is produced and maintained by the LocationTech RasterFrames project. | ||
|
||
* Project home: https://projects.eclipse.org/projects/locationtech.rasterframes | ||
|
||
## Trademarks | ||
|
||
LocationTech RasterFrames, RasterFrames, and the RasterFrames logo are trademarks for the Eclipse Foundation. | ||
|
||
## Declared Project Licenses | ||
|
||
This program and the accompanying materials are made available under the terms of the Apache License, Version 2.0 | ||
which is available at https://www.apache.org/licenses/LICENSE-2.0. | ||
|
||
SPDX-License-Identifier: Apache-2.0 | ||
|
||
## Source Code | ||
|
||
The project maintains the following source code repository: | ||
|
||
* https://github.com/locationtech/rasterframes | ||
|
||
## Third-party Content | ||
|
||
LocationTech GeoTrelllis (1.2.0) | ||
|
||
* License: Apache License, 2.0 | ||
* Project: https://github.com/locationtech/geotrellis | ||
* Source: https://github.com/locationtech/geotrellis/tree/1.2 | ||
|
||
LocationTech GeoMesa (2.0.0-m.1) | ||
|
||
* License: Apache License, 2.0 | ||
* Project: https://github.com/locationtech/geomesa | ||
* Source: https://github.com/locationtech/geomesa/releases/tag/geomesa_2.11-2.0.0-m.1 | ||
|
||
shapeless (2.3.2) | ||
|
||
* License: Apache License, 2.0 | ||
* Project: https://github.com/milessabin/shapeless | ||
* Source: https://github.com/milessabin/shapeless/releases/tag/shapeless-2.3.2 | ||
|
||
## Cryptography | ||
|
||
Content may contain encryption software. The country in which you are currently | ||
may have restrictions on the import, possession, and use, and/or re-export to | ||
another country, of encryption software. BEFORE using any encryption software, | ||
please check the country's laws, regulations and policies concerning the import, | ||
possession, or use, and re-export of encryption software, to see if this is | ||
permitted. |