This is an automated email from the ASF dual-hosted git repository.
prantogg pushed a commit to branch update-docs
in repository https://gitbox.apache.org/repos/asf/sedona-spatialbench.git
The following commit(s) were added to refs/heads/update-docs by this push:
new 71f2cc7 add quickstart.md
71f2cc7 is described below
commit 71f2cc795b72e1f41777a5fc03d4dc370aa22747
Author: Pranav Toggi <[email protected]>
AuthorDate: Thu Nov 13 16:53:29 2025 -0800
add quickstart.md
---
docs/quickstart.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
mkdocs.yml | 1 +
2 files changed, 97 insertions(+)
diff --git a/docs/quickstart.md b/docs/quickstart.md
new file mode 100644
index 0000000..8632e40
--- /dev/null
+++ b/docs/quickstart.md
@@ -0,0 +1,96 @@
+---
+title: Quickstart
+---
+
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+## Installation
+
+Install from source:
+
+```shell
+git clone https://github.com/apache/sedona-spatialbench.git
+cd sedona-spatialbench
+cargo install --path spatialbench-cli
+```
+
+After installation, you should be able to run:
+
+```shell
+spatialbench-cli --help
+```
+
+## Generate SF1 Data
+
+To generate the full dataset at scale factor 1 in Parquet format:
+```shell
+spatialbench-cli --scale-factor 1
+```
+
+This creates six tables:
+* trip
+* customer
+* driver
+* vehicle
+* zone
+* building
+
+Output is written to the current directory by default.
+
+## Customizing Output files
+
+We'll go over a few common options to customize the output files. To see all
available options, run `spatialbench-cli --help`.
+
+### Generate a Subset of Tables
+
+```shell
+spatialbench-cli --scale-factor 1 --tables trip,building
+```
+
+### Partition Table Output into Multiple Files
+
+Specify the number of partitions manually:
+```shell
+spatialbench-cli --scale-factor 10 --tables trip --parts 4
+```
+
+Or let the CLI determine the number of files using target size:
+```shell
+spatialbench-cli --scale-factor 10 --mb-per-file 512
+```
+
+### Set Output Directory
+
+```shell
+spatialbench-cli --scale-factor 1 --output-dir data/sf1
+```
+
+## Configuring Spatial Distributions
+
+SpatialBench uses a spatial data generator to generate synthetic points and
polygons using realistic spatial distributions.
+
+To read more about the different spatial distributions offered by SpatialBench
see [here](https://sedona.apache.org/spatialbench/spatialbench-distributions/).
+For more details about tuning the spatial distributions and the full YAML
schema and examples, see
[CONFIGURATION.md](./spatialbench-cli/CONFIGURATION.md).
+
+You can override these defaults at runtime by passing a YAML file via the
`--config` flag:
+
+```shell
+spatialbench-cli --scale-factor 1 --config spatialbench-config.yml
+```
+
+If --config is not provided, SpatialBench checks for
./spatialbench-config.yml. If absent, it falls back to built-in defaults.
diff --git a/mkdocs.yml b/mkdocs.yml
index c6defdc..7cfe797 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -50,6 +50,7 @@ nav:
- SedonaDB: https://sedona.apache.org/sedonadb/
- SpatialBench:
- Home: index.md
+ - Quickstart: quickstart.md
- Methodology: overview-methodology.md
- Queries: queries.md
- Datasets & Generators: datasets-generators.md
