Metadata-Version: 2.4
Name: thread-chunks
Version: 1.0.4
Summary: A python package for performing memory intensive computations in parallel using chunks and checkpointing.
Project-URL: Homepage, https://github.com/Christopher-K-Long/thread-chunks
Project-URL: Documentation, https://thread-chunks.readthedocs.io/
Project-URL: Issues, https://github.com/Christopher-K-Long/thread-chunks/issues
Project-URL: Changelog, https://github.com/Christopher-K-Long/thread-chunks/blob/main/ChangeLog.md
Author-email: "Christopher_K._Long" <ckl45@cam.ac.uk>
Maintainer-email: "Christopher_K._Long" <ckl45@cam.ac.uk>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: checkpointing,chunk,chunking,chunks,multithreading,parallel,parallelisation,thread,threading
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# thread-chunks
A Python package for performing memory-intensive computations in parallel using chunks and checkpointing.

[![Unit Tests](https://github.com/Christopher-K-Long/thread-chunks/actions/workflows/test-python-package.yml/badge.svg)](https://github.com/Christopher-K-Long/thread-chunks/actions/workflows/test-python-package.yml)

## Installation

The Python package can be installed with pip as follows:
```bash
pip install thread-chunks
```

The PyPI page can be found here: [https://pypi.org/project/thread-chunks](https://pypi.org/project/thread-chunks).

### Requirements:

Python >= 3.7

Packages:

- [ray](https://www.ray.io/)
- [tqdm](https://tqdm.github.io/)
- [saveable-objects](https://saveable-objects.readthedocs.io/)

## Documentation

Documentation including worked examples can be found at: [https://thread-chunks.readthedocs.io/](https://thread-chunks.readthedocs.io/).

## Source Code

Source code can be found at: [https://github.com/Christopher-K-Long/thread-chunks](https://github.com/Christopher-K-Long/thread-chunks).


## Version and Changes

The current version is [`1.0.4`](ChangeLog.md#release-104). Please see the [Change Log](ChangeLog.md) for more
details.