This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-sedona.git
The following commit(s) were added to refs/heads/master by this push:
new 8a7fac1 Update docs
8a7fac1 is described below
commit 8a7fac11f38e8a35ac0ecb281219625cd1e13817
Author: Jia Yu <[email protected]>
AuthorDate: Thu May 27 18:55:27 2021 -0700
Update docs
---
docs/download/overview.md | 2 +-
docs/download/release-notes.md | 12 ++++++++++++
docs/download/scalashell.md | 4 ++++
docs/download/zeppelin.md | 2 +-
docs/tutorial/jupyter-notebook.md | 2 +-
docs/tutorial/sql-pure-sql.md | 2 +-
mkdocs.yml | 3 ++-
python/setup.py | 2 +-
8 files changed, 23 insertions(+), 6 deletions(-)
diff --git a/docs/download/overview.md b/docs/download/overview.md
index 40323ad..1c1acd3 100644
--- a/docs/download/overview.md
+++ b/docs/download/overview.md
@@ -51,7 +51,7 @@ You need to install necessary packages if your system does
not have them install
### Install sedona
-* Installing from PyPi repositories. You can find the latest Sedona Python on
[PyPi](https://pypi.org/project/apache-sedona/)
+* Installing from PyPi repositories. You can find the latest Sedona Python on
[PyPi](https://pypi.org/project/apache-sedona/). [There is an known issue in
Sedona v1.0.1 and earlier versions](../release-notes/#known-issue).
```bash
pip install apache-sedona
diff --git a/docs/download/release-notes.md b/docs/download/release-notes.md
index 1a6231d..bbb6bc4 100644
--- a/docs/download/release-notes.md
+++ b/docs/download/release-notes.md
@@ -2,6 +2,18 @@
This version is a maintenance release on Sedona 1.0.0 line. It includes bug
fixes, some new features, one ==API change==
+### Known issue
+
+In Sedona v1.0.1 and eariler versions, the Spark dependency in setup.py was
configured to be ==< v3.1.0== [by
mistake](https://github.com/apache/incubator-sedona/blob/8235924ac80939cbf2ce562b0209b71833ed9429/python/setup.py#L39).
When you install Sedona Python (apache-sedona v1.0.1) from Pypi, pip might
unstall PySpark 3.1.1 and install PySpark 3.0.2 on your machine.
+
+Three ways to fix this:
+
+1. After install apache-sedona v1.0.1, unstall PySpark 3.0.2 and reinstall
PySpark 3.1.1
+
+2. Ask pip not to install Sedona dependencies: `pip install --no-deps
apache-sedona`
+
+3. Install Sedona from the latest setup.py (on GitHub) manually.
+
### Global
Dependency upgrade:
diff --git a/docs/download/scalashell.md b/docs/download/scalashell.md
index 3250001..e92d6ee 100644
--- a/docs/download/scalashell.md
+++ b/docs/download/scalashell.md
@@ -40,3 +40,7 @@ Spark distribution provides an interactive Scala shell that
allows a user to exe
```
./bin/spark-shell --master spark://localhost:7077 --jars
sedona-core-3.0_2.12-1.0.1-incubating.jar,sedona-sql-3.0_2.12-1.0.1-incubating.jar,sedona-viz-3.0_2.12-1.0.1-incubating.jar
```
+
+## Spark SQL shell
+
+Please see [Use Sedona in a pure SQL environment](../../tutorial/sql-pure-sql/)
\ No newline at end of file
diff --git a/docs/download/zeppelin.md b/docs/download/zeppelin.md
index 80fab16..92040b1 100644
--- a/docs/download/zeppelin.md
+++ b/docs/download/zeppelin.md
@@ -14,7 +14,7 @@ Sedona 1.0.0+: Sedona-core, Sedona-SQL, Sedona-Viz
## Installation
!!!note
- You only need to do Step 1 and 2 only if you cannot see Sedona-Zeppelin
in Zeppelin Helium package list.
+ You only need to do Step 1 and 2 only if you cannot see
[Apache-sedona](https://www.npmjs.com/package/apache-sedona) or [GeoSpark
Zeppelin](https://www.npmjs.com/package/geospark-zeppelin) in Zeppelin Helium
package list.
### Create Helium folder (optional)
Create a folder called **helium** in Zeppelin root folder.
diff --git a/docs/tutorial/jupyter-notebook.md
b/docs/tutorial/jupyter-notebook.md
index 12a12fa..962447f 100644
--- a/docs/tutorial/jupyter-notebook.md
+++ b/docs/tutorial/jupyter-notebook.md
@@ -2,7 +2,7 @@
Click
[](https://mybinder.org/v2/gh/apache/incubator-sedona/HEAD?filepath=binder)
and play the interactive Sedona Python Jupyter Notebook immediately!
-Sedona Python provides two Jupyter Notebook examples: [Sedona
core](https://github.com/apache/incubator-sedona/blob/master/binder/ApacheSedonaCore.ipynb)
and [Sedona
SQL](https://github.com/apache/incubator-sedona/blob/master/binder/ApacheSedonaSQL.ipynb)
+Sedona Python provides a number of [Jupyter Notebook
examples](https://github.com/apache/incubator-sedona/blob/master/binder/).
Please use the following steps to run Jupyter notebook with Pipenv on your
machine
diff --git a/docs/tutorial/sql-pure-sql.md b/docs/tutorial/sql-pure-sql.md
index 5ec49e3..3db654f 100644
--- a/docs/tutorial/sql-pure-sql.md
+++ b/docs/tutorial/sql-pure-sql.md
@@ -9,7 +9,7 @@ Start `spark-sql` as following (replace `<VERSION>` with actual
version, like, `
```sh
spark-sql --packages
org.apache.sedona:sedona-python-adapter-3.0_2.12:<VERSION>,org.apache.sedona:sedona-viz-3.0_2.12:<VERSION>,org.datasyslab:geotools-wrapper:geotools-24.0
\
- --conf spark.kryo.registrator=org.apache.spark.serializer.KryoSerializer \
+ --conf spark.serializer=org.apache.spark.serializer.KryoSerializer \
--conf
spark.kryo.registrator=org.apache.sedona.viz.core.Serde.SedonaVizKryoRegistrator
\
--conf
spark.sql.extensions=org.apache.sedona.viz.sql.SedonaVizExtensions,org.apache.sedona.sql.SedonaSqlExtensions
```
diff --git a/mkdocs.yml b/mkdocs.yml
index c1ace22..38d9df8 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -7,9 +7,10 @@ nav:
- Quick start: download/overview.md
- Release notes: download/release-notes.md
- Maven Central coordinate: download/maven-coordinates.md
+ - Installation on Databricks: download/databricks.md
- Set up Spark cluser: download/cluster.md
- Self-contained project: download/project.md
- - Interactive scala shell: download/scalashell.md
+ - Interactive Scala and SQL shell: download/scalashell.md
- Install Sedona-Zeppelin: download/zeppelin.md
- Compile the code: download/compile.md
- Publish the code: download/publish.md
diff --git a/python/setup.py b/python/setup.py
index 09a92b3..ff10280 100644
--- a/python/setup.py
+++ b/python/setup.py
@@ -36,7 +36,7 @@ setup(
long_description=long_description,
long_description_content_type="text/markdown",
python_requires='>=3.6',
- install_requires=['pyspark<3.1.0', 'attrs', "shapely"],
+ install_requires=['pyspark>=2.3.0', 'attrs', "shapely"],
project_urls={
'Documentation': 'https://sedona.apache.org',
'Source code': 'https://github.com/apache/incubator-sedona',
