Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Compilation process updates #852

Merged
merged 4 commits into from
Jun 7, 2023
Merged

[DOCS] Compilation process updates #852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c7f6236
Update compile the code documentation for sedona
iGN5117 Jun 6, 2023
ceed7a4
Remove prebuild_index config from search plugin
iGN5117 Jun 6, 2023
6e9883d
Addressed PR comments for documentation changes
iGN5117 Jun 7, 2023
e66895e
Merge branch 'master' of https://github.com/iGN5117/sedona into docum…
iGN5117 Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/setup/compile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -66,17 +66,15 @@ User can specify `-Dspark` and `-Dscala` command line options to compile with di
Sedona uses GitHub action to automatically generate jars per commit. You can go [here](https://github.com/apache/sedona/actions/workflows/java.yml) and download the jars by clicking the commit's ==Artifacts== tag.

## Run Python test

1. Set up the environment variable SPARK_HOME and PYTHONPATH

For example,
```
export SPARK_HOME=$PWD/spark-3.0.1-bin-hadoop2.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
```
Expand All @@ -86,6 +84,7 @@ sudo pip3 install -U wheel
sudo pip3 install -U virtualenvwrapper
sudo pip3 install -U pipenv
```
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
Expand All @@ -94,9 +93,11 @@ 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 --dev
```
`pipenv install pyspark` install the latest version of pyspark.
In order to remain consistent with installed spark version, use `pipenv install pyspark==<spark_version>`
6. Run the Python tests
```
cd python
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ markdown_extensions:
- pymdownx.tilde
plugins:
- search:
prebuild_index: true
#prebuild_index: true
- macros
- git-revision-date-localized:
type: datetime