lsapy 0.2.0__tar.gz → 0.3.1__tar.gz

{lsapy-0.2.0 → lsapy-0.3.1}/CHANGELOG.rst

@@ -2,6 +2,52 @@
 Changelog
 =========
 
+v0.3.1 (2025-11-14)
+-------------------
+Contributor to this version: Baptiste Hamon (@baptistehamon).
+
+Bug fixes
+^^^^^^^^^
+* The `np.vectorize` decorator has been removed of standardization functions to fix fitting functions issues (issue `#101 <https://github.com/baptistehamon/lsapy/issues/101>`_, PR `#102 <https://github.com/baptistehamon/lsapy/pull/102>`_).
+
+v0.3.0 (2025-11-10)
+-------------------
+Contributor to this version: Baptiste Hamon (@baptistehamon).
+
+Announcements
+^^^^^^^^^^^^^
+* `LSAPy` is now available on `conda-forge <https://anaconda.org/conda-forge/lsapy>`_ (issue `#68 <https://github.com/baptistehamon/lsapy/issues/68>`_, PR `#74 <https://github.com/baptistehamon/lsapy/pull/74>`_).
+
+New features
+^^^^^^^^^^^^
+* A new ``boolean`` suitability function has been added (issue `#85 <https://github.com/baptistehamon/lsapy/issues/85>`_, PR `#86 <https://github.com/baptistehamon/lsapy/pull/86>`_).
+* The ``name`` and ``indicator`` arguments of ``SuitabilityCriteria`` can now be optional (issue `#84 <https://github.com/baptistehamon/lsapy/issues/84>`_, PR `#87 <https://github.com/baptistehamon/lsapy/issues/87>`_).
+* A ``setter`` has been added to ``SuitabilityCriteria`` attributes (issue `#84 <https://github.com/baptistehamon/lsapy/issues/84>`_, PR `#87 <https://github.com/baptistehamon/lsapy/issues/87>`_).
+* The ``lsapy.standardize`` module has been added with categorical and membership standardization functions (issue `#89 <https://github.com/baptistehamon/lsapy/issues/89>`_, PR `#91 <https://github.com/baptistehamon/lsapy/issues/91>`_).
+* The ``SuitabilityFunction`` is not longer required to define the standardization function in ``SuitabilityCriteria`` (issue `#89 <https://github.com/baptistehamon/lsapy/issues/89>`_, PR `#91 <https://github.com/baptistehamon/lsapy/issues/91>`_).
+* ``SuitabilityCriteria.name`` is now a property of the class (PR `#97 <https://github.com/baptistehamon/lsapy/issues/97>`_).
+* The ``LandSuitabilityAnalysis`` properties have been properly defined (PR `#98 <https://github.com/baptistehamon/lsapy/issues/98>`_).
+* The API Reference documentation has been updated and improved (issue `#96 <https://github.com/baptistehamon/lsapy/issues/96>`_, PR `#99 <https://github.com/baptistehamon/lsapy/issues/99>`_).
+
+Breaking changes
+^^^^^^^^^^^^^^^^
+* The ``lsapy.statistics`` module has been renamed to ``lsapy.stats`` (PR `#71 <https://github.com/baptistehamon/lsapy/pull/71>`_).
+* The ``lsapy.core.aggregation`` has been moved and renamed to ``lsapy.aggregate`` (PR `#71 <https://github.com/baptistehamon/lsapy/pull/71>`_).
+* The ``statistical_summary`` function has been renamed to ``stats_summary`` (PR `#82 <https://github.com/baptistehamon/lsapy/pull/82>`_).
+* The ``spatial_statistical_summary`` function has been renamed to ``spatial_stats_summary`` (PR `#82 <https://github.com/baptistehamon/lsapy/pull/82>`_).
+* The ``lsapy.functions`` module as well as ``SuitabilityFunction`` have been marked as deprecated and will be removed in a future release (issue `#89 <https://github.com/baptistehamon/lsapy/issues/89>`_, PR `#91 <https://github.com/baptistehamon/lsapy/issues/91>`_).
+
+Internal changes
+^^^^^^^^^^^^^^^^
+* The name and year in the license file have been updated (PR `#76 <https://github.com/baptistehamon/lsapy/pull/76>`_).
+* The logo has been updated (PR `#80 <https://github.com/baptistehamon/lsapy/pull/80>`_).
+* Tests have been added for the ``lsapy.stats`` module functions (PR `#82 <https://github.com/baptistehamon/lsapy/pull/82>`_).
+* The README file has been updated integrating new standardization function workflow (issue `#92 <https://github.com/baptistehamon/lsapy/issues/92>`_, PR `#93 <https://github.com/baptistehamon/lsapy/issues/93>`_).
+
+Bug fixes
+^^^^^^^^^
+* Fix small issue of ``SuitabilityCriteria`` string representation (PR `#73 <https://github.com/baptistehamon/lsapy/pull/73>`_).
+
 v0.2.0 (2025-08-20)
 -------------------
 Contributor to this version: Baptiste Hamon (@baptistehamon).
