diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml index b25b618e84..ddbf76e672 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.github/linters/.markdown-lint.yml @@ -39,8 +39,5 @@ MD040: false # first-line-heading/first-line-h1 - First line in a file should be a top-level heading MD041: false -# no-alt-text - Images should have alternate text (alt text) -MD045: false - # code-block-style - Code block style MD046: false diff --git a/R/README.md b/R/README.md index a4d1477ea0..1a973cc169 100644 --- a/R/README.md +++ b/R/README.md @@ -1,4 +1,4 @@ -# apache.sedona +# apache.sedona Apache Sedona Logo [Apache Sedona](https://sedona.apache.org/) is a cluster computing system for processing large-scale spatial data. Sedona extends existing cluster computing systems, such as Apache Spark and Apache Flink, with a set of out-of-the-box distributed Spatial Datasets and Spatial SQL that efficiently load, process, and analyze large-scale spatial data across machines. diff --git a/README.md b/README.md index d810d0346e..4bd2e82bd1 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ [![Scala and Java build](https://github.com/apache/sedona/actions/workflows/java.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/java.yml) [![Python build](https://github.com/apache/sedona/actions/workflows/python.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/python.yml) [![R build](https://github.com/apache/sedona/actions/workflows/r.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/r.yml) [![Docker image build](https://github.com/apache/sedona/actions/workflows/docker-build.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/docker-build.yml) [![Example project build](https://github.com/apache/sedona/actions/workflows/example.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/example.yml) [![Docs build](https://github.com/apache/sedona/actions/workflows/docs.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/docs.yml) -| Download statistics | **Maven** | **PyPI** | Conda-forge | **CRAN** | **DockerHub** | -|----------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| -| Apache Sedona | 225k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/apache-sedona)](https://pepy.tech/project/apache-sedona) [![Downloads](https://static.pepy.tech/personalized-badge/apache-sedona?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/apache-sedona) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/apache-sedona/badges/downloads.svg)](https://anaconda.org/conda-forge/apache-sedona) | [![](https://cranlogs.r-pkg.org/badges/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) [![](https://cranlogs.r-pkg.org/badges/grand-total/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) | [![Docker pulls](https://img.shields.io/docker/pulls/apache/sedona?color=brightgreen)](https://hub.docker.com/r/apache/sedona) | -| Archived GeoSpark releases | 10k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/geospark)](https://pepy.tech/project/geospark)[![Downloads](https://static.pepy.tech/personalized-badge/geospark?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/geospark) | | | | +| Download statistics | **Maven** | **PyPI** | Conda-forge | **CRAN** | **DockerHub** | +|----------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Apache Sedona | 225k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/apache-sedona)](https://pepy.tech/project/apache-sedona) [![Downloads](https://static.pepy.tech/personalized-badge/apache-sedona?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/apache-sedona) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/apache-sedona/badges/downloads.svg)](https://anaconda.org/conda-forge/apache-sedona) | [![CRAN monthly downloads](https://cranlogs.r-pkg.org/badges/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) [![Total CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) | [![Docker pulls](https://img.shields.io/docker/pulls/apache/sedona?color=brightgreen)](https://hub.docker.com/r/apache/sedona) | +| Archived GeoSpark releases | 10k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/geospark)](https://pepy.tech/project/geospark)[![Downloads](https://static.pepy.tech/personalized-badge/geospark?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/geospark) | | | | * [Join the community](#join-the-community) * [What is Apache Sedona?](#what-is-apache-sedona) @@ -22,7 +22,7 @@ Follow Sedona on Twitter for fresh news: [Sedona@Twitter](https://twitter.com/ApacheSedona) -Join the Sedona Discord community: [![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) +Join the Sedona Discord community: [![Apache Sedona Community Discord Server](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) Join the Sedona monthly community office hour: [Google Calendar](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NjI0cWgwcTZndnI1anAzYnFrNHY5Y2wyaTRfMjAyNDA0MDlUMTUwMDAwWiBjX2VmN2Q1NGY1MzA4YTRiN2YyNWFjMzNkMGY3ZWViNTRhM2E3ZjExNWI2ODlmYWY0ZDgyNDI1ZjNjYjVlZGU5MzVAZw&tmsrc=c_ef7d54f5308a4b7f25ac33d0f7eeb54a3a7f115b689faf4d82425f3cb5ede935%40group.calendar.google.com&scp=ALL), Tuesdays from 8 AM to 9 AM Pacific Time, every 4 weeks @@ -36,7 +36,7 @@ Join the Sedona monthly community office hour: [Google Calendar](https://calenda Apache Sedona™ is a spatial computing engine that enables developers to easily process spatial data at any scale within modern cluster computing systems such as Apache Spark and Apache Flink. Sedona developers can express their spatial data processing tasks in Spatial SQL, Spatial Python or Spatial R. Internally, Sedona provides spatial data loading, indexing, partitioning, and query processing/optimization functionality that enable users to efficiently analyze spatial data at any scale. -![](docs/image/sedona-ecosystem.png "Sedona Ecosystem") +![Sedona Ecosystem](docs/image/sedona-ecosystem.png "Sedona Ecosystem") ### Features diff --git a/docs/api/snowflake/vector-data/Function.md b/docs/api/snowflake/vector-data/Function.md index 8412f2e3b3..d171b478a3 100644 --- a/docs/api/snowflake/vector-data/Function.md +++ b/docs/api/snowflake/vector-data/Function.md @@ -2810,7 +2810,7 @@ Format: `ST_Snap(input: Geometry, reference: Geometry, tolerance: double)` Input geometry: -![](../../../image/st_snap/st-snap-base-example.png "ST_Snap Base example") +![ST_Snap Base example](../../../image/st_snap/st-snap-base-example.png "ST_Snap Base example") SQL Example: @@ -2824,7 +2824,7 @@ SELECT Output: -![](../../../image/st_snap/st-snap-applied.png "ST_Snap applied example") +![ST_Snap applied example](../../../image/st_snap/st-snap-applied.png "ST_Snap applied example") ``` POLYGON ((236877.58 -6.61, 236878.29 -8.35, 236879.98 -8.33, 236879.72 -7.63, 236880.69 -6.81, 236877.58 -6.61), (236878.45 -7.01, 236878.43 -7.52, 236879.29 -7.5, 236878.63 -7.22, 236878.76 -6.89, 236878.45 -7.01)) diff --git a/docs/api/sql/Optimizer.md b/docs/api/sql/Optimizer.md index 6c64c9371f..63e485ee33 100644 --- a/docs/api/sql/Optimizer.md +++ b/docs/api/sql/Optimizer.md @@ -340,8 +340,8 @@ answer queries such as `SELECT * FROM geoparquet_dataset WHERE ST_Intersects(geo We can compare the metrics of querying the GeoParquet dataset with or without the spatial predicate and observe that querying with spatial predicate results in fewer number of rows scanned. -| Without spatial predicate | With spatial predicate | -| ----------- | ----------- | -| ![](../../image/scan-parquet-without-spatial-pred.png) | ![](../../image/scan-parquet-with-spatial-pred.png) | +| Without spatial predicate | With spatial predicate | +|-------------------------------------------------------------------------------------------------| ----------- | +| ![Scan geoparquet without spatial predicate](../../image/scan-parquet-without-spatial-pred.png) | ![Scan geoparquet with spatial predicate](../../image/scan-parquet-with-spatial-pred.png) | Spatial predicate push-down to GeoParquet is enabled by default. Users can manually disable it by setting the Spark configuration `spark.sedona.geoparquet.spatialFilterPushDown` to `false`. diff --git a/docs/community/contact.md b/docs/community/contact.md index e52335729f..353cc604b5 100644 --- a/docs/community/contact.md +++ b/docs/community/contact.md @@ -19,7 +19,7 @@ Everyone is welcome to join our community events. We have a community office hou ## Discord Server -[![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) +[![Apache Sedona Community Discord Server](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) ## Mailing list diff --git a/docs/community/develop.md b/docs/community/develop.md index 0d3e457c25..278677ec62 100644 --- a/docs/community/develop.md +++ b/docs/community/develop.md @@ -10,17 +10,17 @@ We recommend [Intellij IDEA](https://www.jetbrains.com/idea/) with Scala plugin #### Choose `Open` -![](../image/ide-java-1.png) +![Import the project by clicking Open](../image/ide-java-1.png) #### Go to the Sedona root folder (not a submodule folder) and choose `open` -![](../image/ide-java-2.png) +![Open the Sedona root folder](../image/ide-java-2.png) #### The IDE might show errors The IDE usually has trouble understanding the complex project structure in Sedona. -![](../image/ide-java-4.png) +![The IDE usually has trouble understanding the project](../image/ide-java-4.png) #### Fix errors by changing `pom.xml` @@ -39,11 +39,11 @@ You need to comment out the following lines in `pom.xml` at the root folder, as Make sure you reload the `pom.xml` or reload the maven project. The IDE will ask you to remove some modules. Please select `yes`. -![](../image/ide-java-5.png) +![Reload the Maven project](../image/ide-java-5.png) #### The final project structure should be like this: -![](../image/ide-java-3.png) +![The final correct project structure](../image/ide-java-3.png) ### Run unit tests @@ -60,30 +60,30 @@ More details can be found on [Compile Sedona](../setup/compile.md) In the IDE, right-click a test case and run this test case. -![](../image/ide-java-6.png) +![Right click a test case to run](../image/ide-java-6.png) When you run a test case written in Scala, the IDE might tell you that the "Path does not exist" as follows: -![](../image/ide-java-7.png) +![Path does not exist](../image/ide-java-7.png) Go to `Edit Configuration` -![](../image/ide-java-8.png) +![Edit Configuration](../image/ide-java-8.png) Change the value of `Working Directory` to `$MODULE_WORKING_DIR$`. -![](../image/ide-java-9.png) +![Change the working directory](../image/ide-java-9.png) Re-run the test case. Do NOT right-click the test case to re-run. Instead, click the button as shown in the figure below. -![](../image/ide-java-10.png) +![Re-run test case by clicking the button](../image/ide-java-10.png) If you don't want to change the `Working Directory` configuration every time, you can change the default value of `Working Directory` in the `Run/Debug Configurations` window. Click `Edit configuration templates...` and change the value of `Working Directory` of ScalaTest to `$MODULE_WORKING_DIR$`. -![](../image/ide-java-11.png) -![](../image/ide-java-12.png) +![Run/Debug Configurations click Edit configuration templates](../image/ide-java-11.png) +![Set ScalaTest Working directory](../image/ide-java-12.png) Now newly created run configurations for ScalaTest will have the correct value set for `Working Directory`. @@ -99,7 +99,7 @@ sun.misc.Unsafe You can fix this issue by disabling `Use '--release' option for cross-compilation` in the IDE settings. -![](../image/ide-java-13.png) +![Disable "Use '--release' option for cross-compilation" when using Java 11](../image/ide-java-13.png) ## Python developers diff --git a/docs/setup/fabric.md b/docs/setup/fabric.md index aa5ca6ee68..9eb3e82d5a 100644 --- a/docs/setup/fabric.md +++ b/docs/setup/fabric.md @@ -4,25 +4,25 @@ This tutorial will guide you through the process of installing Sedona on Microso Go to the [Microsoft Fabric portal](https://app.fabric.microsoft.com/) and choose the `Data Engineering` option. -![](../image/fabric/fabric-1.png) +![Microsoft Fabric portal](../image/fabric/fabric-1.png) ## Step 2: Create a Microsoft Fabric Data Engineering environment On the left side, click `My Workspace` and then click `+ New` to create a new `Environment`. Let's name it `ApacheSedona`. -![](../image/fabric/fabric-2.png) +![Create new Data Engineering environment](../image/fabric/fabric-2.png) ## Step 3: Select the Apache Spark version In the `Environment` page, click the `Home` tab and select the appropriate version of Apache Spark. You will need this version to install the correct version of Apache Sedona. -![](../image/fabric/fabric-3.png) +![Add the appropriate version of Apache Spark to the Environment page Home tab](../image/fabric/fabric-3.png) ## Step 4: Install the Sedona Python package In the `Environment` page, click the `Public libraries` tab and then type in `apache-sedona`. Please select the appropriate version of Apache Sedona. The source is `PyPI`. -![](../image/fabric/fabric-4.png) +![Add the appropriate version of Apache Sedona to the Environment page Public libraries](../image/fabric/fabric-4.png) ## Step 5: Set Spark properties @@ -32,13 +32,13 @@ In the `Environment` page, click the `Spark properties` tab, then create the fol - `spark.serializer`: `org.apache.spark.serializer.KryoSerializer` - `spark.kryo.registrator`: `org.apache.sedona.core.serde.SedonaKryoRegistrator` -![](../image/fabric/fabric-5.png) +![Add 3 properties to the Environment page Spark properties tab](../image/fabric/fabric-5.png) ## Step 6: Save and publish the environment Click the `Save` button and then click the `Publish` button to save and publish the environment. This will create the environment with the Apache Sedona Python package installed. The publishing process will take about 10 minutes. -![](../image/fabric/fabric-6.png) +![Save and publish the environment](../image/fabric/fabric-6.png) ## Step 7: Find the download links of Sedona jars @@ -57,7 +57,7 @@ https://repo1.maven.org/maven2/org/datasyslab/geotools-wrapper/1.5.1-28.2/geotoo In the notebook page, select the `ApacheSedona` environment you created before. -![](../image/fabric/fabric-9.png) +![Start the notebook with the Sedona environment and install the jars](../image/fabric/fabric-9.png) In the notebook, you can install the jars by running the following code. Please replace the `jars` with the download links of the 2 jars from the previous step. @@ -84,7 +84,7 @@ sedona.sql("SELECT ST_GeomFromEWKT('SRID=4269;POINT(40.7128 -74.0060)')").show() If you see the output of the point, then the installation is successful. -![](../image/fabric/fabric-10.png) +![Verify the installation](../image/fabric/fabric-10.png) ## Optional: manually upload Sedona jars to the Fabric environment LakeHouse storage @@ -100,9 +100,9 @@ abfss://9e9d4196-870a-4901-8fa5-e24841492ab8@onelake.dfs.fabric.microsoft.com/e1 abfss://9e9d4196-870a-4901-8fa5-e24841492ab8@onelake.dfs.fabric.microsoft.com/e15f3695-af7e-47de-979e-473c3caa9f5b/Files/geotools-wrapper-1.5.1-28.2.jar ``` -![](../image/fabric/fabric-7.png) +![Sedona notebook tab Lakehouses data source](../image/fabric/fabric-7.png) -![](../image/fabric/fabric-8.png) +![From Files upload the jars and then copy their ABFS paths](../image/fabric/fabric-8.png) If you use this option, the config files in your notebook should be diff --git a/docs/setup/overview.md b/docs/setup/overview.md index 1d297f443c..0ca6668af5 100644 --- a/docs/setup/overview.md +++ b/docs/setup/overview.md @@ -1,9 +1,9 @@ # Download statistics -| Download statistics | **Maven** | **PyPI** | Conda-forge | **CRAN** | **DockerHub** | -|----------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| -| Apache Sedona | 225k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/apache-sedona)](https://pepy.tech/project/apache-sedona) [![Downloads](https://static.pepy.tech/personalized-badge/apache-sedona?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/apache-sedona) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/apache-sedona/badges/downloads.svg)](https://anaconda.org/conda-forge/apache-sedona) | [![](https://cranlogs.r-pkg.org/badges/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) [![](https://cranlogs.r-pkg.org/badges/grand-total/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) | [![Docker pulls](https://img.shields.io/docker/pulls/apache/sedona?color=brightgreen)](https://hub.docker.com/r/apache/sedona) | -| Archived GeoSpark releases | 10k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/geospark)](https://pepy.tech/project/geospark)[![Downloads](https://static.pepy.tech/personalized-badge/geospark?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/geospark) | | | | +| Download statistics | **Maven** | **PyPI** | Conda-forge | **CRAN** | **DockerHub** | +|----------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Apache Sedona | 225k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/apache-sedona)](https://pepy.tech/project/apache-sedona) [![Downloads](https://static.pepy.tech/personalized-badge/apache-sedona?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/apache-sedona) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/apache-sedona/badges/downloads.svg)](https://anaconda.org/conda-forge/apache-sedona) | [![CRAN downloads per month](https://cranlogs.r-pkg.org/badges/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) [![Total CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/apache.sedona?color=brightgreen)](https://cran.r-project.org/package=apache.sedona) | [![Docker pulls](https://img.shields.io/docker/pulls/apache/sedona?color=brightgreen)](https://hub.docker.com/r/apache/sedona) | +| Archived GeoSpark releases | 10k/month | [![PyPI - Downloads](https://img.shields.io/pypi/dm/geospark)](https://pepy.tech/project/geospark)[![Downloads](https://static.pepy.tech/personalized-badge/geospark?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=total%20downloads)](https://pepy.tech/project/geospark) | | | | # What can Sedona do? diff --git a/docs/setup/snowflake/install.md b/docs/setup/snowflake/install.md index f961f08797..f28203478f 100644 --- a/docs/setup/snowflake/install.md +++ b/docs/setup/snowflake/install.md @@ -20,11 +20,11 @@ A stage is a Snowflake object that maps to a location in a cloud storage provide In this case, we will create a stage named `ApacheSedona` in the `public` schema of the database created in the previous step. The stage will be used to load Sedona's JAR files into the database. We will choose a `Snowflake managed` stage. -![](../../image/snowflake/snowflake-1.png) +![Create a stage in the database](../../image/snowflake/snowflake-1.png) After creating the stage, you should be able to see the stage in the database. -![](../../image/snowflake/snowflake-2.png) +![Viewing the stage in the database](../../image/snowflake/snowflake-2.png) You can refer to [Snowflake Documentation](https://docs.snowflake.com/en/sql-reference/sql/create-stage.html) to how to create a stage. @@ -39,7 +39,7 @@ Then you can upload the 2 JAR files to the stage created in the previous step. After uploading the 2 JAR files, you should be able to see the 2 JAR files in the stage. -![](../../image/snowflake/snowflake-3.png) +![The 2 JAR files in the stage](../../image/snowflake/snowflake-3.png) You can refer to [Snowflake Documentation](https://docs.snowflake.com/en/sql-reference/sql/put.html) to how to upload files to a stage. @@ -49,11 +49,11 @@ A schema is a Snowflake object that maps to a database. You can use a schema to In this case, we will create a schema named `SEDONA` in the database created in the previous step. The schema will be used to create Sedona's functions. -![](../../image/snowflake/snowflake-4.png) +![Create a schema in the database](../../image/snowflake/snowflake-4.png) You can find your schema in the database as follows: -![](../../image/snowflake/snowflake-5.png) +![Find your schema in the database](../../image/snowflake/snowflake-5.png) You can refer to [Snowflake Documentation](https://docs.snowflake.com/en/sql-reference/sql/create-schema.html) to how to create a schema. @@ -73,11 +73,11 @@ We will create a worksheet in the database created in the previous step, and run In this case, we will choose the option `Create Worksheet from SQL File`. -![](../../image/snowflake/snowflake-6.png) +![Create Worksheet from SQL File](../../image/snowflake/snowflake-6.png) In the worksheet, choose `SEDONA_TEST` as the database, and `PUBLIC` as the schema. The SQL script should be in the worksheet. Then right-click the worksheet and choose `Run All`. Snowflake will take 3 minutes to create Sedona's functions. -![](../../image/snowflake/snowflake-7.png) +![Run the SQL script to create Sedona's functions](../../image/snowflake/snowflake-7.png) ## Step 6: Verify the installation @@ -95,4 +95,4 @@ SRID=4326;POINT (1 2) The worksheet should look like this: -![](../../image/snowflake/snowflake-8.png) +![Verify the installation worksheet output](../../image/snowflake/snowflake-8.png) diff --git a/docs/tutorial/sql.md b/docs/tutorial/sql.md index ae71b10e9c..4b71ee3cd4 100644 --- a/docs/tutorial/sql.md +++ b/docs/tutorial/sql.md @@ -876,7 +876,7 @@ SedonaPyDeck.create_choropleth_map(df=groupedresult, plot_col='AirportCount') !!!Note `plot_col` is a required argument informing SedonaPyDeck of the column name used to render the choropleth effect. -![](../image/choropleth.gif) +![Creating a Choropleth map using SedonaPyDeck](../image/choropleth.gif) The dataset used is available [here](https://github.com/apache/sedona/tree/4c5fa8333b2c61850d5664b878df9493c7915066/binder/data/ne_50m_airports) and can also be found in the example notebook available [here](https://github.com/apache/sedona/blob/4c5fa8333b2c61850d5664b878df9493c7915066/binder/ApacheSedonaSQL_SpatialJoin_AirportsPerCountry.ipynb) @@ -891,7 +891,7 @@ Example (referenced from overture notebook available via binder): SedonaPyDeck.create_geometry_map(df_building, elevation_col='height') ``` -![](../image/buildings.gif) +![Creating a Geometry map using SedonaPyDeck](../image/buildings.gif) !!!Tip `elevation_col` is an optional argument which can be used to render a 3D map. Pass the column with 'elevation' values for the geometries here. @@ -906,7 +906,7 @@ Example: SedonaPyDeck.create_scatterplot_map(df=crimes_df) ``` -![](../image/points.gif) +![Creating a Scatterplot map using SedonaPyDeck](../image/points.gif) The dataset used here is the Chicago crimes dataset, available [here](https://github.com/apache/sedona/blob/sedona-1.5.0/spark/common/src/test/resources/Chicago_Crimes.csv) @@ -920,7 +920,7 @@ Example: SedonaPyDeck.create_heatmap(df=crimes_df) ``` -![](../image/heatmap.gif) +![Creating a heatmap using SedonaPyDeck](../image/heatmap.gif) The dataset used here is the Chicago crimes dataset, available [here](https://github.com/apache/sedona/blob/sedona-1.5.0/spark/common/src/test/resources/Chicago_Crimes.csv) @@ -944,7 +944,7 @@ Example (referenced from an example notebook via the binder): SedonaKepler.create_map(df=groupedresult, name="AirportCount") ``` -![](../image/sedona_customization.gif) +![Visualize geospatial data using SedonaKepler](../image/sedona_customization.gif) The dataset used is available [here](https://github.com/apache/sedona/tree/4c5fa8333b2c61850d5664b878df9493c7915066/binder/data/ne_50m_airports) and can also be found in the example notebook available [here](https://github.com/apache/sedona/blob/4c5fa8333b2c61850d5664b878df9493c7915066/binder/ApacheSedonaSQL_SpatialJoin_AirportsPerCountry.ipynb) diff --git a/docs/tutorial/viz-gallery.md b/docs/tutorial/viz-gallery.md index 68e7d4f95d..6d8690b270 100644 --- a/docs/tutorial/viz-gallery.md +++ b/docs/tutorial/viz-gallery.md @@ -1,5 +1,5 @@ -![](../image/usrail.png) +![USA rail](../image/usrail.png) -![](../image/ustweet.png) +![USA tweets](../image/ustweet.png) -![](../image/heatmapnycsmall.png) +![Heatmap of New York City](../image/heatmapnycsmall.png) diff --git a/docs/tutorial/zeppelin.md b/docs/tutorial/zeppelin.md index cd2a8e9a66..51e202496b 100644 --- a/docs/tutorial/zeppelin.md +++ b/docs/tutorial/zeppelin.md @@ -28,7 +28,7 @@ FROM wktpoint Select the geometry column to visualize: -![](../image/sql-zeppelin.gif) +![Create an SQL paragraph to fetch the data and then select the geometry column](../image/sql-zeppelin.gif) ## Large-scale with SedonaViz @@ -57,7 +57,7 @@ FROM images Select the image and its geospatial boundary: -![](../image/viz-zeppelin.gif) +![Selecting the image and its boundary](../image/viz-zeppelin.gif) ## Zeppelin Spark notebook demo diff --git a/python/README.md b/python/README.md index 9447d5975e..1ec3dcb55e 100644 --- a/python/README.md +++ b/python/README.md @@ -1,6 +1,6 @@ # Apache Sedona - + This library is the Python wrapper for Apache Sedona.