pep8 style + file headers

Author: mz

SpatialPositionModel.py

@@ -5,10 +5,10 @@
                                  A QGIS plugin
  Compute spatial interaction models
                               -------------------
-        begin                : 2015-12-10
+        begin                : 2017-05-15
         git sha              : $Format:%H$
-        copyright            : (C) 2015 by #H
-        email                : mth@#!.org
+        copyright            : (C) 2015 by mthh
+        email                : [email protected]
  ***************************************************************************/
 
 /***************************************************************************
@@ -30,6 +30,7 @@
 from .SpatialPositionModel_utils import *
 import os.path
 
+
 class SpatialPositionModel:
     """QGIS Plugin Implementation."""
 
@@ -84,7 +85,6 @@ def tr(self, message):
         # noinspection PyTypeChecker,PyArgumentList,PyCallByClass
         return QCoreApplication.translate('SpatialPositionModel', message)
 
-
     def add_action(
         self,
         icon_path,
@@ -168,7 +168,6 @@ def initGui(self):
             callback=self.run,
             parent=self.iface.mainWindow())
 
-
     def unload(self):
         """Removes the plugin menu item and icon from QGIS GUI."""
         for action in self.actions:

SpatialPositionModel_dialog.py

@@ -4,11 +4,11 @@
  SpatialPositionModelDialog
                                  A QGIS plugin
  Compute spatial interaction models
-                             -------------------
-        begin                : 2015-12-10
+                              -------------------
+        begin                : 2017-05-15
         git sha              : $Format:%H$
-        copyright            : (C) 2015 by #H
-        email                : mth@#!.org
+        copyright            : (C) 2015 by mthh
+        email                : [email protected]
  ***************************************************************************/
 
 /***************************************************************************
@@ -200,24 +200,25 @@ def run_stewart(self):
         self.iface.setActiveLayer(pot_layer)
         self.iface.zoomToActiveLayer()
 
-    ## Todo : display better information/error message + show progression
+    # Todo : display better information/error message + show progression
     def display_log_error(self, error, msg_nb):
         error_msg = {
-#            1: "Error when loading the choosen matrix. See QGis log for error traceback.",
-            2: "The computation have been aborted, please choose a larger resolution value.",
+            2: ("The computation have been aborted, "
+                "please choose a larger resolution value."),
             3: "Error when generating the grid of unknownpts.",
             4: "Span, resolution and beta should not be set to 0.",
             5: "Crs mismatch between point and mask layers. Mask not used.",
             6: "Mask contains invalid geometries. Mask not used.",
-            7: "Unable to parse class breaks (levels must be increasing and sepated by a dash). Using default value of 7 class."
+            7: ("Unable to parse class breaks (levels must be increasing and "
+                "separated by a dash). Using default value of 7 class.")
             }
         QtGui.QMessageBox.information(
             self.iface.mainWindow(), 'Error', error_msg[msg_nb])
 
-
     def load_dataset(self):
-        home_path = \
-            os.getenv('HOMEPATH') or os.getenv('HOME') or os.getenv('USERPROFILE')
+        home_path = os.getenv('HOMEPATH') \
+            or os.getenv('HOME') \
+            or os.getenv('USERPROFILE')
         self.iface.addVectorLayer(os.sep.join(
             [home_path, '.qgis2', 'python', 'plugins', 'SpatialPositionModel',
              'test_data', 'paris_mask.geojson']),

SpatialPositionModel_utils.py

@@ -24,7 +24,7 @@ def parse_expression(expr):
                 if nexpr[-2] != ' ':
                     _ix = len(nexpr) - 1
                     nexpr.insert(_ix, ' ')
-                if expr[i+1] != ' ':
+                if expr[i + 1] != ' ':
                     nexpr.append(' ')
             except IndexError:
                 pass
@@ -108,31 +108,18 @@ def gen_unknownpts(pts_layer, mask_layer, resolution, longlat):
 
     return make_regular_points(bounds, resolution, longlat)
 
+
 def parse_class_breaks(class_breaks):
     try:
-        values = [float(i.strip().replace(',', '.')) for i in class_breaks.split('-')]
+        values = [float(i.strip().replace(',', '.'))
+                  for i in class_breaks.split('-')]
         last = -float('inf')
         for i in values:
             assert i > last
             last = i
         return values
     except:
         return None
-#def get_matdist_user(matdist, dim1, dim2):
-#    try:
-#        mat_dist = np.array([
-#             map(int, feat.attributes()[1:])
-#             for feat in matdist.getFeatures()
-#             ])
-#    except ValueError:
-#        mat_dist = np.array([
-#            map(float, feat.attributes()[1:])
-#            for feat in matdist.getFeatures()
-#            ])
-#    assert dim1 in mat_dist.shape \
-#        and dim2 in mat_dist.shape
-#    return mat_dist
-#
 
 
 def compute_opportunity(pts_values, matdens):
@@ -158,11 +145,11 @@ def get_height_width(bounds, longlat):
                 )
     else:
         height = np.linalg.norm(
-            np.array([(maxlon + minlon) / 2, minlat])
-            - np.array([(maxlon + minlon) / 2, maxlat])) / 1000
+            np.array([(maxlon + minlon) / 2, minlat]) -
+            np.array([(maxlon + minlon) / 2, maxlat])) / 1000
         width = np.linalg.norm(
-            np.array([minlon, (maxlat + minlat) / 2])
-            - np.array([maxlon, (maxlat + minlat) / 2])) / 1000
+            np.array([minlon, (maxlat + minlat) / 2]) -
+            np.array([maxlon, (maxlat + minlat) / 2])) / 1000
 
     return height, width
 
@@ -221,14 +208,16 @@ class ProbableMemoryError(Exception):
 def render_stewart(polygons, pot_layer, levels, nb_class, mask_layer):
     if mask_layer:
         try:
-            renderer = \
-                _render_stewart_mask(polygons, pot_layer, levels, nb_class, mask_layer)
+            renderer = _render_stewart_mask(
+                polygons, pot_layer, levels, nb_class, mask_layer)
             return (False, renderer)
         except:
-            renderer = _render_stewart(polygons, pot_layer, levels, nb_class)
+            renderer = _render_stewart(
+                polygons, pot_layer, levels, nb_class)
             return (True, renderer)
     else:
-        renderer = _render_stewart(polygons, pot_layer, levels, nb_class)
+        renderer = _render_stewart(
+            polygons, pot_layer, levels, nb_class)
         return (False, renderer)
 
 
@@ -244,7 +233,7 @@ def _render_stewart(polygons, pot_layer, levels, nb_class):
         if i == 0:
             last_level = 0
         else:
-            last_level = float(levels[i-1])
+            last_level = float(levels[i - 1])
         current_level = float(levels[i])
         ft = QgsFeature()
         ft.setGeometry(poly)
@@ -276,7 +265,7 @@ def _render_stewart_mask(polygons, pot_layer, levels, nb_class, mask_layer):
         if i == 0:
             last_level = 0
         else:
-            last_level = float(levels[i-1])
+            last_level = float(levels[i - 1])
         current_level = float(levels[i])
         if geom.area() > 0:
             ft = QgsFeature()
@@ -317,3 +306,19 @@ def qgsgeom_from_mpl_collec(collections):
         elif len(mpoly) == 1:
             polygons.append(QgsGeometry.fromPolygon(mpoly[0]))
     return polygons
+
+#def get_matdist_user(matdist, dim1, dim2):
+#    try:
+#        mat_dist = np.array([
+#             map(int, feat.attributes()[1:])
+#             for feat in matdist.getFeatures()
+#             ])
+#    except ValueError:
+#        mat_dist = np.array([
+#            map(float, feat.attributes()[1:])
+#            for feat in matdist.getFeatures()
+#            ])
+#    assert dim1 in mat_dist.shape \
+#        and dim2 in mat_dist.shape
+#    return mat_dist
+#

metadata.txt

@@ -1,7 +1,7 @@
-# This file contains metadata for your plugin. Since 
-# version 2.0 of QGIS this is the proper way to supply 
-# information about a plugin. The old method of 
-# embedding metadata in __init__.py will 
+# This file contains metadata for your plugin. Since
+# version 2.0 of QGIS this is the proper way to supply
+# information about a plugin. The old method of
+# embedding metadata in __init__.py will
 # is no longer supported since version 2.0.
 
 # This file should be included when you package your plugin.# Mandatory items:
@@ -11,13 +11,13 @@ name=SpatialPositionModel
 qgisMinimumVersion=2.8
 description=Compute spatial interaction models
 version=0.1
-author=#H
-email=mth@#!.org
+author=mthh
+email=[email protected]
 
-about=There are two main ways of modeling spatial interactions: the first one focuses on links between places (flows), the second one focuses on places and their influence at a distance. Following the physics metaphor, the flow may be seen as the gravitational force between two masses, the place influence as the gravitational potential. The SpatialPosition package, as its name suggests, proposes an implementation of place-based models: Stewart, Reilly and Huff models.
+about=There are two main ways of modeling spatial interactions: the first one focuses on links between places (flows), the second one focuses on places and their influence at a distance. Following the physics metaphor, the flow may be seen as the gravitational force between two masses, the place influence as the gravitational potential. This plugin proposes an implementation of a place-based model: Stewart potentials model.
 
-tracker= 
-repository= 
+tracker=
+repository=
 # End of mandatory metadata
 
 # Recommended items:
@@ -26,7 +26,7 @@ repository=
 # changelog=
 
 # Tags are comma separated with spaces allowed
-tags=
+tags=Potentials,Accessibility,Spatial analysis
 
 homepage=
 category=Plugins
@@ -36,4 +36,3 @@ experimental=True
 
 # deprecated flag (applies to the whole plugin, not just a single version)
 deprecated=False
-

pb_tool.cfg

@@ -16,22 +16,22 @@
 # *   (at your option) any later version.                                   *
 # *                                                                         *
 # ***************************************************************************/
