Metadata-Version: 2.1
Name: PProgress
Version: 0.0.1
Summary: Simple Python progress bar for parallel programs.
Home-page: UNKNOWN
Author: Fergus Horrobin
Author-email: fergus.horrobin@mail.utoronto.ca
License: GPL
Platform: UNKNOWN

# PProgress: A progress bar for parallel for loops with MPI
### By Fergus Horrobin - fergus.horrobin@mail.utoronto.ca

## Features

Provides an all purpose Python based progress bar utility that can be run in
loops either running in serial or parallel with MPI or other utilities.
 - When using parallel loops, each parallel progress gets a progress bar.
 - The progress bar shows the percent completion of the tasks assigned to that
   process.
 - If there are multiple processes, all progress bars remain until the final one
   finishes.

## Installation

PProgess can simply be install using pip as:

    pip install pprogress

Then you can try out a simple serial example as:

```python
from pprogress import ProgressBar
from time import sleep

N = 100
pb = ProgressBar(N)
for i in range(N):
    pb.update()
    sleep(0.1)
pb.done()
```

## Documentation

Full documentation with parallel examples coming soon!


