1 files changed, 41 insertions, 0 deletions
diff --git a/mapreduce/README.md b/mapreduce/README.md
new file mode 100644
index 0000000..b063fba
--- /dev/null
+++ b/mapreduce/README.md
@@ -0,0 +1,41 @@
+
+## Development and Testing
+
+Requires (eg, via `apt`):
+
+- libjpeg-dev
+
+Install pipenv system-wide if you don't have it:
+
+    # or use apt, homebrew, etc
+    sudo pip3 install pipenv
+
+Run the tests with:
+
+    pipenv run pytest
+
+TODO: GROBID and HBase during development?
+
+## Backfill
+
+An example actually connecting to HBase from a local machine, with thrift
+running on a devbox:
+
+    ./backfill_hbase_from_cdx.py tests/files/example.cdx \
+        --hbase-table wbgrp-journal-extract-0-qa \
+        --hbase-host bnewbold-dev.us.archive.org
+
+Actual invocation to run on Hadoop cluster (running on an IA devbox, where
+hadoop environment is configured):
+
+    # Create tarball of virtualenv
+    pipenv shell
+    tar -czf backfill-4OmRI0zZ.tar.gz -C /home/bnewbold/.local/share/virtualenvs/backfill-4OmRI0zZ .
+
+    ./backfill_hbase_from_cdx.py \
+        -r hadoop \
+        --hbase-host bnewbold-dev.us.archive.org \
+        --hbase-table wbgrp-journal-extract-0-qa \
+        -c mrjob.conf \
+        --archive backfill-4OmRI0zZ.tar.gz#venv \
+        hdfs:///user/bnewbold/journal_crawl_cdx/citeseerx_crawl_2017.cdx