-# 
-# 
+#
+#
 # You can install pb_tool using:
 #  pip install http://geoapt.net/files/pb_tool.zip
-# 
+#
 # Consider doing your development (and install of pb_tool) in a virtualenv.
-# 
+#
 # For details on setting up and using pb_tool, see:
 #  http://spatialgalaxy.net/qgis-plugin-development-with-pb_tool
 #
 # Issues and pull requests here:
 # https://github.com/g-sherman/plugin_build_tool:
-# 
+#
 # Sane defaults for your plugin generated by the Plugin Builder are
 # already set below.
-# 
+#
 # As you add Python source files and UI files to your plugin, add
 # them to the appropriate [files] section below.
 
@@ -48,7 +48,7 @@ python_files: __init__.py SpatialPositionModel.py SpatialPositionModel_dialog.py
 main_dialog: SpatialPositionModel_dialog_base.ui
 
 # Other ui files for dialogs you create (these will be compiled)
-compiled_ui_files: 
+compiled_ui_files:
 
 # Resource file(s) that will be compiled
 resource_files: resources.qrc
@@ -58,7 +58,7 @@ extras: metadata.txt icon.png
 
 # Other directories to be deployed with the plugin.
 # These must be subdirectories under the plugin directory
-extra_dirs:
+extra_dirs: test_data/
 
 # ISO code(s) for any locales (translations), separated by spaces.
 # Corresponding .ts files must exist in the i18n directory
