pybraidz_chunked_iter: now available through PyPI

strawlab · Oct 26, 2023 · 05c7ec0 · 05c7ec0
1 parent 759b894
commit 05c7ec0
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/braidz-parser/braidz-chunked-iter/pybraidz-chunked-iter/README.md b/braidz-parser/braidz-chunked-iter/pybraidz-chunked-iter/README.md
@@ -1,5 +1,11 @@
 # pybraidz-chunked-iter - Chunked iteration over tables in `.braidz` files.
 
+## Installation
+
+This package is available through PyPI and can be installed with pip:
+
+    pip install pybraidz_chunked_iter
+
 ## Example usage
 
 See example usage in the "Chunked iteration of `kalman_estimates`" section of

diff --git a/braidz-parser/braidz-chunked-iter/pybraidz-chunked-iter/examples/read_to_pandas.py b/braidz-parser/braidz-chunked-iter/pybraidz-chunked-iter/examples/read_to_pandas.py
@@ -1,4 +1,4 @@
-import pybraidz_chunked_iter
+import pybraidz_chunked_iter # install with "pip install pybraidz_chunked_iter"
 import pandas as pd
 import sys
 

diff --git a/braidz-parser/braidz-chunked-iter/pybraidz-chunked-iter/examples/simple.py b/braidz-parser/braidz-chunked-iter/pybraidz-chunked-iter/examples/simple.py
@@ -1,4 +1,4 @@
-import pybraidz_chunked_iter
+import pybraidz_chunked_iter # install with "pip install pybraidz_chunked_iter"
 import sys
 
 # Get the filename of the braidz file from the command line.

diff --git a/strand-braid-user/users-guide/src/braidz-files.md b/strand-braid-user/users-guide/src/braidz-files.md
@@ -132,7 +132,7 @@ iterates over chunks of the file `20201104_174158.braidz`, which can be
 downloaded [here](https://strawlab-cdn.com/assets/20201104_174158.braidz):
 
 ```python
-import pybraidz_chunked_iter
+import pybraidz_chunked_iter # install with "pip install pybraidz_chunked_iter"
 import pandas as pd
 
 # The filename of the braidz file