Better support/documentation for repairing corrupt workspaces

[csadorf]

Original report by Jens Glaser (Bitbucket: jens_glaser, GitHub: jglaser).

---

The project.repair() functionality is useful, but it doesn't always succeed e.g. if the signac_statepoint.json is an empty file for some reason.

In that case one would want to be able to remove the entire job directory. Since this is a dangerous operation, it would make sense to do it manually. However, some documentation example for this use case would be useful.

I am using the following script to clean my workspace from broken jobs:

import signac

from signac.contrib import errors

project = signac.get_project()

try:
    project.repair()
except signac.contrib.errors.JobsCorruptedError as e:
    import shutil
    for job in e.job_ids:
        print('Removing job {}'.format(job))
        shutil.rmtree('workspace/'+job+'/')