Skip to content

Commit 812be23

Browse files
Updated documentation
1 parent bf389c3 commit 812be23

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,15 @@ DvG_RingBuffer
1919
Numpy ring buffer at a *fixed* memory address to allow for significantly
2020
sped up ``numpy``, ``sigpy``, ``numba`` & ``pyFFTW`` calculations.
2121

22-
**Based on:**
22+
- Github: https://github.com/Dennis-van-Gils/python-dvg-ringbuffer
23+
- PyPI: https://pypi.org/project/dvg-ringbuffer
24+
25+
Installation:
26+
27+
``pip install dvg-ringbuffer``
28+
29+
Based on:
30+
2331
https://pypi.org/project/numpy_ringbuffer/ by Eric Wieser.
2432

2533
``DvG_RingBuffer`` can be used as a drop-in replacement for
@@ -142,6 +150,8 @@ Indexing & slicing
142150

143151
.. code-block:: python
144152
153+
from dvg_ringbuffer import RingBuffer
154+
145155
rb = RingBuffer(4, dtype=np.int) # --> rb[:] = array([], dtype=int32)
146156
rb.extend([1, 2, 3, 4, 5]) # --> rb[:] = array([2, 3, 4, 5])
147157
x = rb[0] # --> x = 2

src/dvg_ringbuffer.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,15 @@
33
"""Numpy ring buffer at a *fixed* memory address to allow for significantly
44
sped up ``numpy``, ``sigpy``, ``numba`` & ``pyFFTW`` calculations.
55
6-
**Based on:**
6+
- Github: https://github.com/Dennis-van-Gils/python-dvg-ringbuffer
7+
- PyPI: https://pypi.org/project/dvg-ringbuffer
8+
9+
Installation:
10+
11+
``pip install dvg-ringbuffer``
12+
13+
Based on:
14+
715
https://pypi.org/project/numpy_ringbuffer/ by Eric Wieser.
816
917
``DvG_RingBuffer`` can be used as a drop-in replacement for
@@ -126,6 +134,8 @@
126134
127135
.. code-block:: python
128136
137+
from dvg_ringbuffer import RingBuffer
138+
129139
rb = RingBuffer(4, dtype=np.int) # --> rb[:] = array([], dtype=int32)
130140
rb.extend([1, 2, 3, 4, 5]) # --> rb[:] = array([2, 3, 4, 5])
131141
x = rb[0] # --> x = 2

0 commit comments

Comments
 (0)