Skip to content

Commit 032bf3d

Browse files
committed
edit docs
1 parent 7f259a8 commit 032bf3d

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/release.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,9 @@ Documentation
146146
* A new tutorial section on :ref:`tutorial_pickle` has been added (:issue:`91`).
147147
* A new tutorial section on :ref:`tutorial_datetime` has been added.
148148
* A new tutorial section on :ref:`tutorial_diagnostics` has been added.
149+
* The tutorial sections on :ref:`tutorial_sync` and :ref:`tutorial_tips_blosc` have been
150+
updated to provide information about how to avoid program hangs when using the Blosc
151+
compressor with multiple processes (:issue:`199`, :issue:`201`).
149152

150153
Maintenance
151154
~~~~~~~~~~~
@@ -161,7 +164,8 @@ Acknowledgments
161164
Code was contributed to this release by :user:`John Kirkham <jakirkham>` and
162165
:user:`Prakhar Goel <newt0311>`.
163166

164-
Documentation was contributed to this release by :user:`Mamy Ratsimbazafy <mratsim>`.
167+
Documentation was contributed to this release by :user:`Mamy Ratsimbazafy <mratsim>`
168+
and :user:`Charles Noyes <CSNoyes>`.
165169

166170
Thank you to :user:`John Kirkham <jakirkham>`, :user:`Stephan Hoyer <shoyer>`,
167171
:user:`Francesc Alted <FrancescAlted>`, and :user:`Matthew Rocklin <mrocklin>` for code

docs/tutorial.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -981,10 +981,10 @@ some networked file systems). E.g.::
981981

982982
This array is safe to read or write from multiple processes.
983983

984-
When using multiple processes to parallelize reads or writes with the blosc
985-
compression library, it is necessary to set ``zarr.blosc.use_threads = False``,
986-
as blosc's context manager will share incorrect global state amongst processes.
987-
Disabling will allow the 'contextual' manager to have correct local state.
984+
When using multiple processes to parallelize reads or writes on arrays using the Blosc
985+
compression library, it may be necessary to set ``numcodecs.blosc.use_threads = False``,
986+
as otherwise Blosc may share incorrect global state amongst processes causing programs
987+
to hang. See also the section on :ref:`tutorial_tips_blosc` below.
988988

989989
Please note that support for parallel computing is an area of ongoing research
990990
and development. If you are using Zarr for parallel computing, we welcome
@@ -1087,7 +1087,7 @@ Configuring Blosc
10871087
~~~~~~~~~~~~~~~~~
10881088

10891089
The Blosc compressor is able to use multiple threads internally to accelerate
1090-
compression and decompression. By default, Zarr allows Blosc to use up to 8
1090+
compression and decompression. By default, Blosc uses up to 8
10911091
internal threads. The number of Blosc threads can be changed to increase or
10921092
decrease this number, e.g.::
10931093

0 commit comments

Comments
 (0)