Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pauldmccarthy authored Jun 16, 2016
1 parent db9f56d commit 3c5c5f5
Showing 1 changed file with 26 additions and 25 deletions.
51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# indexed_gzip


*Fast random access of gzip files in Python*


* [Overview](#overview)
* [Acknowledgements](#acknowledgements)
* [Installation](#installation)
* [Usage](#usage)
* [Performance](#performance)
* [Acknowledgements](#acknowledgements)
* [License](#license)


Expand Down Expand Up @@ -41,32 +42,9 @@ only have to decompress (on average) 512KB of data to read from any location
in the file.


## Acknowledgements


The `indexed_gzip` project is based upon the `zran.c` example (written by Mark
Alder) which ships with the [zlib](http://www.zlib.net/) source code.


`indexed_gzip` was originally inspired by:

Z. Rajna, A. Keskinarkaus, V. Kiviniemi and T. Seppanen
"Speeding up the file access of large compressed NIfTI neuroimaging data"
Engineering in Medicine and Biology Society (EMBC), 2015 37th Annual
International Conference of the IEEE, Milan, 2015, pp. 654-657.

https://sourceforge.net/projects/libznzwithzindex/


Initial work on `indexed_gzip` took place at
[Brainhack](http://www.brainhack.org/) Paris, at the Institut Pasteur,
24th-26th February 2016, with the support of the
[FMRIB Centre](https://www.ndcn.ox.ac.uk/divisions/fmrib/), at the
University of Oxford, UK.


## Installation


1. Make sure you have [cython](http://cython.org/) installed.

2. Compile the python extension:
Expand Down Expand Up @@ -228,6 +206,29 @@ If you don't want to look at the numbers:
| 2542.21 | 5619.39 | 11 | 94.50 | 37.63 |
## Acknowledgements
The `indexed_gzip` project is based upon the `zran.c` example (written by Mark
Alder) which ships with the [zlib](http://www.zlib.net/) source code.
`indexed_gzip` was originally inspired by:
Z. Rajna, A. Keskinarkaus, V. Kiviniemi and T. Seppanen
"Speeding up the file access of large compressed NIfTI neuroimaging data"
Engineering in Medicine and Biology Society (EMBC), 2015 37th Annual
International Conference of the IEEE, Milan, 2015, pp. 654-657.
https://sourceforge.net/projects/libznzwithzindex/
Initial work on `indexed_gzip` took place at
[Brainhack](http://www.brainhack.org/) Paris, at the Institut Pasteur,
24th-26th February 2016, with the support of the
[FMRIB Centre](https://www.ndcn.ox.ac.uk/divisions/fmrib/), at the
University of Oxford, UK.
## License
Expand Down

0 comments on commit 3c5c5f5

Please sign in to comment.