@@ -67,8 +67,5 @@ locales:
 [help]
 # the built help directory that should be deployed with the plugin
 dir: help/build/html
-# the name of the directory to target in the deployed plugin 
+# the name of the directory to target in the deployed plugin
 target: help
-
-
-

readme.md

@@ -1,9 +1,9 @@
 SpatialPositionModel
 --------------------
 
-Python port of "Stewart Potentials" method from [R SpatialPosition package](https://github.com/Groupe-ElementR/SpatialPosition).
+Python port of "Stewart Potentials" method from [R SpatialPosition package](https://github.com/Groupe-ElementR/SpatialPosition) for [QGIS](http://qgis.org).
 Original package (documentation and R source code) are available on [GitHub](https://github.com/Groupe-ElementR/SpatialPosition) or on the [CRAN](https://cran.r-project.org/web/packages/SpatialPosition/).
-
+If you are only interested in computing potentials and drawing contour but not in QGIS, take a llo to the [smoomapy](https://pypi.python.org/pypi/smoomapy/) python package.
 
 **Stewart Potentials**  
 <img src="misc/stewart_screenshot.png" width="408.5" height="248.5">

test/test_SpatialPositionModel_dialog.py

@@ -8,9 +8,9 @@
 
 """
 
-__author__ = 'mth@#!.org'
+__author__ = '[email protected]'
 __date__ = '2015-12-10'
-__copyright__ = 'Copyright 2015, #H'
+__copyright__ = 'Copyright 2015, mthh'
 
 import unittest
 
@@ -52,4 +52,3 @@ def test_dialog_cancel(self):
     suite = unittest.makeSuite(SpatialPositionModelDialogTest)
     runner = unittest.TextTestRunner(verbosity=2)
     runner.run(suite)
-