|
| 1 | +# Contributing to RasterFrames |
| 2 | + |
| 3 | +Thanks for your interest in this project. |
| 4 | + |
| 5 | +## Project Description |
| 6 | + |
| 7 | +LocationTech RasterFrames brings the power of Spark DataFrames to geospatial |
| 8 | +raster data, empowered by the map algebra and tile layer operations of |
| 9 | +GeoTrellis. The underlying purpose of RasterFrames is to allow data scientists |
| 10 | +and software developers to process and analyze geospatial-temporal raster data |
| 11 | +with the same flexibility and ease as any other Spark Catalyst data type. At its |
| 12 | +core is a user-defined type (UDT) called TileUDT, which encodes a GeoTrellis |
| 13 | +Tile in a form the Spark Catalyst engine can process. Furthermore, we extend the |
| 14 | +definition of a DataFrame to encompass some additional invariants, allowing for |
| 15 | +geospatial operations within and between RasterFrames to occur, while still |
| 16 | +maintaining necessary geo-referencing constructs. |
| 17 | + |
| 18 | + * https://projects.eclipse.org/projects/locationtech.rasterframes |
| 19 | + |
| 20 | +## Eclipse Contributor Agreement |
| 21 | + |
| 22 | +Before your contribution can be accepted by the project team contributors must |
| 23 | +electronically sign the Eclipse Contributor Agreement (ECA). |
| 24 | + |
| 25 | + * http://www.eclipse.org/legal/ECA.php |
| 26 | + |
| 27 | +Commits that are provided by non-committers must have a Signed-off-by field in |
| 28 | +the footer indicating that the author is aware of the terms by which the |
| 29 | +contribution has been provided to the project. The non-committer must |
| 30 | +additionally have an Eclipse Foundation account and must have a signed Eclipse |
| 31 | +Contributor Agreement (ECA) on file. |
| 32 | + |
| 33 | +For more information, please see the Eclipse Committer Handbook: |
| 34 | +https://www.eclipse.org/projects/handbook/#resources-commit |
| 35 | + |
| 36 | +## Developer Resources |
| 37 | + |
| 38 | +The RasterFrames source code is hosted on GitHub: |
| 39 | + |
| 40 | + * https://github.com/locationtech/rasterframes |
| 41 | + |
| 42 | +Issues should be submitted via GitHub issues: |
| 43 | + |
| 44 | + * https://github.com/locationtech/rasterframes/issues |
| 45 | + |
| 46 | +A user manual may be found here: |
| 47 | + |
| 48 | + * http://rasterframes.io |
| 49 | + |
| 50 | +## Building |
| 51 | + |
| 52 | +RasterFrames uses [sbt](https://www.scala-sbt.org/) as its build tool. Standard build |
| 53 | +commands are as follows: |
| 54 | + |
| 55 | +* Compile: `sbt compile` |
| 56 | +* Install packages locally: `sbt publishLocal` |
| 57 | +* Run tests: `sbt test` |
| 58 | +* Build documentation: `sbt makeSite` |
| 59 | +* Spark shell with RasterFrames initialized: `sbt console` |
| 60 | + |
| 61 | + |
| 62 | +## Contribution Process |
| 63 | + |
| 64 | +RasterFrames uses GitHub pull requests (PRs) for accepting contributions. |
| 65 | +Please fork the repository, create a branch, and submit a PR based off the `master` branch. |
| 66 | +During the PR review process comments may be attached. Please look out for comments |
| 67 | +and respond as necessary. |
| 68 | + |
| 69 | + |
| 70 | +## Contact |
| 71 | + |
| 72 | +Help, questions and community dialog are supported via Gitter: |
| 73 | + |
| 74 | + * https://gitter.im/s22s/raster-frames |
| 75 | + |
| 76 | +Commercial support is available by writing to [email protected] |
0 commit comments