release prep

MANIFEST.in

@@ -1 +1,3 @@
-include geosnap/data/variables.csv
+include geosnap/io/variables.csv geosnap/io/lodes.csv geosnap/io/stfipstable.csv
+
+

docsrc/Makefile

@@ -0,0 +1,34 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = PACKAGE_NAME
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+github:
+	@make html
+
+sync:
+	@rsync -avh _build/html/ ../docs/ --delete
+	@rsync -avh figs/ ../docs/figs/ --delete
+	@make clean
+	touch ../docs/.nojekyll
+
+clean:
+	rm -rf $(BUILDDIR)/*
+	rm -rf auto_examples/
+	rm -rf generated/

docsrc/_static/pysal-styles.css

@@ -0,0 +1,78 @@
+/* Make thumbnails with equal heights */
+@media only screen and (min-width : 481px) {
+    .row.equal-height {
+        display: flex;
+        flex-wrap: wrap;
+    }
+    .row.equal-height > [class*='col-'] {
+        display: flex;
+        flex-direction: column;
+    }
+    .row.equal-height.row:after,
+    .row.equal-height.row:before {
+        display: flex;
+    }
+
+    .row.equal-height > [class*='col-'] > .thumbnail,
+    .row.equal-height > [class*='col-'] > .thumbnail > .caption {
+        display: flex;
+        flex: 1 0 auto;
+        flex-direction: column;
+    }
+    .row.equal-height > [class*='col-'] > .thumbnail > .caption > .flex-text {
+        flex-grow: 1;
+    }
+    .row.equal-height > [class*='col-'] > .thumbnail > img {
+        width: 100%;
+        height: 200px; /* force image's height */
+
+        /* force image fit inside it's "box" */
+        -webkit-object-fit: cover;
+           -moz-object-fit: cover;
+            -ms-object-fit: cover;
+             -o-object-fit: cover;
+                object-fit: cover;
+    }
+}
+
+.row.extra-bottom-padding{
+    margin-bottom: 20px;
+}
+
+
+.topnavicons {
+    margin-left: 10% !important;
+}
+
+.topnavicons li {
+    margin-left: 0px !important;
+    min-width: 100px;
+    text-align: center;
+}
+
+.topnavicons .thumbnail {
+    margin-right: 10px;
+    border: none;
+    box-shadow: none;
+    text-align: center;
+    font-size: 85%;
+    font-weight: bold;
+    line-height: 10px;
+    height: 100px;
+}
+
+.topnavicons .thumbnail img {
+    display: block;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+
+/* Table with a scrollbar */
+.bodycontainer { max-height: 600px; width: 100%; margin: 0; overflow-y: auto; }
+.table-scrollable { margin: 0; padding: 0; }
+
+.label {
+    color: #222222;
+    font-size: 100%;
+}

docsrc/api.rst

@@ -0,0 +1,186 @@
+.. _api_ref:
+
+.. currentmodule:: geosnap
+
+API reference
+=============
+
+.. _data_api:
+
+IO Module
+--------------
+
+Storing data
+'''''''''''''''
+
+geosnap's `io` module provides functions for collecting and storing a variety of datasets
+including U.S. Census data from 1990-2010, LEHD data from any vintage, and external longitudinal databases.
+
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+    io.store_census
+    io.store_blocks_2000
+    io.store_blocks_2010
+    io.store_ltdb
+    io.store_ncdb
+    io.get_lehd
+
+Accessing Stored Datasets
+'''''''''''''''''''''''''''''''
+
+It also provides a storage container `datasets` that provides access to datasets that have been imported with the functions above
+
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+    datasets
+    datasets.blocks_2000
+    datasets.blocks_2010
+    datasets.codebook
+    datasets.counties
+    datasets.ltdb
+    datasets.msa_definitions
+    datasets.msas
+    datasets.ncdb
+    datasets.states
+    datasets.tracts_1990
+    datasets.tracts_2000
+    datasets.tracts_2010
+
+
+The Community Class
+-----------------------
+
+The `Community` is the central construct in geonap used to hold spatiotemporal neighborhood data.
+The most common way to interact with geosnap is by instantiating a Community using a constructor method,
+then using analytical methods upon the community
+
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+   Community
+
+Community Constructors
+''''''''''''''''''''''''''''
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+   Community.from_census
+   Community.from_geodataframes
+   Community.from_lodes
+   Community.from_ltdb
+   Community.from_ncdb
+
+.. _analyze_api:
+
+
+Community Analytics
+'''''''''''''''''''''''''
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+   Community.cluster
+   Community.cluster_spatial
+   Community.harmonize
+   Community.sequence
+   Community.transition
+
+
+Analyze Module
+----------------
+
+Neighborhood Clustering Methods
+'''''''''''''''''''''''''''''''''''''''''''''
+
+Model neighborhood differentiation using multivariate clustering algorithms
+
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+    analyze.cluster
+    analyze.cluster_spatial
+
+Clustering algorithms
+``````````````````````````````````
+The following algorithms may be passed to `geosnap.analyze.cluster` or `geosnap.analyze.cluster_spatial` but they should not be called directly
+
+Classic (aspatial) Clustering
+""""""""""""""""""""""""""""""
+
+.. currentmodule:: geosnap.analyze.analytics
+
+.. autosummary::
+   :toctree: generated/
+
+    affinity_propagation
+    gaussian_mixture
+    hdbscan
+    kmeans
+    spectral
+    ward
+
+Spatial Clustering
+""""""""""""""""""
+
+.. currentmodule:: geosnap.analyze.analytics
+
+.. autosummary::
+   :toctree: generated/
+
+    azp
+    max_p
+    skater
+    spenc
+    ward_spatial    
+
+
+Neighborhod Dynamics Methods
+'''''''''''''''''''''''''''''''''''''''''''''
+
+Model neighborhood change using optimal-matching algorithms or spatial discrete markov chains
+
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+   analyze.linc
+   analyze.sequence
+   analyze.transition
+
+.. _harmonize_api:
+
+Harmonize Module
+----------------
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+   Community.harmonize
+
+.. _visualize_api:
+
+Visualize Module
+----------------
+
+.. currentmodule:: geosnap
+
+.. autosummary::
+   :toctree: generated/
+
+   visualize.indexplot_seq
+   visualize.explore