Update documentation

pysal · Jan 29, 2025 · 9aa0bd0 · 9aa0bd0
1 parent ba97c30
commit 9aa0bd0
Show file tree

Hide file tree

Showing 136 changed files with 31,167 additions and 1,148 deletions.
diff --git a/_images/user-guide_measure_gini_10_0.png b/_images/user-guide_measure_gini_10_0.png
diff --git a/_images/user-guide_measure_gini_14_0.png b/_images/user-guide_measure_gini_14_0.png
diff --git a/_images/user-guide_measure_gini_17_0.png b/_images/user-guide_measure_gini_17_0.png
diff --git a/_images/user-guide_measure_gini_19_0.png b/_images/user-guide_measure_gini_19_0.png
diff --git a/_images/user-guide_measure_gini_22_0.png b/_images/user-guide_measure_gini_22_0.png
diff --git a/_images/user-guide_measure_gini_36_0.png b/_images/user-guide_measure_gini_36_0.png
diff --git a/_images/user-guide_measure_gini_39_0.png b/_images/user-guide_measure_gini_39_0.png
diff --git a/_images/user-guide_measure_gini_41_0.png b/_images/user-guide_measure_gini_41_0.png
diff --git a/_images/user-guide_measure_gini_41_1.png b/_images/user-guide_measure_gini_41_1.png
diff --git a/_images/user-guide_measure_gini_43_0.png b/_images/user-guide_measure_gini_43_0.png
diff --git a/_images/user-guide_measure_gini_8_0.png b/_images/user-guide_measure_gini_8_0.png
diff --git a/_images/user-guide_measure_theil_15_0.png b/_images/user-guide_measure_theil_15_0.png
diff --git a/_images/user-guide_measure_theil_30_0.png b/_images/user-guide_measure_theil_30_0.png
diff --git a/_images/user-guide_measure_theil_34_0.png b/_images/user-guide_measure_theil_34_0.png
diff --git a/_images/user-guide_measure_theil_39_0.png b/_images/user-guide_measure_theil_39_0.png
diff --git a/_images/user-guide_measure_theil_6_0.png b/_images/user-guide_measure_theil_6_0.png
diff --git a/_images/user-guide_measure_theil_8_0.png b/_images/user-guide_measure_theil_8_0.png
diff --git a/_images/user-guide_measure_wolfson_14_0.png b/_images/user-guide_measure_wolfson_14_0.png
diff --git a/_images/user-guide_measure_wolfson_2_0.png b/_images/user-guide_measure_wolfson_2_0.png
diff --git a/_images/user-guide_measure_wolfson_6_0.png b/_images/user-guide_measure_wolfson_6_0.png
diff --git a/_images/user-guide_measure_wolfson_7_0.png b/_images/user-guide_measure_wolfson_7_0.png
diff --git a/_images/user-guide_measure_wolfson_9_0.png b/_images/user-guide_measure_wolfson_9_0.png
diff --git a/_images/user-guide_viz_pengram_11_0.png b/_images/user-guide_viz_pengram_11_0.png
diff --git a/_images/user-guide_viz_pengram_12_0.png b/_images/user-guide_viz_pengram_12_0.png
diff --git a/_images/user-guide_viz_pengram_14_0.png b/_images/user-guide_viz_pengram_14_0.png
diff --git a/_images/user-guide_viz_pengram_17_0.png b/_images/user-guide_viz_pengram_17_0.png
diff --git a/_images/user-guide_viz_pengram_19_0.png b/_images/user-guide_viz_pengram_19_0.png
diff --git a/_images/user-guide_viz_pengram_20_0.png b/_images/user-guide_viz_pengram_20_0.png
diff --git a/_images/user-guide_viz_pengram_21_0.png b/_images/user-guide_viz_pengram_21_0.png
diff --git a/_images/user-guide_viz_pengram_23_0.png b/_images/user-guide_viz_pengram_23_0.png
diff --git a/_images/user-guide_viz_pengram_26_0.png b/_images/user-guide_viz_pengram_26_0.png
diff --git a/_images/user-guide_viz_pengram_8_0.png b/_images/user-guide_viz_pengram_8_0.png
diff --git a/_images/user-guide_viz_schutz_10_0.png b/_images/user-guide_viz_schutz_10_0.png
diff --git a/_images/user-guide_viz_schutz_19_0.png b/_images/user-guide_viz_schutz_19_0.png
diff --git a/_images/user-guide_viz_schutz_25_0.png b/_images/user-guide_viz_schutz_25_0.png
diff --git a/_images/user-guide_viz_schutz_27_0.png b/_images/user-guide_viz_schutz_27_0.png
diff --git a/_modules/index.html b/_modules/index.html
diff --git a/_modules/inequality/atkinson.html b/_modules/inequality/atkinson.html
diff --git a/_modules/inequality/gini.html b/_modules/inequality/gini.html
diff --git a/_modules/inequality/pen.html b/_modules/inequality/pen.html
diff --git a/_modules/inequality/schutz.html b/_modules/inequality/schutz.html
diff --git a/_modules/inequality/theil.html b/_modules/inequality/theil.html
diff --git a/_modules/inequality/wolfson.html b/_modules/inequality/wolfson.html
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,62 @@
+.. _api_ref:
+
+.. currentmodule:: inequality
+
+API reference
+=============
+
+.. _inequality_api:
+
+Atkinson Inequality Measures
+----------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    atkinson.Atkinson
+
+
+Gini Inequality Measures
+------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    gini.Gini
+    gini.Gini_Spatial
+
+Schutz Inequality Measures
+--------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    schutz.Schutz
+
+Theil Inequality Measures
+-------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+    theil.Theil 
+    theil.TheilD
+    theil.TheilDSim
+
+Wolfson Bipolarization Measure
+------------------------------
+.. autosummary::
+   :toctree: generated/
+
+    wolfson.wolfson
+
+
+Pengram
+-------
+
+.. autosummary::
+   :toctree: generated/
+
+    pen.pen
+    pen.pengram
+
diff --git a/_sources/generated/inequality.atkinson.Atkinson.rst.txt b/_sources/generated/inequality.atkinson.Atkinson.rst.txt
@@ -0,0 +1,22 @@
+inequality.atkinson.Atkinson
+============================
+
+.. currentmodule:: inequality.atkinson
+
+.. autoclass:: Atkinson
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Atkinson.__init__
+
+
+
+
+
+
diff --git a/_sources/generated/inequality.gini.Gini.rst.txt b/_sources/generated/inequality.gini.Gini.rst.txt
@@ -0,0 +1,22 @@
+inequality.gini.Gini
+====================
+
+.. currentmodule:: inequality.gini
+
+.. autoclass:: Gini
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Gini.__init__
+
+
+
+
+
+
diff --git a/_sources/generated/inequality.gini.Gini_Spatial.rst.txt b/_sources/generated/inequality.gini.Gini_Spatial.rst.txt
@@ -0,0 +1,22 @@
+inequality.gini.Gini\_Spatial
+=============================
+
+.. currentmodule:: inequality.gini
+
+.. autoclass:: Gini_Spatial
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Gini_Spatial.__init__
+
+
+
+
+
+
diff --git a/_sources/generated/inequality.pen.pen.rst.txt b/_sources/generated/inequality.pen.pen.rst.txt
@@ -0,0 +1,6 @@
+inequality.pen.pen
+==================
+
+.. currentmodule:: inequality.pen
+
+.. autofunction:: pen
diff --git a/_sources/generated/inequality.pen.pengram.rst.txt b/_sources/generated/inequality.pen.pengram.rst.txt
@@ -0,0 +1,6 @@
+inequality.pen.pengram
+======================
+
+.. currentmodule:: inequality.pen
+
+.. autofunction:: pengram
diff --git a/_sources/generated/inequality.schutz.Schutz.rst.txt b/_sources/generated/inequality.schutz.Schutz.rst.txt
@@ -0,0 +1,26 @@
+inequality.schutz.Schutz
+========================
+
+.. currentmodule:: inequality.schutz
+
+.. autoclass:: Schutz
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Schutz.__init__
+      ~Schutz.calculate_intersection_point
+      ~Schutz.calculate_schutz_coefficient
+      ~Schutz.calculate_schutz_distance
+      ~Schutz.plot
+
+
+
+
+
+
diff --git a/_sources/generated/inequality.theil.Theil.rst.txt b/_sources/generated/inequality.theil.Theil.rst.txt
@@ -0,0 +1,22 @@
+inequality.theil.Theil
+======================
+
+.. currentmodule:: inequality.theil
+
+.. autoclass:: Theil
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Theil.__init__
+
+
+
+
+
+
diff --git a/_sources/generated/inequality.theil.TheilD.rst.txt b/_sources/generated/inequality.theil.TheilD.rst.txt
@@ -0,0 +1,22 @@
+inequality.theil.TheilD
+=======================
+
+.. currentmodule:: inequality.theil
+
+.. autoclass:: TheilD
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~TheilD.__init__
+
+
+
+
+
+
diff --git a/_sources/generated/inequality.theil.TheilDSim.rst.txt b/_sources/generated/inequality.theil.TheilDSim.rst.txt
@@ -0,0 +1,22 @@
+inequality.theil.TheilDSim
+==========================
+
+.. currentmodule:: inequality.theil
+
+.. autoclass:: TheilDSim
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~TheilDSim.__init__
+
+
+
+
+
+
diff --git a/_sources/generated/inequality.wolfson.wolfson.rst.txt b/_sources/generated/inequality.wolfson.wolfson.rst.txt
@@ -0,0 +1,6 @@
+inequality.wolfson.wolfson
+==========================
+
+.. currentmodule:: inequality.wolfson
+
+.. autofunction:: wolfson