From f76b04b181f8157e955d36c0a0e0505806636392 Mon Sep 17 00:00:00 2001 From: Drew Frank Date: Mon, 15 Oct 2012 16:34:53 -0700 Subject: [PATCH] python: add small example to README. --- src/optional/python/README | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/optional/python/README b/src/optional/python/README index 93c8888d..278f008e 100644 --- a/src/optional/python/README +++ b/src/optional/python/README @@ -6,4 +6,24 @@ DataFrame object. See `help(gnuparallel.load)` for details. Installation: -`python setup.py install` + # python setup.py install + +Sample usage: + +1. Generate some results files by running parallel from the command line: + + # mkdir outdir + # parallel --results outdir/ echo {arg1} {arg2} ::: arg1 1 2 ::: arg2 three four + +2. Load the results using the gnuparallel Python package: + + # python + Python 2.7.3 (default, Apr 24 2012, 00:00:54) + [GCC 4.7.0 20120414 (prerelease)] on linux2 + Type "help", "copyright", "credits" or "license" for more information. + >>> import gnuparallel + >>> help(gnuparallel.load) + >>> myresults = gnuparallel.load('outdir') + +See documentation for the pandas project (http://pandas.pydata.org/) for +instructions on how to access and manipulate the loaded results.