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.

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] Update Sedona Visualization docs to include note for single geometry column #929

Merged

Conversation

iGN5117
Copy link
Contributor

@iGN5117 iGN5117 commented Jul 28, 2023

Did you read the Contributor Guide?

Is this PR related to a JIRA ticket?

  • No, this is a documentation update. The PR name follows the format [DOCS] my subject.

What changes were proposed in this PR?

  • Update documentation to include single geometry column restriction.

How was this patch tested?

  • Compiled documentation

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation update.

iGN5117 added 30 commits July 3, 2023 20:33
Added a utilities file that hardcodes map config
…github.com/iGN5117/sedona into develop_Nilesh_1.5.0_NotebookVisualization

# Conflicts:
#	binder/ApacheSedonaSQL_SpatialJoin_AirportsPerCountry.ipynb
…ization

# Conflicts:
#	binder/ApacheSedonaSQL_SpatialJoin_AirportsPerCountry.ipynb
Added comments and documentation on using SedonaKepler
Added keplergl to sedona/python pipfile
Added SedonaKepler import to SedonaContext init
Added basic test cases for map created by SedonaKepler
Reverted jupyter notebook example to sedona 1.4.1 compatible example
Removed unnecessary init.py in python
Refactored method names to follow python convention
Add comprehensive test cases for SedonaKepler
…on 3.7

Updated tests
Refactored naming schemes
Refactor SedonaKepler to remove need for geometry_col in exposed APIs
Add pydeck to Pipfile
Add google buildings and chicago crimes dataset
Add tests for SedonaPyDeck
Update documentation and tests
…ization

# Conflicts:
#	docs/tutorial/sql.md
#	python/Pipfile
#	python/sedona/maps/SedonaKepler.py
#	python/sedona/maps/__init__.py
#	python/sedona/spark/__init__.py
#	python/tests/maps/test_sedonakepler_visualization.py
Update SedonaPyDeck scatterplot to add more possible customizations
Updated documentation
Added Chicago Crimes dataset terms of use and referenced them in licenses file
Referenced CC by 4.0 for Google Buildings Dataset in licenses file
@@ -512,6 +512,9 @@ Sedona provides `SedonaPyDeck` and `SedonaKepler` wrappers, both of which expose
!!!Note
Both SedonaPyDeck and SedonaKepler expect the default geometry order to be lon-lat. If your dataframe has geometries in the lat-lon order, please check out [ST_FlipCoordinates](https://sedona.apache.org/latest-snapshot/api/sql/Function/#st_flipcoordinates)

!!!Note
Both SedonaPyDeck and SedonaKepler are designed to work with SedonaDataFrames containing only 1 geometry column. Passing dataframes with multiple geometry columns will cause errors.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add the following sentence to SedonaPyDeck and SedonaKepler:

To use SedonaPyDeck, GeoPandas and PyDeck must be installed. We recommend the following installation commands:

pip install 'pandas<=1.3.5'
pip install 'geopandas<=0.10.2'
pip install pydeck==0.8.0

To use SedonaKepler, GeoPandas and KeplerGL must be installed. We recommend the following installation commands:

pip install 'pandas<=1.3.5'
pip install 'geopandas<=0.10.2'
pip install keplergl==0.3.2

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@jiayuasu jiayuasu added the docs label Jul 28, 2023
@jiayuasu jiayuasu merged commit 0861db9 into apache:master Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants