.. 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
Raw data
{
"_id": null,
"home_page": null,
"name": "lsapy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Baptiste Hamon <baptiste.hamon@pg.canterbury.ac.nz>",
"keywords": "LSAPy, Land Suitability Analysis, Spatial Analysis, GIS, Geography",
"author": null,
"author_email": "Baptiste Hamon <baptiste.hamon@pg.canterbury.ac.nz>",
"download_url": "https://files.pythonhosted.org/packages/a9/5d/bb7e96082d9a1ed3fe20722286251fb10f460ee4d5b13ad12e772e8389ce/lsapy-0.1.1.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/lsapy/LSAPy_Logo_FullColour.png\n :class: dark-light\n :align: center\n :target: https://github.com/baptistehamon/lsapy\n :width: 400px\n :alt: LSAPy Logo\n\nLSAPy: Land Suitability Analysis in Python\n===========================================\n|pypi| |status| |ruff| |pre-commit| |docs| |question| |zenodo|\n\n`LSAPy` stands for Land Suitability Analysis (LSA) in Python. Its objective is to make conducting\nLSA in Python easier and more accessible to users. It provides a set of objects built around\n`xarray`_ and operating together, making LSA's workflow straight forward and easy to understand.\n\n.. _`xarray`: https://xarray.pydata.org/en/stable/\n\nQuick Start\n-------------\nTo install `LSAPy`, you can use `pip`:\n\n.. code-block:: shell\n\n pip install lsapy\n\n\nYou can now perform your LSA:\n\n.. code-block:: python\n\n # import modules\n from lsapy import LandSuitabilityAnalysis, SuitabilityCriteria, SuitabilityFunction\n\n # define your criteria\n criteria = {\n 'crit1': SuitabilityCriteria(\n name='criteria1',\n indicator= indicator1, # xarray object\n func=SuitabilityFunction(name=\"function_name\", params={'param1': value1, 'param2': value2})\n ),\n 'crit2': SuitabilityCriteria(\n name='criteria2',\n indicator= indicator2, # xarray object\n func= SuitabilityFunction(name=\"another_function_name\", params={'param1': value1, 'param2': value2})\n )\n # add all necessary criteria\n }\n\n # define your land suitability\n lsa = LandSuitabilityAnalysis(\n land_use= 'land_use_name',\n criteria= criteria,\n )\n\n # run your analysis\n lsa.run(params)\n\nMore detailed tutorials and examples can be found in the `User Guide`_.\n\n.. _`User Guide`: https://lsapy.readthedocs.io/en/latest/notebooks/index.html\n\n\nContributing\n------------\n\n`LSAPy` is an open-source project and we welcome contributions from the community. If you are interested in contributing, please\nrefer to the `Contribution`_ section for guidelines on how to get started helping us improve the library.\n\n.. _`Contribution`: https://lsapy.readthedocs.io/en/latest/community/contributing.html\n\nCredits\n-------\n\nThe development of `LSAPy` started as part of a PhD, funded by the `Food Transition 2050`_ Joint Postgraduate School and hosted\nby the `University of Canterbury`_ in New Zealand.\n\n|FT2050| |UC-white| |UC-black|\n\nThe Python package has been created following the `pyOpenSci Guidebook`_.\n\n.. _`Food Transition 2050`: https://www.foodtransitions2050.ac.nz/\n.. _`University of Canterbury`: https://www.canterbury.ac.nz/\n.. _`pyOpenSci Guidebook`: https://www.pyopensci.org/python-package-guide/\n\n.. |logo| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/lsapy/LSAPy_Logo_FullColour.png\n :class: dark-light\n :target: https://github.com/baptistehamon/lsapy\n :width: 400px\n :alt: LSAPy Logo\n\n.. |FT2050| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/FT2050-full_colour.png\n :class: dark-light\n :target: https://www.foodtransitions2050.ac.nz/\n :width: 200px\n :alt: Food Transition 2050 Logo\n\n.. |UC-white| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/UCWhite.png\n :class: only-dark\n :target: https://www.canterbury.ac.nz/\n :width: 100px\n :alt: University of Canterbury Logo\n\n.. |UC-black| image:: https://raw.githubusercontent.com/baptistehamon/lsapy/main/docs/logos/UCBlack.png\n :class: only-light\n :target: https://www.canterbury.ac.nz/\n :width: 100px\n :alt: University of Canterbury Logo\n\n.. |pypi| image:: https://img.shields.io/pypi/v/lsapy.svg\n :target: https://pypi.python.org/pypi/lsapy\n :alt: Python Package Index Build\n\n.. |status| image:: https://www.repostatus.org/badges/latest/wip.svg\n :target: https://www.repostatus.org/#wip\n :alt: Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.\n\n.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.15015111.svg\n :target: https://doi.org/10.5281/zenodo.15015111\n :alt: Zenodo DOI\n\n.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Ruff\n\n.. |docs| image:: https://readthedocs.org/projects/lsapy/badge/\n :target: https://lsapy.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. |question| image:: https://img.shields.io/badge/Question_%3F-blue?style=social&logo=github\n :target: https://github.com/baptistehamon/lsapy/labels/question\n :alt: Link to question issues\n\n.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/baptistehamon/lsapy/main.svg\n :target: https://results.pre-commit.ci/latest/github/baptistehamon/lsapy/main\n :alt: pre-commit.ci status\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for Land Suitability Analysis.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/baptistehamon/lsapy",
"Issues": "https://github.com/baptistehamon/lsapy/issues"
},
"split_keywords": [
"lsapy",
" land suitability analysis",
" spatial analysis",
" gis",
" geography"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "77386f301e05d90daede8b4efa4dddfb867bb500e5b5bf055e3e403adb312722",
"md5": "c4410d70120d4178e13c80bd5f102c2a",
"sha256": "c09e39acec9165ebe1761de77836b44de1a796be3eea895582ecddac5a048ec6"
},
"downloads": -1,
"filename": "lsapy-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4410d70120d4178e13c80bd5f102c2a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 20735322,
"upload_time": "2025-07-26T06:19:46",
"upload_time_iso_8601": "2025-07-26T06:19:46.583679Z",
"url": "https://files.pythonhosted.org/packages/77/38/6f301e05d90daede8b4efa4dddfb867bb500e5b5bf055e3e403adb312722/lsapy-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a95dbb7e96082d9a1ed3fe20722286251fb10f460ee4d5b13ad12e772e8389ce",
"md5": "2847ea65a63eb4d1f84c364b015482af",
"sha256": "789eaa583caa19da46e4b85ddc85eed9e65e74097be9d7a6e928a00f0fd97715"
},
"downloads": -1,
"filename": "lsapy-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2847ea65a63eb4d1f84c364b015482af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21549855,
"upload_time": "2025-07-26T06:19:49",
"upload_time_iso_8601": "2025-07-26T06:19:49.933614Z",
"url": "https://files.pythonhosted.org/packages/a9/5d/bb7e96082d9a1ed3fe20722286251fb10f460ee4d5b13ad12e772e8389ce/lsapy-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-26 06:19:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "baptistehamon",
"github_project": "lsapy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lsapy"
}
JSON
