Skip to content

Commit 3a51158

Browse files
committed
Add prospective links to getting started docs
Signed-off-by: Jason T. Brown <[email protected]>
1 parent 38b8c2d commit 3a51158

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

pyrasterframes/src/main/python/docs/getting-started.pymd

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Getting Started
22

3-
There are @ref:[several ways](getting-started.md#other-options) to use RasterFrames, and @ref:[several languages](languages.md) with which you can use it. Let's start with the simplest: the Python shell. Python 3.6 or greater is recommended.
3+
There are @ref:[several ways](getting-started.md#other-options) to use RasterFrames, and @ref:[several languages](languages.md) with which you can use it. Let's start with the simplest: the Python shell. To get started you will need:
4+
5+
1. [Python](https://www.python.org/) installed. Version 3.6 or greater is recommended.
6+
1. `pip` or `pip3` (recommended) installed. If you are using Python 3, `pip3` may already be installed.
7+
1. Java [JDK 8](https://openjdk.java.net/install/index.html) installed on your system and `java` on your system `PATH` or `JAVA_HOME` pointing to a Java installation.
48

59
## pip install pyrasterframes
610

@@ -31,8 +35,7 @@ df.select(rf_local_add(df.proj_raster, lit(3))).show(5, False)
3135

3236
This example is extended in the [getting started Jupyter notebook](https://nbviewer.jupyter.org/github/locationtech/rasterframes/blob/develop/rf-notebook/src/main/notebooks/Getting%20Started.ipynb).
3337

34-
To understand more about how and why RasterFrames represents Earth observation in DataFrames, read the project @ref:[description](description.md). For more hands-on examples, see the chapters about @ref:[reading](raster-io.md) and @ref:[processing](raster-processing.md) with RasterFrames.
35-
38+
To understand more about how and why RasterFrames represents Earth observation in DataFrames, read about the @ref:[core concepts](concepts.md) and the project @ref:[description](description.md). For more hands-on examples, see the chapters about @ref:[reading](raster-io.md) and @ref:[processing](raster-processing.md) with RasterFrames.
3639

3740
## Other Options
3841

@@ -43,15 +46,27 @@ You can also use RasterFrames in the following environments:
4346

4447
### Jupyter Notebook
4548

46-
**TODO** User facing quick instructions e.g. how to pull and run docker hub hosted container
49+
RasterFrames provides a Docker image for a Jupyter notebook server whose default kernel is already set up for running RasterFrames. To use it:
50+
51+
1. Install [docker](https://docs.docker.com/install/)
52+
1. Pull the image: `docker pull s22s/rasterframes-notebook`
53+
1. Run a container with the image, for example:
54+
55+
docker run -p 8808:8888 -p 44040:4040 -v /path/to/notebooks:/home/notebooks rasterframes-notebook:latest
4756

48-
See [RasterFrames Notebook README](https://github.com/locationtech/rasterframes/blob/develop/rf-notebook/README.md) for instructions on running a Jupyter notebook server within a Docker container that has a fully set up environment.
57+
1. In a browser, open `localhost:8808` in the example above.
58+
59+
See [RasterFrames Notebook README](https://github.com/locationtech/rasterframes/blob/develop/rf-notebook/README.md) for instructions on building the Docker image for this Jupyter notebook server.
4960

5061
### `pyspark` shell or app
5162

52-
To initialize RasterFrames in a `pyspark` shell, prepare to call pyspark with the appropriate `--master` and other `--conf` arguments for your cluster manager and environment. To these you will add the PyRasterFrames assembly JAR and the python source zip.
63+
To initialize RasterFrames in a `pyspark` shell, prepare to call pyspark with the appropriate `--master` and other `--conf` arguments for your cluster manager and environment. To these you will add the PyRasterFrames assembly JAR and the python source zip.
64+
65+
You can either [build](https://github.com/locationtech/rasterframes/blob/develop/README.md) the artifacts or download them:
66+
67+
* Assembly JAR: https://repo1.maven.org/maven2/org/locationtech/rasterframes/pyrasterframes_2.11/${VERSION}/pyrasterframes-assembly-${VERSION}.jar
68+
* Python zip: https://repo1.maven.org/maven2/org/locationtech/rasterframes/pyrasterframes_2.11/${VERSION}/pyrasterframes_2.11-${VERSION}-python.zip
5369

54-
**TODO** how to build or download those artifacts.
5570

5671
```bash
5772
pyspark \

0 commit comments

Comments
 (0)