Merge pull request #17 from chrisvoncsefalvay/develop

Release for 0.2.0

sadie/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Chris von Csefalvay"""
 __email__ = 'chris@chrisvoncsefalvay.com'
-__version__ = '0.1.9'
+__version__ = '0.2.0'
 
 from sadie.models.base import *  # noqa
 from sadie.models.simple import *  # noqa

sadie/agents/walkers.py

@@ -150,6 +150,13 @@ def update(self):
 
 
 class VariableVelocityWalker(BaseWalker):
+    """
+    Variable velocity walkers have a velocity distributed based on a probability distribution, `velocity_distribution`.
+    In general, velocities cannot be negative. There are two behaviours, conditioned by the `reflect` parameter:
+
+    * reflection (`reflect = True`): if the random value from the distribution is negative, the absolute value is taken,
+    * capping (`reflect = True`): if the random value from the distribution is negative, 0 is used.
+    """
     def __init__(self,
                  x_init: float,
                  y_init: float,

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.9
+current_version = 0.2.0
 commit = True
 tag = True
 

setup.py

@@ -43,6 +43,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/chrisvoncsefalvay/sadie',
-    version='0.1.9',
+    version='0.2.0',
     zip_safe=False,
 )