Update documentation

pysal · Nov 8, 2024 · 6debc27 · 6debc27
1 parent ba97c30
commit 6debc27
Show file tree

Hide file tree

Showing 377 changed files with 141,391 additions and 1,176 deletions.
diff --git a/_images/notebooks_skater_reg_11_1.png b/_images/notebooks_skater_reg_11_1.png
diff --git a/_images/notebooks_skater_reg_9_0.png b/_images/notebooks_skater_reg_9_0.png
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,214 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; spreg v1.9.dev8+g19fa653 Manual</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=9afac83c" />
+    <link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/pysal-styles.css?v=b100b7f1" />
+    <script src="../_static/documentation_options.js?v=9e5d77b9"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <link rel="icon" href="../_static/pysal_favicon.ico"/>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+<meta charset='utf-8'>
+<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
+<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
+<meta name="apple-mobile-web-app-capable" content="yes">
+<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
+<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
+<script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
+<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
+
+  </head><body>
+
+  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
+    <div class="container">
+      <div class="navbar-header">
+        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
+        <a class="navbar-brand" href="../index.html">
+          spreg</a>
+        <span class="navbar-text navbar-version pull-left"><b>1.9.dev8+g19fa653</b></span>
+      </div>
+
+        <div class="collapse navbar-collapse nav-collapse">
+          <ul class="nav navbar-nav">
+
+                <li><a href="../installation.html">Installation</a></li>
+                <li><a href="../tutorials.html">Tutorials</a></li>
+                <li><a href="../api.html">API</a></li>
+                <li><a href="../references.html">References</a></li>
+
+
+              <li class="dropdown globaltoc-container">
+  <a role="button"
+     id="dLabelGlobalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="../index.html">Site <b class="caret"></b></a>
+  <ul class="dropdown-menu globaltoc"
+      role="menu"
+      aria-labelledby="dLabelGlobalToc"><p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/1_sample_data.html">PySAL Sample Data Sets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/2_data_input_output.html">Data Input/Output</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/3_basic_mapping.html">Basic Mapping</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/4_spatial_weights.html">Spatial Weights</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html">Basic Ordinary Least Squares Regression (OLS)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Luc-Anselin">Luc Anselin</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#(revised-09/08/2024)">(revised 09/08/2024)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Prerequisites">Prerequisites</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Modules-Needed">Modules Needed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Functionality-Used">Functionality Used</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Input-Files">Input Files</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Variable-Names">Variable Names</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Reading-Input-Files-from-the-Example-Data-Set">Reading Input Files from the Example Data Set</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Reading-Weights">Reading Weights</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Setting-up-the-Variables">Setting up the Variables</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Alternative-way-to-pass-arguments">Alternative way to pass arguments</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Immigrant-paradox">Immigrant paradox</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Predicted-Values-and-Residuals">Predicted Values and Residuals</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Latex-Table-Output">Latex Table Output</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#White-test">White test</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Variance-Inflation-Factor-(VIF)">Variance Inflation Factor (VIF)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#F-Test-on-joint-significance-of-coefficients">F-Test on joint significance of coefficients</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#Wald-test-on-joint-significance-of-coefficients">Wald test on joint significance of coefficients</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#White-Standard-Errors">White Standard Errors</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/5_OLS.html#HAC-Standard-Errors">HAC Standard Errors</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/6_TWOSLS.html">Two Stage Least Squares Regression (2SLS)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/7_spatial_models.html">Spatial Model Specifications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/8_spatial_multipliers.html">Spatial Multipliers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/9_specification_tests.html">Specification Tests</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/10_specification_tests_properties.html">Specification Tests - Properties</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/11_distance_decay.html">Distance Decay</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/12_estimating_slx.html">Estimating SLX Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/13_ML_estimation_spatial_lag.html">Maximum Likelihood Estimation - Spatial Lag Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/14_IV_estimation_spatial_lag.html">Instrumental Variables Estimation - Spatial Lag Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/15_ML_estimation_spatial_error.html">Maximum Likelihood Estimation - Spatial Error Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/16_GMM_estimation_spatial_error.html">GMM Estimation - Spatial Error Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/17_GMM_higher_order.html">GMM Estimation - Higher Order Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/Panel_FE_example.html">Spatial Panel Models with Fixed Effects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/skater_reg.html">Skater Regression</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#classic-models">Classic Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spatial-regression-models">Spatial Regression Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#discrete-choice-models">Discrete Choice Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#regimes-models">Regimes Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#seemingly-unrelated-regressions">Seemingly-Unrelated Regressions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spatial-panel-models">Spatial Panel Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#diagnostics">Diagnostics</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spatial-specification-search">Spatial Specification Search</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#dgp">DGP</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../references.html">References</a></li>
+</ul>
+</ul>
+</li>
+
+                <li class="dropdown">
+  <a role="button"
+     id="dLabelLocalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="#">Page <b class="caret"></b></a>
+  <ul class="dropdown-menu localtoc"
+      role="menu"
+      aria-labelledby="dLabelLocalToc"></ul>
+</li>
+
+
+
+
+
+
+          </ul>
+
+
+
+<form class="navbar-form navbar-right" action="../search.html" method="get">
+ <div class="form-group">
+  <input type="text" name="q" class="form-control" placeholder="Search" />
+ </div>
+  <input type="hidden" name="check_keywords" value="yes" />
+  <input type="hidden" name="area" value="default" />
+</form>
+
+        </div>
+    </div>
+  </div>
+
+<div class="container">
+  <div class="row">
+    <div class="body col-md-12 content" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="spreg/dgp.html">spreg.dgp</a></li>
+<li><a href="spreg/diagnostics.html">spreg.diagnostics</a></li>
+<li><a href="spreg/diagnostics_panel.html">spreg.diagnostics_panel</a></li>
+<li><a href="spreg/diagnostics_sp.html">spreg.diagnostics_sp</a></li>
+<li><a href="spreg/diagnostics_sur.html">spreg.diagnostics_sur</a></li>
+<li><a href="spreg/diagnostics_tsls.html">spreg.diagnostics_tsls</a></li>
+<li><a href="spreg/error_sp.html">spreg.error_sp</a></li>
+<li><a href="spreg/error_sp_het.html">spreg.error_sp_het</a></li>
+<li><a href="spreg/error_sp_het_regimes.html">spreg.error_sp_het_regimes</a></li>
+<li><a href="spreg/error_sp_hom.html">spreg.error_sp_hom</a></li>
+<li><a href="spreg/error_sp_hom_regimes.html">spreg.error_sp_hom_regimes</a></li>
+<li><a href="spreg/error_sp_regimes.html">spreg.error_sp_regimes</a></li>
+<li><a href="spreg/ml_error.html">spreg.ml_error</a></li>
+<li><a href="spreg/ml_error_regimes.html">spreg.ml_error_regimes</a></li>
+<li><a href="spreg/ml_lag.html">spreg.ml_lag</a></li>
+<li><a href="spreg/ml_lag_regimes.html">spreg.ml_lag_regimes</a></li>
+<li><a href="spreg/nslx.html">spreg.nslx</a></li>
+<li><a href="spreg/ols.html">spreg.ols</a></li>
+<li><a href="spreg/ols_regimes.html">spreg.ols_regimes</a></li>
+<li><a href="spreg/panel_fe.html">spreg.panel_fe</a></li>
+<li><a href="spreg/panel_re.html">spreg.panel_re</a></li>
+<li><a href="spreg/probit.html">spreg.probit</a></li>
+<li><a href="spreg/skater_reg.html">spreg.skater_reg</a></li>
+<li><a href="spreg/sp_panels.html">spreg.sp_panels</a></li>
+<li><a href="spreg/spsearch.html">spreg.spsearch</a></li>
+<li><a href="spreg/sur.html">spreg.sur</a></li>
+<li><a href="spreg/sur_error.html">spreg.sur_error</a></li>
+<li><a href="spreg/sur_lag.html">spreg.sur_lag</a></li>
+<li><a href="spreg/twosls.html">spreg.twosls</a></li>
+<li><a href="spreg/twosls_regimes.html">spreg.twosls_regimes</a></li>
+<li><a href="spreg/twosls_sp.html">spreg.twosls_sp</a></li>
+<li><a href="spreg/twosls_sp_regimes.html">spreg.twosls_sp_regimes</a></li>
+</ul>
+
+    </div>
+
+  </div>
+</div>
+<footer class="footer">
+  <div class="container">
+    <p class="pull-right">
+      <a href="#">Back to top</a>
+
+        <br/>
+
+
+    </p>
+    <p>
+        &copy; Copyright 2018-, pysal developers.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
+    </p>
+  </div>
+</footer>
+  </body>
+</html>