@@ -86,7 +132,7 @@ Breaking changes
 Internal changes
 ^^^^^^^^^^^^^^^^
 * Templates for requesting new features, asking question and submitting PR have been added (issue `#11 <https://github.com/baptistehamon/lsapy/issues/11>`_, PR `#12 <https://github.com/baptistehamon/lsapy/pull/12>`_).
-* The README has been updated to make links permanent and to add a docs badge (PR `#13 <https://github.com/baptistehamon/lsapy/pull/13>`_, PR `#15 <https://github.com/baptistehamon/lsapy/pull/15>`_).
+* The README has been updated to make links permanent and to add a docs badge (PR `#13 <https://github.com/baptistehamon/lsapy/pull/13>`_).
 * A configuration file for Zenodo integration has been added to the repository (PR `#14 <https://github.com/baptistehamon/lsapy/pull/14>`_).
 * `Pre-commit` has been setup and `ruff`, `codespell` and `numpydoc` hooks have been added (issue `#8 <https://github.com/baptistehamon/lsapy/issues/8>`_, PR `#18 <https://github.com/baptistehamon/lsapy/pull/18>`_/PR `#19 <https://github.com/baptistehamon/lsapy/pull/19>`_).
 * The autoupdate schedule of `pre-commit` has been set to weekly (PR `#21 <https://github.com/baptistehamon/lsapy/pull/21>`_)

