diff --git a/README.md b/README.md index 0fdd90e..77b691d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # thread-chunks A python package for performing memory intensive computations in parallel using chunks and checkpointing. + +## Installation + +The python package can be installed with pip as follows: +```bash +pip install thread-chunks +``` + +### Requirements: +- [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.0`](ChangeLog.md#release-100). Please see the [Change Log](ChangeLog.md) for more +details. \ No newline at end of file