Skip to content

Commit

Permalink
cuSpatial Python User Guide (#666)
Browse files Browse the repository at this point in the history
This PR adds `docs/source/user_guide/index.ipynb`, a comprehensive description of the APIs available in cuspatial python and example code for each.

The APIs are separated in a table of contents by the logical structure we've settled on for their location in the API. The demonstrate uses the `cuspatial.` version of every API, none are accessed using their full python package address.

At the bottom I'm working on some examples of performing `contains` and `within`, DE-9IM operations that can be performed easily with `point-in-polygon`. Otherwise the document is complete.

Depends on #685 and #680

This contributes to or closes #599 by providing an example use case of all python APIs.

Authors:
  - H. Thomson Comer (https://github.com/thomcom)

Approvers:
  - Mark Harris (https://github.com/harrism)
  - Michael Wang (https://github.com/isVoid)

URL: #666
  • Loading branch information
thomcom authored Sep 30, 2022
1 parent 6922ef5 commit 0becc88
Show file tree
Hide file tree
Showing 3 changed files with 1,408 additions and 2 deletions.
5 changes: 5 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@
"myst_parser"
]

jupyter_execute_notebooks = "force"
execution_timeout = 300

copybutton_prompt_text = ">>> "
autosummary_generate = True
ipython_mplbackend = "str"

# Add any paths that contain templates here, relative to this directory.
Expand Down
7 changes: 5 additions & 2 deletions docs/source/user_guide/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# User Guide

Coming soon!
```{toctree}
:maxdepth: 2
users
```
1,398 changes: 1,398 additions & 0 deletions docs/source/user_guide/users.ipynb

Large diffs are not rendered by default.

0 comments on commit 0becc88

Please sign in to comment.