lsapy 0.1.0.dev1__tar.gz → 0.1.1__tar.gz

lsapy-0.1.1/CHANGELOG.rst

@@ -0,0 +1,93 @@
+=========
+Changelog
+=========
+
+v0.1.1 (2025-07-26)
+-------------------
+Contributor to this version: Baptiste Hamon (@baptistehamon).
+
+Internal changes
+^^^^^^^^^^^^^^^^
+* The documentation has been updated to reflect the changes in ``LandSuitabilityAnalysis`` workflow (issue `#41 <https://github.com/baptistehamon/lsapy/issues/41>`_, PR `#42 <https://github.com/baptistehamon/lsapy/pull/42>`_).
+
+v0.1.0 (2025-07-25)
+-------------------
+Contributor to this version: Baptiste Hamon (@baptistehamon).
+
+New features
+^^^^^^^^^^^^
+* New function ``membership.fit_membership`` implemented as replacement of the deprecated ``MembershipSuitFunction.fit`` method (issue `#29 <https://github.com/baptistehamon/lsapy/issues/29>`_, PR `#30 <https://github.com/baptistehamon/lsapy/pull/30>`_).
+
+Breaking changes
+^^^^^^^^^^^^^^^^
+* ``MembershipSuitFunction`` and ``DiscreteSuitFunction`` have been removed (issue `#29 <https://github.com/baptistehamon/lsapy/issues/29>`_, PR `#30 <https://github.com/baptistehamon/lsapy/pull/30>`_).
+* Changes in ``SuitabilityFunction`` (issue `#15 <https://github.com/baptistehamon/lsapy/issues/15>`_, PR `#23 <https://github.com/baptistehamon/lsapy/pull/23>`_ & PR `#30 <https://github.com/baptistehamon/lsapy/pull/30>`_):
+    * ``func_method`` and ``func_params`` have been renamed to ``name`` and ``params`` respectively.
+    * ``map`` has been deprecated because of its redundancy with the ``__call__`` method. Changes will be permanent in LSAPy v0.1.0. Call the function directly instead.
+* ``LandSuitability`` has been renamed to ``LandSuitabilityAnalysis``. (issue `#15 <https://github.com/baptistehamon/lsapy/issues/15>`_, PR `#26 <https://github.com/baptistehamon/lsapy/pull/26>`_)
+    * ``name`` has been renamed to ``land_use``.
+    * ``compute_criteria_suitability``, ``compute_category_suitability``, and ``compute_suitability`` methods have been removed and the method ``run`` has been implemented as replacement (issue `#15 <https://github.com/baptistehamon/lsapy/issues/15>`_, PR `#38 <https://github.com/baptistehamon/lsapy/pull/38>`_)
+    * ``mask``, ``statistics`` and ``spatial_statistics`` methods have been removed.
+
+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>`).
+* 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>`_)
+* The unused ``introduction.ipynb`` notebook has been removed (issue `#15 <https://github.com/baptistehamon/lsapy/issues/15>`_, PR `#20 <https://github.com/baptistehamon/lsapy/pull/20>`_).
+* The structure around ``SuitabilityFunction`` (PR `#30 <https://github.com/baptistehamon/lsapy/pull/30>`_):
+    * The ``SuitabilityFunction`` has been moved to LSAPy ``function._suitability`` module.
+    * The membership functions have been moved to the ``function.membership`` module.
+    * The discrete function has been moved to the ``function._discrete`` module.
+    * The ``equation`` decorator has been rename to ``declare_equation`` and moved to the ``core.function`` module.
+    * The ``get_function_from_name`` function has been moved to the ``core.function`` module.
+* Changes on ``SuitabilityCriteria`` (issue `#15 <https://github.com/baptistehamon/lsapy/issues/15>`_, PR `#31 <https://github.com/baptistehamon/lsapy/pull/31>`_):
+    * It now has a ``comment`` and ``is_computed`` attributes.
+    * ``func`` parameter is now optional, useful when the criteria is already computed.
+* LSAPy logo has been added: README and documentation have been updated to use it (PR `#27 <https://github.com/baptistehamon/lsapy/pull/27>`_)
+
+v0.1.0-dev2 (2025-05-25)
+------------------------
+Contributor to this version: Baptiste Hamon (@baptistehamon).
+
+Internal changes
+^^^^^^^^^^^^^^^^
+* Major changes for documentation (issue `#2 <https://github.com/baptistehamon/lsapy/issues/2>`_, PR `#9 <https://github.com/baptistehamon/lsapy/pull/9>`_):
+    * All public objects are now documented using the `NumPy-style <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
+    * *introduction.ipynb* has been slip into three different ones: *criteria.ipynb*, *function.ipynb*, and *lsa.ipynb*.
+    * The top-level documentation has been updated/created:
+        * The format of README and CHANGELOG files is now reStructuredText (RST).
+        * A proper README has been created.
+        * A CODE_OF_CONDUCT file adopting the `Contributor Covenant <https://www.contributor-covenant.org/>`_ code of conduct has been added.
+        * A CONTRIBUTING.md providing guidelines on how to contribute to the project has been added.
+    * FT20250 and UC logos used in the documentation have been added to the repository.
+    * The documentation building using `Sphinx <https://www.sphinx-doc.org/en/master/>`_ has been setup:
+        * The documentation uses the `PyData theme <https://pydata-sphinx-theme.readthedocs.io/en/stable/>`_.
+        * A User-facing documentation is now available and has been published on `Read the Docs <https://readthedocs.org/>`_.
+    * The project dependencies have been updated and made consistent across *pyproject.toml* and *environments.yml* files.
+
+v0.1.0-dev1 (2025-05-16)
+------------------------
+Contributor to this version: Baptiste Hamon (@baptistehamon).
+
+New features
+^^^^^^^^^^^^
+* Add ruff configuration to the project.
+
+Bug fixes
+^^^^^^^^^
+* Fix the fit of ``MembershipSuitFunction`` returning the wrong best fit (issue `#1 <https://github.com/baptistehamon/lsapy/issues/1>`_, PR `#5 <https://github.com/baptistehamon/lsapy/pull/5>`_)
+
+v0.1.0-dev0 (2025-03-12)
+------------------------
+Contributor to this version: Baptiste Hamon (@baptistehamon).
+
+* First release on PyPI.
+
+New features
+^^^^^^^^^^^^
+* ``SuitabilityFunction`` to define the function used for suitability computation.
+* ``SuitabilityCriteria`` to define criteria to consider in the LSA
+* ``LandSuitability`` to conduct LSA.

