Skip to content

Docs updates - multithreading/process recommendations + strikethrough of disk serialization #307

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Docs updates - multithreading/process recommendations + strikethrough of disk serialization #307

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
e0e956e
Added strikethrough to Disk serialization
codeananda Feb 13, 2024
94905b9
Added multithread/process explainer + recommendations to get around them
codeananda Feb 13, 2024
0f98826
Added same multithread/process updates to index.rst
codeananda Feb 13, 2024
d8b19a1
Added disk serialization is broken as of Jan 2024 message to index.rst
codeananda Feb 13, 2024
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,22 @@ user. These features include:
* Clustered indexes (store Python pickles directly with index entries)
* Bulk loading
* Deletion
* Disk serialization
* ~~Disk serialization~~ [currently broken as of Jan 2024](https://github.com/Toblerity/rtree/pull/197)
* Custom storage implementation (to implement spatial indexing in ZODB, for example)

These features do not include:

* Multithread safety (for reading or writing)
* Multiprocess safety (for reading or writing)

For either of these, we recommend using:

* A PostGIS database, or
* GeoPandas + spatial joining, or
* Building an rtree from scratch in each thread/process (using [generator syntax](https://rtree.readthedocs.io/en/latest/performance.html#use-stream-loading))

Note that since rtree is written in C, it can be orders of magnitude faster than a
database even if running sequentially.

Wheels are available for most major platforms, and `rtree` with bundled `libspatialindex` can be installed via pip:

Expand Down
17 changes: 16 additions & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,23 @@ user. These features include:
* Clustered indexes (store Python pickles directly with index entries)
* Bulk loading
* Deletion
* Disk serialization
* Disk serialization (`currently broken as of Jan 2024`_)
* Custom storage implementation (to implement spatial indexing in ZODB, for example)

These features do not include:

* Multithread safety (for reading or writing)
* Multiprocess safety (for reading or writing)

For either of these, we recommend using:

* A PostGIS database, or
* GeoPandas + spatial joining, or
* Building an rtree from scratch in each thread/process (using [generator syntax](https://rtree.readthedocs.io/en/latest/performance.html#use-stream-loading))

Note that since rtree is written in C, it can be orders of magnitude faster than a
database even if running sequentially.

Documentation
..............................................................................

Expand All @@ -34,6 +48,7 @@ Documentation
* :ref:`modindex`
* :ref:`search`

.. _`currently broken as of Jan 2024`: https://github.com/Toblerity/rtree/pull/197
.. _`R-trees`: https://en.wikipedia.org/wiki/R-tree
.. _`ctypes`: https://docs.python.org/3/library/ctypes.html
.. _`libspatialindex`: https://libspatialindex.org
Expand Down