Version 0.1.0 (see release)

README.md

@@ -6,10 +6,10 @@ This package unifies the io engines of itk, nibabel, and pydicom packages in a s
 It includes translation between the metadata conventions, reorientations, affine matrix computation.
 
 # Installation
-Download the [whl file](https://gitlab.com/rsip/medio/uploads/1e35cbb2e7b2c3206a42fe2cf1946f36/medio-0.0.1-py3-none-any.whl)
+Download the [whl file](https://drive.google.com/file/d/1slbkF2zk3vZmm6lHbXEfDDzP1ZUpIAg4/view?usp=sharing)
 and install it with:
 ```
-(<env-name>) C:\Users\<username>\Downloads>pip install medio-<m1>.<m2>.<m3>-py3-none-any.whl
+(<env-name>) C:\Users\<username>\Downloads>pip install medio-0.1.0-py3-none-any.whl
 ```
 This will install the medio python package and its dependencies in your environment.
 
@@ -19,16 +19,15 @@ The dependencies are:
 - itk (itk-io, itk-filtering)
 - nibabel
 - pydicom + dicom-numpy
-- (Optional: SimpleITK)
-
 
 A conda environment yml is in the project's root.
 
 # Usage
+There are 3 main functions in medio: `read_img`, `save_img` and `save_dir`.
 ```python
->>> from medio import read_img, save_img
->>> # read a dicom series from a folder
->>> img_arr, metadata = read_img('data/dicom-folder/', desired_ornt='IAR')
->>> # do your stuff and save in any format
->>> save_img('ct.nii.gz', img_arr, metadata, backend='nib')
+from medio import read_img, save_img
+# read a dicom series from a folder
+img_arr, metadata = read_img('data/dicom-folder/', desired_ornt='IAR')
+# do your stuff and save in any format
+save_img('ct.nii.gz', img_arr, metadata, backend='nib')
 ```

medio/__init__.py

@@ -1,6 +1,6 @@
 from medio.read_save import read_img, save_img, save_dir
 from medio import backends, metadata, utils, medimg
 
-__version__ = '0.0.1'
+__version__ = '0.1.0'
 
 __all__ = ['read_img', 'save_img', 'save_dir', '__version__']