Merge pull request #5 from mhogg/develop

v0.2.0 release
mhogg · Jun 7, 2016 · 5db7857 · 5db7857
2 parents 7dab19e + fb86540
commit 5db7857
Show file tree

Hide file tree

Showing 17 changed files with 83 additions and 633 deletions.
diff --git a/BMDanalyse/BMDanalyse.py b/BMDanalyse/BMDanalyse.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/MainWindow.py b/BMDanalyse/MainWindow.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/MatplotlibWidget.py b/BMDanalyse/MatplotlibWidget.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/ROI.py b/BMDanalyse/ROI.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/SidePanel.py b/BMDanalyse/SidePanel.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/TableWidget.py b/BMDanalyse/TableWidget.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/ViewBoxCustom.py b/BMDanalyse/ViewBoxCustom.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/__init__.py b/BMDanalyse/__init__.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/changelog.txt b/BMDanalyse/changelog.txt
@@ -1,5 +1,5 @@
 
-BMDanalyse 0.1.4, 2016-XX-XX
+BMDanalyse 0.2.0, 2016-06-07
 ----------------------------
 - Add setLevels to imageWin Viewbox image showing bone loss and gain. This is
   now a requirement in pyqtgraph-develop.

diff --git a/BMDanalyse/customItems.py b/BMDanalyse/customItems.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 

diff --git a/BMDanalyse/version.py b/BMDanalyse/version.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2013 Michael Hogg
+# Copyright (C) 2016 Michael Hogg
 
 # This file is part of BMDanalyse - See LICENSE.txt for information on usage and redistribution
 
-__version__ = '0.1.4'
+__version__ = '0.2.0'
diff --git a/BMDanalyse_build.bat b/BMDanalyse_build.bat
@@ -0,0 +1,5 @@
+REM Test build
+python setup.py sdist bdist_wheel 
+REM Upload to PyPi
+REM python setup.py sdist bdist_wheel upload
+
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Michael Hogg
+Copyright (c) 2016 Michael Hogg
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,48 @@
+==========
+BMDanalyse
+==========
+
+.. image:: https://img.shields.io/pypi/v/bmdanalyse.svg
+   :target: https://pypi.python.org/pypi/bmdanalyse/
+   :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/bmdanalyse.svg
+   :target: https://pypi.python.org/pypi/bmdanalyse/
+   :alt: Number of PyPI downloads
+
+Copyright 2016, Michael Hogg (michael.christopher.hogg@gmail.com)
+
+MIT license - See LICENSE.txt for details on usage and distribution
+
+-----
+About
+-----
+
+A graphical tool used for the regional analysis of a time series of 2D medical images. This was created for the analysis of virtual x-rays, created by companion tools `bonemapy`_ and `pyvXRAY`_ from the results of a computer simulation. Intended to be used to evaluate the bone gain / loss in a number of regions of interest (ROIs) over time, typically due to bone remodelling as a result of stress shielding around an orthopaedic implant.
+
+Written in pure Python using PyQt/PySide, pyqtgraph, numpy, matplotlib and pillow. Should work on any platform, but has only been tested on Windows.
+
+.. _bonemapy: https://github.com/mhogg/bonemapy
+.. _pyvxray: https://github.com/mhogg/pyvxray
+
+------------
+Requirements
+------------
+
+* Python 2.7
+* PyQt >= 4.11
+* pyqtgraph >= 0.9.10
+* numpy >= 1.9
+* matplotlib >= 1.4
+* pillow >= 3.0
+
+**NOTE:** All these requirements are available within the Anaconda Python distribution
+
+--------------------
+Instructions for use
+--------------------
+
+- Load a time series of 2D medical images (in image format such as bmp, png etc). All images should be grayscale and of the same size.
+- Use the up / down arrows in the Image toolbox to place the images in chronological order. A time series of virtual X-rays is provided in the sampleMedicalImages directory. 
+- Create some Regions of Interest (ROIs) and run the ROI analysis tool from the Analysis toolbox. A plot will be generated showing the change in the average grayscale value with each ROI over time.
+- Run the Image analysis tool from the Analysis toolbox. A contour will be displayed, showing regions of bone loss in blue and bone gain in red.