{lsapy-0.2.0 → lsapy-0.3.1}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 The Python Packaging Authority
+Copyright (c) 2025 Baptiste Hamon
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{lsapy-0.2.0 → lsapy-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsapy
-Version: 0.2.0
+Version: 0.3.1
 Summary: A Python package for Land Suitability Analysis.
 Keywords: LSAPy,Land Suitability Analysis,Geospatial Analysis,GIS,Geography
 Author-email: Baptiste Hamon <baptiste.hamon@pg.canterbury.ac.nz>
@@ -73,8 +73,8 @@ Provides-Extra: docs
     :alt: LSAPy Logo
 
 LSAPy: Land Suitability Analysis in Python
-===========================================
-|pypi| |python-versions| |status| |testing| |coverage| |ruff| |pre-commit| |docs| |question| |zenodo|
+==========================================
+|pypi| |conda| |python-versions| |status| |testing| |coverage| |ruff| |pre-commit| |docs| |question| |zenodo|
 
 `LSAPy` stands for Land Suitability Analysis (LSA) in Python. Its objective is to make conducting
 LSA in Python easier and more accessible to users. It provides a set of objects built around
@@ -83,37 +83,39 @@ LSA in Python easier and more accessible to users. It provides a set of objects
 .. _`xarray`: https://xarray.pydata.org/en/stable/
 
 Quick Start
--------------
+-----------
 To install `LSAPy`, you can use `pip`:
 
 .. code-block:: shell
 
     pip install lsapy
 
+or `conda`:
+
+.. code-block:: shell
+
+    conda install -c conda-forge lsapy
 
 You can now perform your LSA:
 
 .. code-block:: python
 
     # import modules
-    from lsapy import LandSuitabilityAnalysis, SuitabilityCriteria, SuitabilityFunction
+    from lsapy import LandSuitabilityAnalysis, SuitabilityCriteria
 
     # define your criteria
     criteria = {
         "crit1": SuitabilityCriteria(
             name="criteria1",
             indicator=indicator1,  # xarray object
-            func=SuitabilityFunction(
-                name="function_name", params={"param1": value1, "param2": value2}
-            ),
+            func="function_name",
+            fparams={"param1": value1, "param2": value2},
         ),
         "crit2": SuitabilityCriteria(
             name="criteria2",
             indicator=indicator2,  # xarray object
-            func=SuitabilityFunction(
-                name="another_function_name",
-                params={"param1": value1, "param2": value2},
-            ),
+            func="another_function_name",
+            fparams={"param1": value1, "param2": value2},
         ),
         # add all necessary criteria
     }
@@ -182,6 +184,10 @@ The Python package has been created following the `pyOpenSci Guidebook`_.
     :target: https://pypi.python.org/pypi/lsapy
     :alt: Python Package Index Build
 
+.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/lsapy
+    :target: https://anaconda.org/conda-forge/lsapy
+    :alt: Conda Version
+
 .. |status| image:: https://www.repostatus.org/badges/latest/active.svg
     :target: https://www.repostatus.org/#active
     :alt: Project Status: Active - The project has reached a stable, usable state and is being actively developed.

{lsapy-0.2.0 → lsapy-0.3.1}/README.rst

@@ -6,8 +6,8 @@
     :alt: LSAPy Logo
 
 LSAPy: Land Suitability Analysis in Python
-===========================================
-|pypi| |python-versions| |status| |testing| |coverage| |ruff| |pre-commit| |docs| |question| |zenodo|
+==========================================
+|pypi| |conda| |python-versions| |status| |testing| |coverage| |ruff| |pre-commit| |docs| |question| |zenodo|
 
 `LSAPy` stands for Land Suitability Analysis (LSA) in Python. Its objective is to make conducting
 LSA in Python easier and more accessible to users. It provides a set of objects built around
@@ -16,37 +16,39 @@ LSA in Python easier and more accessible to users. It provides a set of objects
 .. _`xarray`: https://xarray.pydata.org/en/stable/
 
 Quick Start
--------------
+-----------
 To install `LSAPy`, you can use `pip`:
 
 .. code-block:: shell
 
     pip install lsapy
 
+or `conda`:
+
+.. code-block:: shell
+
+    conda install -c conda-forge lsapy
 
 You can now perform your LSA:
 
 .. code-block:: python
 
     # import modules
-    from lsapy import LandSuitabilityAnalysis, SuitabilityCriteria, SuitabilityFunction
+    from lsapy import LandSuitabilityAnalysis, SuitabilityCriteria
 
     # define your criteria
     criteria = {
         "crit1": SuitabilityCriteria(
             name="criteria1",
             indicator=indicator1,  # xarray object
-            func=SuitabilityFunction(
-                name="function_name", params={"param1": value1, "param2": value2}
-            ),
+            func="function_name",
+            fparams={"param1": value1, "param2": value2},
         ),
         "crit2": SuitabilityCriteria(
             name="criteria2",
             indicator=indicator2,  # xarray object
-            func=SuitabilityFunction(
-                name="another_function_name",
-                params={"param1": value1, "param2": value2},
-            ),
+            func="another_function_name",
+            fparams={"param1": value1, "param2": value2},
         ),
         # add all necessary criteria
     }
@@ -115,6 +117,10 @@ The Python package has been created following the `pyOpenSci Guidebook`_.
     :target: https://pypi.python.org/pypi/lsapy
     :alt: Python Package Index Build
 
+.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/lsapy
+    :target: https://anaconda.org/conda-forge/lsapy
+    :alt: Conda Version
+
 .. |status| image:: https://www.repostatus.org/badges/latest/active.svg
     :target: https://www.repostatus.org/#active
     :alt: Project Status: Active - The project has reached a stable, usable state and is being actively developed.

lsapy-0.3.1/docs/api/criteria.rst

@@ -0,0 +1,34 @@
+===================
+SuitabilityCriteria
+===================
+
+A ``SuitabilityCriteria`` object represents a single criterion used in land suitability analysis. It encapsulates the necessary information
+to evaluate the suitability of land based on a specific indicator and standardization function.
+
+.. currentmodule:: lsapy
+
+.. autosummary::
+   :toctree: generated/
+
+   SuitabilityCriteria
+
+Methods
+-------
+
+.. autosummary::
+   :toctree: generated/
+
+   SuitabilityCriteria.compute
+
+Attributes
+----------
+
+.. autosummary::
+   :toctree: generated/
+
+   SuitabilityCriteria.func
+   SuitabilityCriteria.indicator
+   SuitabilityCriteria.category
+   SuitabilityCriteria.weight
+   SuitabilityCriteria.is_computed
+   SuitabilityCriteria.attrs

lsapy-0.3.1/docs/api/deprecated.rst

@@ -0,0 +1,26 @@
+==========
+Deprecated
+==========
+
+.. warning::
+
+   The functions listed on this page are deprecated and will be removed in future versions of LSAPy.
+   Users are advised to transition to the recommended alternatives as specified in the documentation for each function.
+
+.. currentmodule:: lsapy
+.. autosummary::
+   :toctree: generated/
+
+   SuitabilityFunction
+
+.. autosummary::
+   :toctree: generated/
+
+   functions.boolean
+   functions.discrete
+   functions.logistic
+   functions.sigmoid
+   functions.vetharaniam2022_eq3
+   functions.vetharaniam2022_eq5
+   functions.vetharaniam2024_eq8
+   functions.vetharaniam2024_eq10

lsapy-0.3.1/docs/api/lsa.rst

@@ -0,0 +1,43 @@
+=======================
+LandSuitabilityAnalysis
+=======================
+
+The `LandSuitabilityAnalysis` is the top-level class in LSAPy and defines the LSA framework.
+
+.. currentmodule:: lsapy
+
+.. autosummary::
+   :toctree: generated/
+
+   LandSuitabilityAnalysis
+
+Methods
+-------
+.. autosummary::
+   :toctree: generated/
+
+   LandSuitabilityAnalysis.run
+
+Attributes
+----------
+.. autosummary::
+   :toctree: generated/
+
+   LandSuitabilityAnalysis.land_use
+   LandSuitabilityAnalysis.criteria
+   LandSuitabilityAnalysis.data
+   LandSuitabilityAnalysis.category
+   LandSuitabilityAnalysis.criteria_by_category
+   LandSuitabilityAnalysis.weights_by_category
+   LandSuitabilityAnalysis.attrs
+
+
+Criteria Aggregation
+--------------------
+
+The underlying criteria aggregation method used in ``LandSuitabilityAnalysis.run`` is implemented in the `aggregate` module.
+
+.. autosummary::
+   :toctree: generated/
+
+   aggregate.aggregate

lsapy-0.3.1/docs/api/standardize.rst

@@ -0,0 +1,44 @@
+=========================
+Standardization Functions
+=========================
+
+The ``lsapy.standardize`` module provides various standardization functions to transform raw input data into standardized suitability scores.
+These functions can be broadly categorized into discrete, sigmoid-like, and Gaussian-like standardization.
+
+.. currentmodule:: lsapy.standardize
+
+Discrete Standardization
+------------------------
+.. autosummary::
+   :toctree: generated/
+
+   boolean
+   discrete
+
+Sigmoid-like Standardization
+----------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   logistic
+   sigmoid
+   vetharaniam2022_eq3
+   vetharaniam2022_eq5
+
+Gaussian-like Standardization
+-----------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   vetharaniam2024_eq8
+   vetharaniam2024_eq10
+
+Helper Functions
+----------------
+
+.. autosummary::
+   :toctree: generated/
+
+   fit

lsapy-0.3.1/docs/api/stats.rst

@@ -0,0 +1,13 @@
+===================
+Statistical Summary
+===================
+
+This module provides functions to compute statistics summaries of Land Suitability Analysis results.
+
+.. currentmodule:: lsapy.stats
+
+.. autosummary::
+   :toctree: generated/
+
+   stats_summary
+   spatial_stats_summary

lsapy-0.3.1/docs/api/utils.rst

@@ -0,0 +1,12 @@
+=====
+Utils
+=====
+
+Utility functions for LSAPy.
+
+.. currentmodule:: lsapy
+
+.. autosummary::
+   :toctree: generated/
+
+   utils.open_data

lsapy-0.3.1/docs/api.rst

@@ -0,0 +1,15 @@
+=============
+API Reference
+=============
+
+This page provides an overview of all functions, modules, objects implemented in LSAPy.
+
+.. toctree::
+   :maxdepth: 1
+
+   api/standardize
+   api/criteria
+   api/lsa
+   api/stats
+   api/utils
+   api/deprecated

{lsapy-0.2.0 → lsapy-0.3.1}/docs/getting_started/index.rst

@@ -8,13 +8,17 @@ Installation
 .. _PyPI: https://pypi.org/project/laspy/
 .. _conda-forge: https://conda-forge.org/
 
-To install `LSAPy` from `PyPI`_, you can use pip:
+To install `LSAPy` from `PyPI`_ using `pip`:
 
 .. code-block:: shell
 
    pip install lsapy
 
-In the future, `LSAPy` will be available on `conda-forge`_.
+or from `conda-forge`_ using `conda`:
+
+.. code-block:: shell
+
+   conda install -c conda-forge lsapy
 
 Land Suitability Analysis (LSA)
 -------------------------------

{lsapy-0.2.0 → lsapy-0.3.1}/docs/index.rst

@@ -23,7 +23,7 @@ making LSA's workflow straight forward and easy to understand.
    About <readme>
    Getting Started <getting_started/index>
    User Guide <notebooks/index>
-   API Reference <api/index>
+   API Reference <api>
    Community <community/index>
 
 .. toctree::