Update documentation

pysal · Feb 6, 2025 · dfd9eaa · dfd9eaa
1 parent ba97c30
commit dfd9eaa
Show file tree

Hide file tree

Showing 313 changed files with 78,259 additions and 1,174 deletions.
diff --git a/_images/notebooks_LOSH_20_1.png b/_images/notebooks_LOSH_20_1.png
diff --git a/_images/notebooks_LOSH_22_1.png b/_images/notebooks_LOSH_22_1.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_10_1.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_10_1.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_11_1.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_11_1.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_18_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_18_0.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_20_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_20_0.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_27_1.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_27_1.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_43_1.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_43_1.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_52_1.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_52_1.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_58_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_58_0.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_67_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_67_0.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_69_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_69_0.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_71_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_71_0.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_73_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_73_0.png
diff --git a/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_76_0.png b/_images/notebooks_Spatial_Autocorrelation_for_Areal_Unit_Data_76_0.png
diff --git a/_images/notebooks_adbscan_berlin_example_13_0.png b/_images/notebooks_adbscan_berlin_example_13_0.png
diff --git a/_images/notebooks_adbscan_berlin_example_21_0.png b/_images/notebooks_adbscan_berlin_example_21_0.png
diff --git a/_images/notebooks_adbscan_berlin_example_25_0.png b/_images/notebooks_adbscan_berlin_example_25_0.png
diff --git a/_images/notebooks_adbscan_berlin_example_27_1.png b/_images/notebooks_adbscan_berlin_example_27_1.png
diff --git a/_images/notebooks_adbscan_berlin_example_31_1.png b/_images/notebooks_adbscan_berlin_example_31_1.png
diff --git a/_images/notebooks_adbscan_berlin_example_33_1.png b/_images/notebooks_adbscan_berlin_example_33_1.png
diff --git a/_images/notebooks_adbscan_berlin_example_35_1.png b/_images/notebooks_adbscan_berlin_example_35_1.png
diff --git a/_images/notebooks_adbscan_toy_demo_10_1.png b/_images/notebooks_adbscan_toy_demo_10_1.png
diff --git a/_images/notebooks_adbscan_toy_demo_2_1.png b/_images/notebooks_adbscan_toy_demo_2_1.png
diff --git a/_images/notebooks_adbscan_toy_demo_4_2.png b/_images/notebooks_adbscan_toy_demo_4_2.png
diff --git a/_images/notebooks_adbscan_toy_demo_7_1.png b/_images/notebooks_adbscan_toy_demo_7_1.png
diff --git a/_images/notebooks_geosilhouettes_14_0.png b/_images/notebooks_geosilhouettes_14_0.png
diff --git a/_images/notebooks_geosilhouettes_19_0.png b/_images/notebooks_geosilhouettes_19_0.png
diff --git a/_images/notebooks_geosilhouettes_23_0.png b/_images/notebooks_geosilhouettes_23_0.png
diff --git a/_images/notebooks_geosilhouettes_25_0.png b/_images/notebooks_geosilhouettes_25_0.png
diff --git a/_images/notebooks_geosilhouettes_30_0.png b/_images/notebooks_geosilhouettes_30_0.png
diff --git a/_images/notebooks_geosilhouettes_32_1.png b/_images/notebooks_geosilhouettes_32_1.png
diff --git a/_images/notebooks_geosilhouettes_37_0.png b/_images/notebooks_geosilhouettes_37_0.png
diff --git a/_images/notebooks_geosilhouettes_41_0.png b/_images/notebooks_geosilhouettes_41_0.png
diff --git a/_images/notebooks_geosilhouettes_45_0.png b/_images/notebooks_geosilhouettes_45_0.png
diff --git a/_images/notebooks_geosilhouettes_48_1.png b/_images/notebooks_geosilhouettes_48_1.png
diff --git a/_images/notebooks_geosilhouettes_52_1.png b/_images/notebooks_geosilhouettes_52_1.png
diff --git a/_images/notebooks_geosilhouettes_54_1.png b/_images/notebooks_geosilhouettes_54_1.png
diff --git a/_images/notebooks_geosilhouettes_56_0.png b/_images/notebooks_geosilhouettes_56_0.png
diff --git a/_images/notebooks_joincounts_10_1.png b/_images/notebooks_joincounts_10_1.png
diff --git a/_images/notebooks_joincounts_8_1.png b/_images/notebooks_joincounts_8_1.png
diff --git a/_images/notebooks_joincounts_9_1.png b/_images/notebooks_joincounts_9_1.png
diff --git a/_images/notebooks_localjoincounts_18_1.png b/_images/notebooks_localjoincounts_18_1.png
diff --git a/_images/notebooks_localjoincounts_20_1.png b/_images/notebooks_localjoincounts_20_1.png
diff --git a/_images/notebooks_localjoincounts_30_1.png b/_images/notebooks_localjoincounts_30_1.png
diff --git a/_images/notebooks_localjoincounts_31_1.png b/_images/notebooks_localjoincounts_31_1.png
diff --git a/_images/notebooks_localjoincounts_41_1.png b/_images/notebooks_localjoincounts_41_1.png
diff --git a/_images/notebooks_localjoincounts_42_1.png b/_images/notebooks_localjoincounts_42_1.png
diff --git a/_images/notebooks_shape-measures_11_1.png b/_images/notebooks_shape-measures_11_1.png
diff --git a/_images/notebooks_shape-measures_13_1.png b/_images/notebooks_shape-measures_13_1.png
diff --git a/_images/notebooks_shape-measures_15_1.png b/_images/notebooks_shape-measures_15_1.png
diff --git a/_images/notebooks_shape-measures_17_1.png b/_images/notebooks_shape-measures_17_1.png
diff --git a/_images/notebooks_shape-measures_19_1.png b/_images/notebooks_shape-measures_19_1.png
diff --git a/_images/notebooks_shape-measures_21_1.png b/_images/notebooks_shape-measures_21_1.png
diff --git a/_images/notebooks_shape-measures_23_1.png b/_images/notebooks_shape-measures_23_1.png
diff --git a/_images/notebooks_shape-measures_25_1.png b/_images/notebooks_shape-measures_25_1.png
diff --git a/_images/notebooks_shape-measures_27_1.png b/_images/notebooks_shape-measures_27_1.png
diff --git a/_images/notebooks_shape-measures_29_1.png b/_images/notebooks_shape-measures_29_1.png
diff --git a/_images/notebooks_shape-measures_30_1.png b/_images/notebooks_shape-measures_30_1.png
diff --git a/_images/notebooks_shape-measures_32_1.png b/_images/notebooks_shape-measures_32_1.png
diff --git a/_images/notebooks_shape-measures_4_1.png b/_images/notebooks_shape-measures_4_1.png
diff --git a/_images/notebooks_shape-measures_6_1.png b/_images/notebooks_shape-measures_6_1.png
diff --git a/_images/notebooks_spatialautocorrelation_10_1.png b/_images/notebooks_spatialautocorrelation_10_1.png
diff --git a/_images/notebooks_spatialautocorrelation_11_1.png b/_images/notebooks_spatialautocorrelation_11_1.png
diff --git a/_images/notebooks_spatialautocorrelation_18_0.png b/_images/notebooks_spatialautocorrelation_18_0.png
diff --git a/_images/notebooks_spatialautocorrelation_20_0.png b/_images/notebooks_spatialautocorrelation_20_0.png
diff --git a/_images/notebooks_spatialautocorrelation_27_1.png b/_images/notebooks_spatialautocorrelation_27_1.png
diff --git a/_images/notebooks_spatialautocorrelation_43_1.png b/_images/notebooks_spatialautocorrelation_43_1.png
diff --git a/_images/notebooks_spatialautocorrelation_52_1.png b/_images/notebooks_spatialautocorrelation_52_1.png
diff --git a/_images/notebooks_spatialautocorrelation_58_0.png b/_images/notebooks_spatialautocorrelation_58_0.png
diff --git a/_images/notebooks_spatialautocorrelation_67_0.png b/_images/notebooks_spatialautocorrelation_67_0.png
diff --git a/_images/notebooks_spatialautocorrelation_69_0.png b/_images/notebooks_spatialautocorrelation_69_0.png
diff --git a/_images/notebooks_spatialautocorrelation_71_0.png b/_images/notebooks_spatialautocorrelation_71_0.png
diff --git a/_images/notebooks_spatialautocorrelation_73_0.png b/_images/notebooks_spatialautocorrelation_73_0.png
diff --git a/_images/notebooks_spatialautocorrelation_76_0.png b/_images/notebooks_spatialautocorrelation_76_0.png
diff --git a/_images/notebooks_topo_10_1.png b/_images/notebooks_topo_10_1.png
diff --git a/_images/notebooks_topo_20_0.png b/_images/notebooks_topo_20_0.png
diff --git a/_images/notebooks_topo_28_0.png b/_images/notebooks_topo_28_0.png
diff --git a/_images/notebooks_topo_30_0.png b/_images/notebooks_topo_30_0.png
diff --git a/_modules/esda/adbscan.html b/_modules/esda/adbscan.html
diff --git a/_modules/esda/gamma.html b/_modules/esda/gamma.html
diff --git a/_modules/esda/geary.html b/_modules/esda/geary.html
diff --git a/_modules/esda/geary_local.html b/_modules/esda/geary_local.html
diff --git a/_modules/esda/geary_local_mv.html b/_modules/esda/geary_local_mv.html
diff --git a/_modules/esda/getisord.html b/_modules/esda/getisord.html
diff --git a/_modules/esda/join_counts.html b/_modules/esda/join_counts.html
diff --git a/_modules/esda/join_counts_local.html b/_modules/esda/join_counts_local.html
diff --git a/_modules/esda/join_counts_local_bv.html b/_modules/esda/join_counts_local_bv.html
diff --git a/_modules/esda/join_counts_local_mv.html b/_modules/esda/join_counts_local_mv.html
diff --git a/_modules/esda/lee.html b/_modules/esda/lee.html
diff --git a/_modules/esda/losh.html b/_modules/esda/losh.html
diff --git a/_modules/esda/moran.html b/_modules/esda/moran.html
diff --git a/_modules/esda/shape.html b/_modules/esda/shape.html
diff --git a/_modules/esda/silhouettes.html b/_modules/esda/silhouettes.html
diff --git a/_modules/esda/smaup.html b/_modules/esda/smaup.html
diff --git a/_modules/esda/util.html b/_modules/esda/util.html
diff --git a/_modules/index.html b/_modules/index.html
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,164 @@
+.. _api_ref:
+
+.. currentmodule:: esda
+
+API reference
+=============
+
+.. _adbscan_api:
+
+A-DBSCAN
+--------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.adbscan.ADBSCAN
+
+
+
+.. _gamma_api:
+
+Gamma Statistic
+---------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.Gamma
+
+
+.. _geary_api:
+
+Geary Statistics
+----------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.Geary
+    esda.Geary_Local
+    esda.Geary_Local_MV
+
+
+.. _getis_api:
+
+Getis-Ord Statistics
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.G
+    esda.G_Local
+
+
+.. _join_api:
+
+Join Count Statistics
+---------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.Join_Counts
+
+Join Count Local Statistics
+---------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.Join_Counts_Local
+    esda.Join_Counts_Local_BV
+    esda.Join_Counts_Local_MV
+
+
+LOSH Statistics
+---------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.LOSH
+
+Modifiable Areal Unit Tests
+---------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.Smaup
+
+
+Moran Statistics
+----------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.Moran
+    esda.Moran_BV
+    esda.Moran_BV_matrix
+    esda.Moran_Local
+    esda.Moran_Local_BV
+    esda.Moran_Rate
+    esda.Moran_Local_Rate
+    esda.plot_moran_facet
+
+
+Shape Statistics
+-----------------
+
+.. autosummary::
+    :toctree: generated/
+
+    esda.shape.boundary_amplitude
+    esda.shape.convex_hull_ratio
+    esda.shape.diameter_ratio
+    esda.shape.equivalent_rectangular_index
+    esda.shape.form_factor
+    esda.shape.isoareal_quotient
+    esda.shape.isoperimetric_quotient
+    esda.shape.length_width_diff
+    esda.shape.minimum_bounding_circle_ratio
+    esda.shape.moa_ratio
+    esda.shape.moment_of_inertia
+    esda.shape.nmi
+    esda.shape.radii_ratio
+    esda.shape.rectangularity
+    esda.shape.reflexive_angle_ratio
+    esda.shape.second_areal_moment
+    esda.shape.shape_index
+    esda.shape.squareness
+
+
+Silhouette Statistics
+----------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.boundary_silhouette
+    esda.path_silhouette
+    esda.silhouettes.nearest_label
+    esda.silhouette_alist
+
+
+Spatial Pearson Statistics
+--------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.Spatial_Pearson
+    esda.Local_Spatial_Pearson
+
+
+Utility Functions
+-----------------
+
+.. autosummary::
+   :toctree: generated/
+
+    esda.fdr
diff --git a/_sources/generated/esda.G.rst.txt b/_sources/generated/esda.G.rst.txt
@@ -0,0 +1,23 @@
+esda.G
+======
+
+.. currentmodule:: esda
+
+.. autoclass:: G
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~G.__init__
+      ~G.by_col
+
+
+
+
+
+
diff --git a/_sources/generated/esda.G_Local.rst.txt b/_sources/generated/esda.G_Local.rst.txt
@@ -0,0 +1,24 @@
+esda.G\_Local
+=============
+
+.. currentmodule:: esda
+
+.. autoclass:: G_Local
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~G_Local.__init__
+      ~G_Local.by_col
+      ~G_Local.calc
+
+
+
+
+
+
diff --git a/_sources/generated/esda.Gamma.rst.txt b/_sources/generated/esda.Gamma.rst.txt
@@ -0,0 +1,29 @@
+esda.Gamma
+==========
+
+.. currentmodule:: esda
+
+.. autoclass:: Gamma
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Gamma.__init__
+      ~Gamma.by_col
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Gamma.p_sim
+
+
diff --git a/_sources/generated/esda.Geary.rst.txt b/_sources/generated/esda.Geary.rst.txt
@@ -0,0 +1,23 @@
+esda.Geary
+==========
+
+.. currentmodule:: esda
+
+.. autoclass:: Geary
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Geary.__init__
+      ~Geary.by_col
+
+
+
+
+
+
diff --git a/_sources/generated/esda.Geary_Local.rst.txt b/_sources/generated/esda.Geary_Local.rst.txt
@@ -0,0 +1,27 @@
+esda.Geary\_Local
+=================
+
+.. currentmodule:: esda
+
+.. autoclass:: Geary_Local
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Geary_Local.__init__
+      ~Geary_Local.fit
+      ~Geary_Local.get_metadata_routing
+      ~Geary_Local.get_params
+      ~Geary_Local.set_fit_request
+      ~Geary_Local.set_params
+
+
+
+
+
+
diff --git a/_sources/generated/esda.Geary_Local_MV.rst.txt b/_sources/generated/esda.Geary_Local_MV.rst.txt
@@ -0,0 +1,27 @@
+esda.Geary\_Local\_MV
+=====================
+
+.. currentmodule:: esda
+
+.. autoclass:: Geary_Local_MV
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Geary_Local_MV.__init__
+      ~Geary_Local_MV.fit
+      ~Geary_Local_MV.get_metadata_routing
+      ~Geary_Local_MV.get_params
+      ~Geary_Local_MV.set_fit_request
+      ~Geary_Local_MV.set_params
+
+
+
+
+
+
diff --git a/_sources/generated/esda.Join_Counts.rst.txt b/_sources/generated/esda.Join_Counts.rst.txt
@@ -0,0 +1,23 @@
+esda.Join\_Counts
+=================
+
+.. currentmodule:: esda
+
+.. autoclass:: Join_Counts
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Join_Counts.__init__
+      ~Join_Counts.by_col
+
+
+
+
+
+
diff --git a/_sources/generated/esda.Join_Counts_Local.rst.txt b/_sources/generated/esda.Join_Counts_Local.rst.txt
@@ -0,0 +1,27 @@
+esda.Join\_Counts\_Local
+========================
+
+.. currentmodule:: esda
+
+.. autoclass:: Join_Counts_Local
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Join_Counts_Local.__init__
+      ~Join_Counts_Local.fit
+      ~Join_Counts_Local.get_metadata_routing
+      ~Join_Counts_Local.get_params
+      ~Join_Counts_Local.set_fit_request
+      ~Join_Counts_Local.set_params
+
+
+
+
+
+