Merge pull request #37 from weikang9009/master

add docstring for categorical spatial Markov

CHANGELOG.txt

@@ -1,4 +1,4 @@
-v<1.1.0>, 2018-05-17
+v<1.1.1>, 2018-05-17
 
 This release is the first tagged release of giddy on Github.
 Starting from this release, giddy supports python 3.5 and 3.6 only.
@@ -10,18 +10,18 @@ as well as neighborhood change. Here, the spatial lag (utilizing function
 in [libpysal](https://github.com/pysal/libpysal)) is defined as the most
 common category among neighbors.
 
-
 GitHub stats for 2017/07/21 - 2018/05/17
 
 These lists are automatically generated, and may be incomplete or contain duplicates.
 
 
-We closed a total of 18 issues, 7 pull requests and 11 regular issues;
+We closed a total of 20 issues, 8 pull requests and 12 regular issues;
 this is the full list (generated with the script 
 :file:`tools/github_stats.py`):
 
-Pull Requests (7):
+Pull Requests (8):
 
+* :ghpull:`36`: b'add changelog for the release 1.1.0'
 * :ghpull:`35`: b'prepare for release'
 * :ghpull:`34`: b'code 2to3'
 * :ghpull:`33`: b'chore: update for python 3+ only'
@@ -30,8 +30,9 @@ Pull Requests (7):
 * :ghpull:`25`: b'[WIP] prepare for full metapackage integration'
 * :ghpull:`27`: b'api module for giddy'
 
-Issues (11):
+Issues (12):
 
+* :ghissue:`36`: b'add changelog for the release 1.1.0'
 * :ghissue:`35`: b'prepare for release'
 * :ghissue:`34`: b'code 2to3'
 * :ghissue:`33`: b'chore: update for python 3+ only'

README.rst

@@ -19,19 +19,10 @@ addition to space-time LISA and spatial markov methods.
 This package is part of a `refactoring of PySAL
 <https://github.com/pysal/pysal/wiki/PEP-13:-Refactor-PySAL-Using-Submodules>`_.
 
-.. Space–time analytics that consider the role of space in the evolution of
-distributions over time.
-
-.. Below are six choropleth maps of US state per-capita incomes from 1929
-to 2004 at a fifteen-year interval.
-
-.. .. figure:: figs/us_qunitile_maps.png
-   :alt: us\_qunitile\_maps
-
-..    us\_qunitile\_maps
 
+*************
 giddy modules
--------------
+*************
 
 - giddy.directional  Directional LISA, inference and visualization
 - giddy.markov  Spatially explicit Markov methods
@@ -42,25 +33,19 @@ Mimicking parts of the original PySAL api can be done with
 
 ``import giddy.api as ps``
 
-
+************
 Installation
-------------
+************
 
 Install giddy by running:
 
 ::
 
     $ pip install giddy
 
-Requirements
-^^^^^^^^^^^^
-
--  libpysal
--  esda
--  mapclassify
-
+**********
 Contribute
-----------
+**********
 
 PySAL-giddy is under active development and contributors are welcome.
 
@@ -72,15 +57,16 @@ and open a `pull request <https://github.com/pysal/giddy>`__. Once your
 changes get merged, you’ll automatically be added to the `Contributors
 List <https://github.com/pysal/giddy/graphs/contributors>`__.
 
-
+*******
 License
--------
+*******
 
 The project is licensed under the `BSD
 license <https://github.com/pysal/giddy/blob/master/LICENSE.txt>`__.
 
+*******
 Funding
--------
+*******
 
 NSF Award #1421935 `New Approaches to Spatial Distribution
 Dynamics <https://www.nsf.gov/awardsearch/showAward?AWD_ID=1421935>`__

giddy/markov.py

@@ -196,6 +196,12 @@ class Spatial_Markov(object):
                       If true, quantiles are taken over the entire n*t
                       pooled series. If false, quantiles are taken each
                       time period over n.
+    discrete        : bool
+                      If true, categorical spatial lags which are most common
+                      categories of neighboring observations serve as the
+                      conditioning and fixed is ignored; if false, weighted
+                      averages of neighboring observations are used. Default is
+                      false.
     variable_name   : string
                       name of variable.
 

giddy/version.py

@@ -1,6 +1,6 @@
 import datetime
 Major = 1
 Feature = 1
-Bug = 0
+Bug = 1
 version = '%d.%d.%d' % (Major, Feature, Bug)
 stable_release_date = datetime.date(2018, 5, 17)

setup.py

@@ -23,7 +23,7 @@
 
 Major = 1
 Feature = 1
-Bug = 0
+Bug = 1
 VERSION = '%d.%d.%d' % (Major, Feature, Bug)
 
 def setup_package():