Update compile the code documentation for sedona

iGN5117 · Jun 7, 2023 · c7f6236 · c7f6236
1 parent d2dd743
commit c7f6236
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/docs/setup/compile.md b/docs/setup/compile.md
@@ -6,7 +6,7 @@
 ## Compile Scala / Java source code
 Sedona Scala/Java code is a project with multiple modules. Each module is a Scala/Java mixed project which is managed by Apache Maven 3.
 
-* Make sure your Linux/Mac machine has Java 1.8, Apache Maven 3.3.1+, and Python3. The compilation of Sedona is not tested on Windows machine.
+* Make sure your Linux/Mac machine has Java 1.8, Apache Maven 3.3.1+, and Python3.7+. The compilation of Sedona is not tested on Windows machine.
 
 To compile all modules, please make sure you are in the root folder of all modules. Then enter the following command in the terminal:
 
@@ -76,7 +76,7 @@ export PYTHONPATH=$SPARK_HOME/python
 ```
 2. Compile the Sedona Scala and Java code with `-Dgeotools` and then copy the ==sedona-spark-shaded-{{ sedona.current_version }}.jar== to ==SPARK_HOME/jars/== folder.
 ```
-cp spark-shaded/target/sedona-spark-shaded-xxx.jar SPARK_HOME/jars/
+cp spark-shaded/target/sedona-spark-shaded-xxx.jar $SPARK_HOME/jars/
 ```
 3. Install the following libraries
 ```
@@ -86,6 +86,9 @@ sudo pip3 install -U wheel
 sudo pip3 install -U virtualenvwrapper
 sudo pip3 install -U pipenv
 ```
+!!!tip
+	Homebrew can be used to install libgeos-dev in macOS: ```brew install geos```
+
 4. Set up pipenv to the desired Python version: 3.7, 3.8, or 3.9
 ```
 cd python
@@ -94,7 +97,8 @@ pipenv --python 3.7
 5. Install the PySpark version and other dependency
 ```
 cd python
-pipenv install pyspark==3.0.1
+pipenv install pyspark
+pipenv install shapely~=1.7
 pipenv install --dev
 ```
 6. Run the Python tests