Skip to content

Commit

Permalink
Documentation tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
metasim committed Aug 12, 2019
1 parent c069c99 commit 65203c0
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 33 deletions.
26 changes: 4 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
# Contributing to RasterFrames

Thanks for your interest in this project.
Community contributions are always welcome. To get started, please review this document,
the [code of conduct](https://github.com/locationtech/rasterframes/blob/develop/CODE_OF_CONDUCT.md), and reach out to
us on [gitter](https://gitter.im/locationtech/rasterframes) so the community can help you get started!

## 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.
The official home of RasterFrames under the Eclipse Foundation may be found here:

* https://projects.eclipse.org/projects/locationtech.rasterframes

Expand Down Expand Up @@ -58,15 +49,6 @@ commands are as follows:
* 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:
Expand Down
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,39 @@

[![Join the chat at https://gitter.im/locationtech/rasterframes](https://badges.gitter.im/locationtech/rasterframes.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/).
RasterFrames® brings together Earth-observation (EO) data access, cloud computing, and DataFrame-based data science. The recent explosion of EO data from public and private satellite operators presents both a huge opportunity as well as a challenge to the data analysis community. It is _Big Data_ in the truest sense, and its footprint is rapidly getting bigger.

RasterFrames provides a DataFrame-centric view over arbitrary raster data, enabling spatiotemporal queries, map algebra raster operations, and compatibility with the ecosystem of Spark ML algorithms. By using DataFrames as the core cognitive and compute data model, it is able to deliver these features in a form that is both accessible to general analysts and scalable along with the rapidly growing data footprint.

<img src="docs/src/main/paradox/RasterFramePipeline.png" width="600px"/>

Please see the [Getting Started](http://rasterframes.io/getting-started.html) section of the Users' Manual to start using RasterFrames.

## Documentation
## User Resources

* [RasterFrames Users' Manual](http://rasterframes.io/)
* [RasterFrames Jupyter Notebook Docker Image](https://hub.docker.com/r/s22s/rasterframes-notebooks/)
* [Gitter Channel](https://gitter.im/locationtech/rasterframes)
* [Submit an Issue](https://github.com/locationtech/rasterframes/issues)


## Contributing

* [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#org.locationtech.rasterframes.RasterFunctions)
* [RasterFrames Jupyter Notebook Docker Image](https://hub.docker.com/r/s22s/rasterframes-notebooks/)
Community contributions are always welcome. To get started, please review our [contribution guidelines](https://github.com/locationtech/rasterframes/blob/develop/CONTRIBUTING.md), [code of conduct](https://github.com/locationtech/rasterframes/blob/develop/CODE_OF_CONDUCT.md), and reach out to us on [gitter](https://gitter.im/locationtech/rasterframes) so the community can help you get started!

## Build instruction
RasterFrames is part of the LocationTech Stack.

First, you will need [sbt](https://www.scala-sbt.org/).
<img src ="pyrasterframes/src/main/python/docs/static/rasterframes-locationtech-stack.png" width="600px" />

Download the source from GitHub.
It is written in Scala, but with Python bindings. If you wish to contribute to the development of RasterFrames, or you
wish to build it from scratch, you will need [sbt](https://www.scala-sbt.org/). Then clone the repository from GitHub.

```bash
git clone https://github.com/locationtech/rasterframes.git
cd rasterframes
```

To publish to hyou Ivy local repository:
To publish to your local repository:

```bash
sbt publishLocal
Expand All @@ -50,7 +58,7 @@ The documentation may be built with
sbt makeSite
```

The `pyrasterframes` build instructions are located at [pyrasterframes/src/main/python/README.md](pyrasterframes/src/main/python/README.md)
Additional, Python sepcific build instruction may be found at [pyrasterframes/src/main/python/README.md](pyrasterframes/src/main/python/README.md)

## Copyright and License

Expand Down
5 changes: 5 additions & 0 deletions pyrasterframes/src/main/python/docs/languages.pymd
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ SELECT month, ndvi_stats.* FROM (

## Scala

The latest Scala API documentation is available here:

* @ref:[Scala API Documentation](http://rasterframes.io/latest/api/index.html)


### Step 1: Load the catalog

```scala
Expand Down

0 comments on commit 65203c0

Please sign in to comment.