libadalina-analytics 0.0__tar.gz

libadalina_analytics-0.0/.gitignore

@@ -0,0 +1,3 @@
+.idea
+.gitlab-ci-local
+dist

libadalina_analytics-0.0/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+# The Docker image that will be used to build your app
+image: python:3.10-alpine
+create-pages:
+  pages:
+    # The folder that contains the files to be exposed at the Page URL
+    publish: public
+  rules:
+    # This ensures that only pushes to the default branch will trigger
+    # a pages deploy
+    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
+  # Functions that should be executed before the build script is run
+  before_script:
+    - apk add --no-cache make git pandoc gdal-dev gcc libc-dev
+  script:
+    - pip install -r requirements.dev.txt
+    - sphinx-build -b html docs/source public

libadalina_analytics-0.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tests/samples"]
+	path = tests/samples
+	url = git@gitlab.com:amelia_unimi/libadalina-samples.git

libadalina_analytics-0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 University of Milan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

libadalina_analytics-0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+recursive-include libadalina_analytics *.py

libadalina_analytics-0.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: libadalina-analytics
+Version: 0.0
+Summary: A library for geoenrichment and analytics of geographic data
+Author-email: Marco Casazza <d.marcocasazza@gmail.com>, Alberto Ceselli <alberto.ceselli@unimi.it>, Marco Premoli <marco.premoli@unimi.it>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: ~=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: libadalina-core==1.0.2
+Provides-Extra: dev
+Requires-Dist: pytest==8.4.1; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: pydata-sphinx-theme; extra == "dev"
+Requires-Dist: nbsphinx; extra == "dev"
+Requires-Dist: sphinx-collections; extra == "dev"
+Dynamic: license-file

libadalina_analytics-0.0/build.sh

