Merge pull request #13 from domengorjup/master

ENH: Added Showcase, updated readme

Author: domengorjup

.gitignore

@@ -98,3 +98,4 @@ ENV/
 
 # other
 server_user_id.txt
+temp/

Showcase.ipynb

@@ -30,7 +30,7 @@
 import warnings
 import xmltodict
 
-__version__ = '0.31'
+__version__ = '0.32'
 
 SUPPORTED_FILE_FORMATS = ['mraw', 'tiff']
 SUPPORTED_EFFECTIVE_BIT_SIDE = ['lower', 'higher']

pyMRAW.py

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyMRAW"
-version = "0.31"
+version = "0.32"
 authors = [{name = "Jaka Javh, Janko Slavič, Domen Gorjup", email = "janko.slavic@fs.uni-lj.si"}]
 maintainers = [{name = "Janko Slavič et al.", email = "janko.slavic@fs.uni-lj.si"}]
 license = "MIT"

pyproject.toml

@@ -3,6 +3,21 @@ pyMRAW
 
 Photron MRAW File Reader.
 -------------------------
+
+`pyMRAW` is an open-source package, enabling the efficient use of the Photron MRAW video files in Python workflows.
+
+It's main feature is the use of memory-mapped ([`np.memmap`](https://numpy.org/doc/stable/reference/generated/numpy.memmap.html)) arrays to create memory maps to locally stored raw video files and avoid loading large amounts of data into RAM. 
+
+.. warning::
+    To take advantage of pyMRAW's memory-mapping functionality, make sure to save MRAW files either in 8-bit or 16-bit formats, corresponding to standard data types `uint8` and `uint16`! Using pyMRAW to read 12-bit MRAW files is possible, but requires loading the complete image data into RAM to produce standard Numpy arrays.
+
+To load `.mraw` - `.cihx` files, simply use the `pymraw.load_video` function::
+
+    import pyMRAW
+    images, info = pyMRAW.load_video('data/beam.cihx')
+
+For more info, please refer to the `Showcase.ipynb` notebook.
+
 We developed this module while working on this publication:
 J. Javh, J. Slavič and M. Boltežar: The Subpixel Resolution of Optical-Flow-Based Modal Analysis,
 Mechanical Systems and Signal Processing, Vol. 88, p. 89–99, 2017