update docs; (#192)

update docs;
oturns · Jan 30, 2020 · e505b66 · e505b66
2 parents 4158cc4 + 6e33d6b
commit e505b66
Show file tree

Hide file tree

Showing 71 changed files with 225 additions and 204 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 21d696a094416e3414d570cf9058baa6
+config: c7fdd3f94a05079188405beb0f9d4c35
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/geosnap/_community.html b/docs/_modules/geosnap/_community.html
diff --git a/docs/_modules/geosnap/_data.html b/docs/_modules/geosnap/_data.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap._data &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap._data &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html"><span><img src="../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -323,7 +323,6 @@ <h1>Source code for geosnap._data</h1><div class="highlight"><pre>
         <span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">states</span><span class="p">:</span>
             <span class="n">blks</span><span class="p">[</span><span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="n">blocks_2000</span><span class="p">[</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{state}</span><span class="s2">.parquet&quot;</span><span class="p">]()</span>
             <span class="k">if</span> <span class="n">fips</span><span class="p">:</span>
-                <span class="nb">print</span><span class="p">(</span><span class="n">fips</span><span class="p">)</span>
                 <span class="n">blks</span><span class="p">[</span><span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="n">blks</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="n">blks</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s2">&quot;geoid&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">str</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">fips</span><span class="p">)]</span>
             <span class="n">blks</span><span class="p">[</span><span class="n">state</span><span class="p">][</span><span class="s2">&quot;year&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">2000</span>
         <span class="n">blocks</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">blks</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>

diff --git a/docs/_modules/geosnap/analyze/analytics.html b/docs/_modules/geosnap/analyze/analytics.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.analyze.analytics &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.analyze.analytics &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -268,6 +268,7 @@ <h1>Source code for geosnap.analyze.analytics</h1><div class="highlight"><pre>
             <span class="p">{</span><span class="n">model_name</span><span class="p">:</span> <span class="n">labels</span><span class="p">,</span> <span class="n">time_var</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="n">time_var</span><span class="p">],</span> <span class="n">id_var</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="n">id_var</span><span class="p">]}</span>
         <span class="p">)</span>
         <span class="n">clusters</span><span class="o">.</span><span class="n">set_index</span><span class="p">([</span><span class="n">time_var</span><span class="p">,</span> <span class="n">id_var</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+        <span class="n">clusters</span> <span class="o">=</span> <span class="n">clusters</span><span class="p">[</span><span class="o">~</span><span class="n">clusters</span><span class="o">.</span><span class="n">index</span><span class="o">.</span><span class="n">duplicated</span><span class="p">(</span><span class="n">keep</span><span class="o">=</span><span class="s1">&#39;first&#39;</span><span class="p">)]</span>
         <span class="n">gdf</span> <span class="o">=</span> <span class="n">gdf</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">clusters</span><span class="p">,</span> <span class="n">how</span><span class="o">=</span><span class="s2">&quot;left&quot;</span><span class="p">)</span>
         <span class="n">gdf</span> <span class="o">=</span> <span class="n">gdf</span><span class="o">.</span><span class="n">reset_index</span><span class="p">()</span>
         <span class="n">results</span> <span class="o">=</span> <span class="n">ModelResults</span><span class="p">(</span>

diff --git a/docs/_modules/geosnap/analyze/cluster.html b/docs/_modules/geosnap/analyze/cluster.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.analyze.cluster &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.analyze.cluster &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -377,9 +377,9 @@ <h1>Source code for geosnap.analyze.cluster</h1><div class="highlight"><pre>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">random_state</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
         <span class="n">warn</span><span class="p">(</span>
-            <span class="s2">&quot;Note: Gaussian Mixture Clustering is probabilistic--</span><span class="se">\</span>
-<span class="s2">             cluster labels may be different for different runs. If you need consistency,</span><span class="se">\</span>
-<span class="s2">             you should set the `random_state` parameter&quot;</span>
+            <span class="s2">&quot;Note: Gaussian Mixture Clustering is probabilistic--&quot;</span>
+            <span class="s2">&quot;cluster labels may be different for different runs. If you need consistency, &quot;</span>
+            <span class="s2">&quot;you should set the `random_state` parameter&quot;</span>
         <span class="p">)</span>
 
     <span class="k">if</span> <span class="n">best_model</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>

diff --git a/docs/_modules/geosnap/analyze/dynamics.html b/docs/_modules/geosnap/analyze/dynamics.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.analyze.dynamics &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.analyze.dynamics &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/geosnap/analyze/incs.html b/docs/_modules/geosnap/analyze/incs.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.analyze.incs &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.analyze.incs &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/geosnap/harmonize/harmonize.html b/docs/_modules/geosnap/harmonize/harmonize.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.harmonize.harmonize &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.harmonize.harmonize &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -284,11 +284,11 @@ <h1>Source code for geosnap.harmonize.harmonize</h1><div class="highlight"><pre>
 
         <span class="n">profiles</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="k">if</span> <span class="n">extensive_variables</span><span class="p">:</span>
-            <span class="n">profile</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">interpolation</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">columns</span><span class="o">=</span><span class="n">extensive_variables</span><span class="p">)</span>
+            <span class="n">profile</span> <span class="o">=</span> <span class="n">interpolation</span><span class="p">[</span><span class="n">extensive_variables</span><span class="p">]</span>
             <span class="n">profiles</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">profile</span><span class="p">)</span>
 
         <span class="k">if</span> <span class="n">intensive_variables</span><span class="p">:</span>
-            <span class="n">profile</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">interpolation</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">columns</span><span class="o">=</span><span class="n">intensive_variables</span><span class="p">)</span>
+            <span class="n">profile</span> <span class="o">=</span> <span class="n">interpolation</span><span class="p">[</span><span class="n">intensive_variables</span><span class="p">]</span>
             <span class="n">profiles</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">profile</span><span class="p">)</span>
 
         <span class="n">profile</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">concat</span><span class="p">(</span><span class="n">profiles</span><span class="p">,</span> <span class="n">sort</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

diff --git a/docs/_modules/geosnap/io/storage.html b/docs/_modules/geosnap/io/storage.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.io.storage &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.io.storage &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/geosnap/io/util.html b/docs/_modules/geosnap/io/util.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.io.util &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.io.util &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/geosnap/visualize/commviz.html b/docs/_modules/geosnap/visualize/commviz.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.visualize.commviz &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.visualize.commviz &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -157,7 +157,7 @@ <h1>Source code for geosnap.visualize.commviz</h1><div class="highlight"><pre>
     <span class="n">external_stylesheets</span> <span class="o">=</span> <span class="p">[</span><span class="n">dbc</span><span class="o">.</span><span class="n">themes</span><span class="o">.</span><span class="n">JOURNAL</span><span class="p">]</span>
 
     <span class="n">opts</span> <span class="o">=</span> <span class="p">[]</span>
-    <span class="k">for</span> <span class="n">colname</span> <span class="ow">in</span> <span class="n">datasets</span><span class="o">.</span><span class="n">codebook</span><span class="o">.</span><span class="n">variable</span><span class="p">:</span>
+    <span class="k">for</span> <span class="n">colname</span> <span class="ow">in</span> <span class="n">datasets</span><span class="o">.</span><span class="n">codebook</span><span class="p">()</span><span class="o">.</span><span class="n">variable</span><span class="p">:</span>
         <span class="n">val</span> <span class="o">=</span> <span class="n">colname</span>
         <span class="k">if</span> <span class="n">colname</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;n_&quot;</span><span class="p">):</span>
             <span class="n">colname</span> <span class="o">=</span> <span class="n">colname</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>

diff --git a/docs/_modules/geosnap/visualize/seq.html b/docs/_modules/geosnap/visualize/seq.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>geosnap.visualize.seq &#8212; geosnap v0.0.2 Manual</title>
+    <title>geosnap.visualize.seq &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../../index.html"><span><img src="../../../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>Overview: module code &#8212; geosnap v0.0.2 Manual</title>
+    <title>Overview: module code &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../_static/pysal-styles.css" />
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../index.html"><span><img src="../_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.0.2',
+    VERSION: '0.1.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

diff --git a/docs/api.html b/docs/api.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>API reference &#8212; geosnap v0.0.2 Manual</title>
+    <title>API reference &#8212; geosnap v0.1.0 Manual</title>
     <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/pysal-styles.css" />
@@ -39,7 +39,7 @@
         </button>
         <a class="navbar-brand" href="index.html"><span><img src="_static/geosnap.svg"></span>
           geosnap</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.0.2</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.0</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/generated/geosnap-visualize-indexplot_seq-1.pdf b/docs/generated/geosnap-visualize-indexplot_seq-1.pdf