@@ -0,0 +1,6 @@
+#/usr/bin/env bash
+
+python3 -m pip install --upgrade build twine
+python3 -m build
+python3 -m twine upload --repository pypi dist/*
+

libadalina_analytics-0.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+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)

libadalina_analytics-0.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

libadalina_analytics-0.0/docs/source/conf.py

@@ -0,0 +1,84 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+import pathlib
+
+sys.path.insert(0, os.path.abspath(pathlib.Path(__file__).parent.parent.parent))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'libadalina-analytics'
+copyright = '2025, OptLab, University of Milan'
+author = 'Marco Casazza, Alberto Ceselli, Marco Premoli'
+release = '1.0.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
+    "sphinxcontrib.collections",
+    'nbsphinx'
+]
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
+
+# Intersphinx settings
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None),
+    'geopandas': ('https://geopandas.org/en/stable/', None),
+    'pyspark': ('https://spark.apache.org/docs/latest/api/python/', None),
+}
+
+collections = {
+    'notebooks': {
+        'driver': 'copy_folder',
+        'source': pathlib.Path(__file__).parent.parent.parent / 'examples',
+        'target': 'notebooks',
+        'ignore': ['*.py', '.sh'],
+    }
+}
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', '**.ipynb_checkpoints']
+
+nbsphinx_execute = 'never'  # Do not execute notebooks during build
+highlight_language = 'python'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'pydata_sphinx_theme'
+html_static_path = ['_static']
+
+latex_elements = {
+    'papersize': 'a4paper',
+    'pointsize': '10pt',
+    'extraclassoptions': 'oneside',
+    'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
+    'makeindex': r'\usepackage[columns=1]{idxlayout}\makeindex'
+}

libadalina_analytics-0.0/examples/clustering_algorithm.ipynb

@@ -0,0 +1,291 @@
+{
+ "cells": [
+  {
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2025-08-16T14:44:48.052498Z",
+     "start_time": "2025-08-16T14:44:47.833358Z"
+    }
+   },
+   "cell_type": "code",
+   "source": [
+    "import pandas as pd\n",
+    "import pathlib\n",
+    "import os\n",
+    "\n",
+    "base_path = pathlib.Path(os.environ.get(\"SAMPLES_DIR\", \"\"))\n",
+    "\n",
+    "clustering_df = pd.read_csv(\n",
+    "    base_path / \"clustering\" / \"G_20_AMELIA_zoning_WKT_32632.csv\",\n",
+    "    sep=',')"
+   ],
+   "id": "6e6f6399ab5983fb",
+   "outputs": [],
+   "execution_count": 1
+  },
+  {
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2025-08-16T14:45:49.826601Z",
+     "start_time": "2025-08-16T14:44:48.095077Z"
+    }
+   },
+   "cell_type": "code",
+   "source": [
+    "from libadalina_core.sedona_utils import EPSGFormats\n",
+    "from clustering.algorithms import clustering_algorithm\n",
+    "from clustering.models.adalina_zoning_distance import ClusteringDistance\n",
+    "\n",
+    "clustering_solution = clustering_algorithm(\n",
+    "    clustering_df,\n",
+    "    epsg=EPSGFormats.EPSG32632,\n",
+    "    k_min=4,\n",
+    "    k_max=6,\n",
+    "    distances=[\n",
+    "        ClusteringDistance(name=\"popolazion\", weight=2, function=\"chebyshev\"),\n",
+    "        ClusteringDistance(name=\"density\", function=\"euclidean\"),\n",
+    "        ClusteringDistance(name=\"geometry\"),\n",
+    "    ],\n",
+    ")\n",
+    "\n",
+    "clustering_solution.get_dataframe_to_export().head()"
+   ],
+   "id": "ee24db1241138019",
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Running HiGHS 1.11.0 (git hash: n/a): Copyright (c) 2025 HiGHS under MIT licence terms\n",
+      "MIP  has 4331 rows; 590 cols; 13367 nonzeros; 590 integer variables (590 binary)\n",
+      "Coefficient ranges:\n",
+      "  Matrix [1e+00, 1e+00]\n",
+      "  Cost   [2e-02, 4e-01]\n",
+      "  Bound  [1e+00, 1e+00]\n",
+      "  RHS    [1e+00, 6e+00]\n",
+      "WARNING: User-supplied values fix only 51 / 590 discrete variables, so attempt to complete a feasible solution may be expensive\n",
+      "Coefficient ranges:\n",
+      "  Matrix [1e+00, 1e+00]\n",
+      "  Cost   [2e-02, 4e-01]\n",
+      "  Bound  [1e+00, 1e+00]\n",
+      "  RHS    [1e+00, 6e+00]\n",
+      "Presolving model\n",
+      "Presolve: Infeasible\n",
+      "\n",
+      "Src: B => Branching; C => Central rounding; F => Feasibility pump; J => Feasibility jump;\n",
+      "     H => Heuristic; L => Sub-MIP; P => Empty MIP; R => Randomized rounding; Z => ZI Round;\n",
+      "     I => Shifting; S => Solve LP; T => Evaluate node; U => Unbounded; X => User solution;\n",
+      "     z => Trivial zero; l => Trivial lower; u => Trivial upper; p => Trivial point\n",
+      "\n",
+      "        Nodes      |    B&B Tree     |            Objective Bounds              |  Dynamic Constraints |       Work      \n",
+      "Src  Proc. InQueue |  Leaves   Expl. | BestBound       BestSol              Gap |   Cuts   InLp Confl. | LpIters     Time\n",
+      "\n",
+      "         0       0         0   0.00%   -inf            inf                  inf        0      0      0         0     0.0s\n",
+      "\n",
+      "Solving report\n",
+      "  Status            Infeasible\n",
+      "  Primal bound      inf\n",
+      "  Dual bound        -inf\n",
+      "  Gap               inf\n",
+      "  P-D integral      0\n",
+      "  Solution status   -\n",
+      "  Timing            0.00 (total)\n",
+      "                    0.00 (presolve)\n",
+      "                    0.00 (solve)\n",
+      "                    0.00 (postsolve)\n",
+      "  Max sub-MIP depth 0\n",
+      "  Nodes             0\n",
+      "  Repair LPs        0 (0 feasible; 0 iterations)\n",
+      "  LP iterations     0 (total)\n",
+      "                    0 (strong br.)\n",
+      "                    0 (separation)\n",
+      "                    0 (heuristics)\n",
+      "Presolving model\n",
+      "4331 rows, 590 cols, 13367 nonzeros  0s\n",
+      "4331 rows, 590 cols, 13367 nonzeros  0s\n",
+      "\n",
+      "Solving MIP model with:\n",
+      "   4331 rows\n",
+      "   590 cols (590 binary, 0 integer, 0 implied int., 0 continuous, 0 domain fixed)\n",
+      "   13367 nonzeros\n",
+      "\n",
+      "Src: B => Branching; C => Central rounding; F => Feasibility pump; J => Feasibility jump;\n",
+      "     H => Heuristic; L => Sub-MIP; P => Empty MIP; R => Randomized rounding; Z => ZI Round;\n",
+      "     I => Shifting; S => Solve LP; T => Evaluate node; U => Unbounded; X => User solution;\n",
+      "     z => Trivial zero; l => Trivial lower; u => Trivial upper; p => Trivial point\n",
+      "\n",
+      "        Nodes      |    B&B Tree     |            Objective Bounds              |  Dynamic Constraints |       Work      \n",
+      "Src  Proc. InQueue |  Leaves   Expl. | BestBound       BestSol              Gap |   Cuts   InLp Confl. | LpIters     Time\n",
+      "\n",
+      " J       0       0         0   0.00%   -inf            2.215701075        Large        0      0      0         0     0.0s\n",
+      "         0       0         0   0.00%   0.8924665339    2.215701075       59.72%        0      0      8       122     0.1s\n",
+      " C       0       0         0   0.00%   0.9455857403    2.127058346       55.54%       62     20      8       237     0.1s\n",
+      " L       0       0         0   0.00%   1.008810593     1.547182779       34.80%     1427     88      8      1252     2.5s\n",
+      "        53       1        25  43.16%   1.008810593     1.547182779       34.80%     1013     64   2493     35215     7.6s\n",
+      "       230       9       108  66.05%   1.016024304     1.547182779       34.33%     1303     90   8686     68181    12.6s\n",
+      "       506      24       240  72.57%   1.018347205     1.547182779       34.18%     2703    101   4951     98204    18.8s\n",
+      "      1071      62       495  73.88%   1.032356755     1.547182779       33.28%     2921    107   8945    124851    23.8s\n",
+      "\n",
+      "Restarting search from the root node\n",
+      "Model after restart has 4331 rows, 590 cols (590 bin., 0 int., 0 impl., 0 cont., 0 dom.fix.), and 13367 nonzeros\n",
+      "\n",
+      "      1736       0         0   0.00%   1.049169002     1.547182779       32.19%      107      0      0    149363    28.7s\n",
+      "      1736       0         0   0.00%   1.049169002     1.547182779       32.19%      107     60      6    149538    28.7s\n",
+      "      1941       9        96  46.08%   1.049169002     1.547182779       32.19%     2337    102   2671    164422    34.0s\n",
+      "      2917      45       561  57.00%   1.049169002     1.547182779       32.19%     1495    102   8351    188454    39.0s\n",
+      "      3899      89      1023  57.01%   1.068898115     1.547182779       30.91%     1644    104   9051    211733    44.0s\n",
+      "      4782     124      1440  57.03%   1.081764872     1.547182779       30.08%     2993    101   9310    235841    49.0s\n",
+      "      5646     149      1855  75.27%   1.081764872     1.547182779       30.08%     4324    109   9144    258096    54.1s\n",
+      "      6427     174      2230  75.35%   1.109967053     1.547182779       28.26%     4452    131   9713    280957    59.1s\n",
+      "      6615     183      2319  75.35%   1.109967053     1.547182779       28.26%     4426    119   9181    285988    60.0s\n",
+      "\n",
+      "Solving report\n",
+      "  Status            Time limit reached\n",
+      "  Primal bound      1.54718277863\n",
+      "  Dual bound        1.10996705301\n",
+      "  Gap               28.26% (tolerance: 0.01%)\n",
+      "  P-D integral      19.8590086477\n",
+      "  Solution status   feasible\n",
+      "                    1.54718277863 (objective)\n",
+      "                    0 (bound viol.)\n",
+      "                    5.80276567537e-14 (int. viol.)\n",
+      "                    0 (row viol.)\n",
+      "  Timing            60.00 (total)\n",
+      "                    0.00 (presolve)\n",
+      "                    0.00 (solve)\n",
+      "                    0.00 (postsolve)\n",
+      "  Max sub-MIP depth 3\n",
+      "  Nodes             6615\n",
+      "  Repair LPs        0 (0 feasible; 0 iterations)\n",
+      "  LP iterations     285988 (total)\n",
+      "                    123788 (strong br.)\n",
+      "                    7270 (separation)\n",
+      "                    15773 (heuristics)\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "                       ID  popolazion  \\\n",
+       "0  ROBECCHETTO CON INDUNO       47.95   \n",
+       "1                  NOSATE        6.44   \n",
+       "2          BERNATE TICINO       29.41   \n",
+       "3                CUGGIONO       80.79   \n",
+       "4                 TURBIGO       71.06   \n",
+       "\n",
+       "                                            geometry  usable  beds  personnel  \\\n",
+       "0  POLYGON ((480748.825 5043027.556, 480748.825 5...     NaN   NaN        NaN   \n",
+       "1  POLYGON ((477387.977 5043229.078, 477387.977 5...     NaN   NaN        NaN   \n",
+       "2  POLYGON ((487458.22 5036059.092, 487458.22 503...     NaN   NaN        NaN   \n",
+       "3  POLYGON ((486991.876 5038856.062, 486991.876 5...     NaN   NaN        NaN   \n",
+       "4  POLYGON ((480748.826 5043027.557, 480748.826 5...     NaN   NaN        NaN   \n",
+       "\n",
+       "    density  zoning_Adalina  \n",
+       "0  0.034325               6  \n",
+       "1  0.013081              18  \n",
+       "2  0.024243              10  \n",
+       "3  0.054359               6  \n",
+       "4  0.083216               6  "
+      ],
+      "text/html": [
+       "<div>\n",
+       "<style scoped>\n",
+       "    .dataframe tbody tr th:only-of-type {\n",
+       "        vertical-align: middle;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe tbody tr th {\n",
+       "        vertical-align: top;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe thead th {\n",
+       "        text-align: right;\n",
+       "    }\n",
+       "</style>\n",
+       "<table border=\"1\" class=\"dataframe\">\n",
+       "  <thead>\n",
+       "    <tr style=\"text-align: right;\">\n",
+       "      <th></th>\n",
+       "      <th>ID</th>\n",
+       "      <th>popolazion</th>\n",
+       "      <th>geometry</th>\n",
+       "      <th>usable</th>\n",
+       "      <th>beds</th>\n",
+       "      <th>personnel</th>\n",
+       "      <th>density</th>\n",
+       "      <th>zoning_Adalina</th>\n",
+       "    </tr>\n",
+       "  </thead>\n",
+       "  <tbody>\n",
+       "    <tr>\n",
+       "      <th>0</th>\n",
+       "      <td>ROBECCHETTO CON INDUNO</td>\n",
+       "      <td>47.95</td>\n",
+       "      <td>POLYGON ((480748.825 5043027.556, 480748.825 5...</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>0.034325</td>\n",
+       "      <td>6</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>1</th>\n",
+       "      <td>NOSATE</td>\n",
+       "      <td>6.44</td>\n",
+       "      <td>POLYGON ((477387.977 5043229.078, 477387.977 5...</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>0.013081</td>\n",
+       "      <td>18</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2</th>\n",
+       "      <td>BERNATE TICINO</td>\n",
+       "      <td>29.41</td>\n",
+       "      <td>POLYGON ((487458.22 5036059.092, 487458.22 503...</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>0.024243</td>\n",
+       "      <td>10</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>3</th>\n",
+       "      <td>CUGGIONO</td>\n",
+       "      <td>80.79</td>\n",
+       "      <td>POLYGON ((486991.876 5038856.062, 486991.876 5...</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>0.054359</td>\n",
+       "      <td>6</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>4</th>\n",
+       "      <td>TURBIGO</td>\n",
+       "      <td>71.06</td>\n",
+       "      <td>POLYGON ((480748.826 5043027.557, 480748.826 5...</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>NaN</td>\n",
+       "      <td>0.083216</td>\n",
+       "      <td>6</td>\n",
+       "    </tr>\n",
+       "  </tbody>\n",
+       "</table>\n",
+       "</div>"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "execution_count": 2
+  }
+ ],
+ "metadata": {},
+ "nbformat": 4,
+ "nbformat_minor": 5
+}