lsapy-0.1.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

lsapy-0.1.1/CONTRIBUTING.rst

@@ -0,0 +1,181 @@
+=====================
+Contributing to LSAPy
+=====================
+
+No matter the scope of your contribution, help is always welcome!
+
+The `issue tracker`_ is the best place to start if you want to contribute to `LSAPy`. You can get involved in different ways:
+
+* **Submitting feedbacks**: We welcome any feedback on the library, whether it's about the API, the documentation, or anything else.
+* **Suggesting new features**: If you have an idea for a new feature or improvement. Explain your idea in details and provide any thoughts you have on how it could be implemented.
+* **Reporting bugs**: If you find a bug, please report it making sure to include as much information as possible to help us reproduce the bug (e.g., operating system, local setup details, steps to reproduce it...).
+
+The `issue tracker`_ is also the place to ask questions about the library. The maintainers and the community will be happy to help you.
+
+Contribution Workflow
+---------------------
+Below is the steps to follow for contributing to the project.
+
+#. Fork the `LSAPy` repository on GitHub to your own account.
+
+#. Clone your forked repository to your local machine.
+
+    .. code-block:: shell
+
+        git clone git@github.com:<your_username>/lsapy.git
+        cd lsapy/
+
+#. Create a virtual environment (``conda`` is recommended) and install the dependencies.
+
+    .. code-block:: shell
+
+        conda env create -f environment.yml
+        conda activate lsapy
+        python -m pip install -e .
+
+#. Create a new branch for your changes.
+
+    .. code-block:: shell
+
+        git checkout -b name-of-your-bugfix-or-feature
+
+    You can now make changes.
+
+#. Before committing your changes, we ask that you install ``pre-commit`` in your development environment and run git hooks to ensure that your code adheres to the project's coding standards:
+
+    .. code-block:: shell
+
+        # To install the necessary pre-commit hooks:
+        pre-commit install
+        # To run pre-commit hooks manually:
+        pre-commit run --all-files
+
+    Instead of ``pre-commit``, you can check individual hooks manually with `ruff`:
+
+        .. code-block:: shell
+
+            ruff check --fix --show-fixes src/lsapy/
+            ruff format src/lsapy/
+
+    This will automatically format your code and fix any linting issues.
+
+#. The last step before committing is to run the tests:
+
+    .. code-block:: shell
+
+        pytest --doctest-modules src/lsapy/ # to run doctests
+
+#. Commit your changes and push your branch.
+
+    .. code-block:: shell
+
+        git add *
+        git commit -m "Short description of your changes"
+        git push origin name-of-your-bugfix-or-feature
+
+#. Create a pull request on GitHub.
+
+    Before creating a pull request, we first ask you to open an issue in the `GitHub repository`_. Describe the bug you would
+    like to fix or the feature you would like to add. Link the issue to your pull request.
+
+.. note::
+
+    **Longer Term Commitment ?**
+
+    While the project is still in its early stages, a bigger maintainers team may be required in the future if the project
+    grows. If you like the project and are interested in joining the maintainers team, please reach out to us. We will be happy to
+    discuss it with you.
+
+Reminder for maintainers
+------------------------
+
+This section provides some useful information for maintainers.
+
+Versioning
+^^^^^^^^^^
+
+The project follows `Semantic Versioning`_ scheme:
+
+.. code-block:: shell
+
+    major.minor.patch-releaseX
+      |     |     |      |   |
+      |     |     |      |   +--- Build number (e.g., 1, 2, 3...)
+      |     |     |      +------- Degree of production (e.g., dev, alpha, beta)
+      |     |     +-------------- Patch release (e.g., bug fixes)
+      |     +-------------------- Minor release (e.g., new features)
+      +-------------------------- Major release (e.g., breaking changes)
+
+
+Packaging and Deployment
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. note::
+
+    This section comes largely from the `xclim Contributing guidelines`_. Small edits have been made to match `LSAPy` project.
+
+This section serves as a reminder for the maintainers on how to prepare the library for a tagged version and how to deploy packages to TestPyPI and PyPI.
+
+When a new version has been minted (features have been successfully integrated test coverage and stability is adequate), maintainers should update the pip-installable package (wheel and source release) on PyPI.
+
+From a new branch (e.g. ``prepare-v123``), open a Pull Request and make sure all your changes to support a new version are committed (**update the entry for newest version in CHANGELOG.rst**), then run:
+
+.. code-block:: shell
+
+    bump-my-version bump <option>  # possible options: major / minor / patch / release / build
+
+These commands will increment the version and create a commit with an autogenerated message.
+
+For PyPI releases/stable versions, ensure that the last version bumping command run is ``$ bump-my-version bump release`` to remove the ``-dev``. These changes can now be merged to the ``prepare-v123`` branch:
+
+.. code-block:: shell
+
+    git push origin prepare-v123
+
+With this performed, we can tag a version that will act as the GitHub-provided stable source archive. **Be sure to only tag from the `main` branch when all changes from PRs have been merged!** The commands needed are:
+
+.. code-block:: shell
+
+    git tag v1.2.3
+    git push --tags
+
+.. note::
+
+    All tags pushed to GitHub will trigger a build and publish a package to TestPyPI by default.
+
+The Automated Approach
+~~~~~~~~~~~~~~~~~~~~~~
+
+The simplest way to package `LSAPy` is to "publish" a version on GitHub. GitHub CI Actions are presently configured to build the library and publish the packages on PyPI automatically.
+
+.. warning::
+
+    A published version on PyPI can never be overwritten. Be sure to verify that the package published at https://test.pypi.org/project/lsapy/ matches expectations before publishing a version on GitHub.
+
+The Manual Approach
+~~~~~~~~~~~~~~~~~~~
+
+The manual approach to library packaging for general support (pip wheels) requires that the `flit`_ library is installed.
+
+From the command line on your Linux distribution, simply run the following from the clone's main dev branch:
+
+.. code-block:: shell
+
+    # To build the packages (sources and wheel)
+    flit build
+
+    # To upload to PyPI
+    flit publish
+
+The new version based off of the version checked out will now be available via ``pip`` (``$ pip install lsapy``).
+
+Credits
+-------
+
+This document is inspired by the `xclim Contributing guidelines`_.
+
+.. _`GitHub Repository`: https://github.com/baptistehamon/lsapy
+.. _`issue tracker`: https://github.com/baptistehamon/lsapy/issues
+.. _`xclim Contributing guidelines`: https://github.com/Ouranosinc/xclim/blob/main/CONTRIBUTING.rst
+.. _`Semantic Versioning`: https://semver.org/
+.. _`flit`: https://flit.pypa.io/en/stable/index.html

{lsapy-0.1.0.dev1 → lsapy-0.1.1}/LICENSE

@@ -1,19 +1,19 @@
-Copyright (c) 2018 The Python Packaging Authority
-
-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.
+Copyright (c) 2018 The Python Packaging Authority
+
+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.

lsapy-0.1.1/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: lsapy
+Version: 0.1.1
+Summary: A Python package for Land Suitability Analysis.
+Keywords: LSAPy,Land Suitability Analysis,Spatial Analysis,GIS,Geography
+Author-email: Baptiste Hamon <baptiste.hamon@pg.canterbury.ac.nz>
+Maintainer-email: Baptiste Hamon <baptiste.hamon@pg.canterbury.ac.nz>
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: GIS
+License-File: LICENSE
+Requires-Dist: geopandas >=0.14.0
+Requires-Dist: numpy >=1.26.0
+Requires-Dist: pandas >=2.2.0
+Requires-Dist: regionmask >=0.13.0
+Requires-Dist: scipy >=1.15.0
+Requires-Dist: Shapely >=2.0.0
+Requires-Dist: xarray >=2024.10.0
+Requires-Dist: lsapy[dev] ; extra == "all"
+Requires-Dist: lsapy[docs] ; extra == "all"
+Requires-Dist: bump-my-version >=1.1.4 ; extra == "dev"
+Requires-Dist: codespell >=2.4.1 ; extra == "dev"
+Requires-Dist: flit >=3.11 ; extra == "dev"
+Requires-Dist: ipykernel ; extra == "dev"
+Requires-Dist: ipython >=9.0.0 ; extra == "dev"
+Requires-Dist: matplotlib >=3.9.0 ; extra == "dev"
+Requires-Dist: numpydoc >=1.8.0 ; extra == "dev"
+Requires-Dist: pre-commit >=4.0.0 ; extra == "dev"
+Requires-Dist: pytest >=8.3.0 ; extra == "dev"
+Requires-Dist: ruff >=0.10.0 ; extra == "dev"
+Requires-Dist: xclim >=0.54.0 ; extra == "dev"
+Requires-Dist: nbsphinx >=0.9.5 ; extra == "docs"
+Requires-Dist: pybtex >=0.24.0 ; extra == "docs"
+Requires-Dist: pydata-sphinx-theme >=0.16.0 ; extra == "docs"
+Requires-Dist: sphinx >=8.2.0 ; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints >=3.2.0 ; extra == "docs"
+Requires-Dist: sphinx-copybutton ; extra == "docs"
+Requires-Dist: sphinx-mdinclude ; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex >=2.6.0 ; extra == "docs"
+Project-URL: Homepage, https://github.com/baptistehamon/lsapy
+Project-URL: Issues, https://github.com/baptistehamon/lsapy/issues
+Provides-Extra: all
+Provides-Extra: dev
+Provides-Extra: docs
+
+.. image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/lsapy/LSAPy_Logo_FullColour.png
+    :class: dark-light
+    :align: center
+    :target: https://github.com/baptistehamon/lsapy
+    :width: 400px
+    :alt: LSAPy Logo
+
+LSAPy: Land Suitability Analysis in Python
+===========================================
+|pypi| |status| |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
+`xarray`_ and operating together, making LSA's workflow straight forward and easy to understand.
+
+.. _`xarray`: https://xarray.pydata.org/en/stable/
+
+Quick Start
+-------------
+To install `LSAPy`, you can use `pip`:
+
+.. code-block:: shell
+
+    pip install lsapy
+
+
+You can now perform your LSA:
+
+.. code-block:: python
+
+    # import modules
+    from lsapy import LandSuitabilityAnalysis, SuitabilityCriteria, SuitabilityFunction
+
+    # define your criteria
+    criteria = {
+        'crit1': SuitabilityCriteria(
+            name='criteria1',
+            indicator= indicator1, # xarray object
+            func=SuitabilityFunction(name="function_name", params={'param1': value1, 'param2': value2})
+        ),
+        'crit2': SuitabilityCriteria(
+            name='criteria2',
+            indicator= indicator2, # xarray object
+            func= SuitabilityFunction(name="another_function_name", params={'param1': value1, 'param2': value2})
+        )
+        # add all necessary criteria
+    }
+
+    # define your land suitability
+    lsa = LandSuitabilityAnalysis(
+        land_use= 'land_use_name',
+        criteria= criteria,
+    )
+
+    # run your analysis
+    lsa.run(params)
+
+More detailed tutorials and examples can be found in the `User Guide`_.
+
+.. _`User Guide`: https://lsapy.readthedocs.io/en/latest/notebooks/index.html
+
+
+Contributing
+------------
+
+`LSAPy` is an open-source project and we welcome contributions from the community. If you are interested in contributing, please
+refer to the `Contribution`_ section for guidelines on how to get started helping us improve the library.
+
+.. _`Contribution`: https://lsapy.readthedocs.io/en/latest/community/contributing.html
+
+Credits
+-------
+
+The development of `LSAPy` started as part of a PhD, funded by the `Food Transition 2050`_  Joint Postgraduate School and hosted
+by the `University of Canterbury`_ in New Zealand.
+
+|FT2050| |UC-white| |UC-black|
+
+The Python package has been created following the `pyOpenSci Guidebook`_.
+
+.. _`Food Transition 2050`: https://www.foodtransitions2050.ac.nz/
+.. _`University of Canterbury`: https://www.canterbury.ac.nz/
+.. _`pyOpenSci Guidebook`: https://www.pyopensci.org/python-package-guide/
+
+.. |logo| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/lsapy/LSAPy_Logo_FullColour.png
+    :class: dark-light
+    :target: https://github.com/baptistehamon/lsapy
+    :width: 400px
+    :alt: LSAPy Logo
+
+.. |FT2050| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/FT2050-full_colour.png
+    :class: dark-light
+    :target: https://www.foodtransitions2050.ac.nz/
+    :width: 200px
+    :alt: Food Transition 2050 Logo
+
+.. |UC-white| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/UCWhite.png
+    :class: only-dark
+    :target: https://www.canterbury.ac.nz/
+    :width: 100px
+    :alt: University of Canterbury Logo
+
+.. |UC-black| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/UCBlack.png
+    :class: only-light
+    :target: https://www.canterbury.ac.nz/
+    :width: 100px
+    :alt: University of Canterbury Logo
+
+.. |pypi| image:: https://img.shields.io/pypi/v/lsapy.svg
+    :target: https://pypi.python.org/pypi/lsapy
+    :alt: Python Package Index Build
+
+.. |status| image:: https://www.repostatus.org/badges/latest/wip.svg
+    :target: https://www.repostatus.org/#wip
+    :alt: Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.
+
+.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.15015111.svg
+    :target: https://doi.org/10.5281/zenodo.15015111
+    :alt: Zenodo DOI
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |docs| image:: https://readthedocs.org/projects/lsapy/badge/
+    :target: https://lsapy.readthedocs.io/en/latest/
+    :alt: Documentation Status
+
+.. |question| image:: https://img.shields.io/badge/Question_%3F-blue?style=social&logo=github
+    :target: https://github.com/baptistehamon/lsapy/labels/question
+    :alt: Link to question issues
+
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/baptistehamon/lsapy/main.svg
+   :target: https://results.pre-commit.ci/latest/github/baptistehamon/lsapy/main
+   :alt: pre-commit.ci status
+