Metadata-Version: 2.1
Name: PyLandslide
Version: 0.0.8
Summary: Tools for landslide hazard uncertainty analysis.
Home-page: https://github.com/IERRG/PyLandslide
Author: Mohammed Basheer
Author-email: mohammedadamabbaker@gmail.com
License: GNU
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/x-rst
License-File: LICENSE

===========
PyLandslide
===========

PyLandslide is a machine learning-assisted open-source Python tool for landslide susceptibility mapping and uncertainty analysis.

Introduction
============

For details on how to install and use the tool, please refer to the `Documentation <https://ierrg.github.io/PyLandslide/>`__.

PyLandslide is a tool for spatial mapping of landslide susceptibility. The tool uses "qualitative map combination," in which the effects of multiple factors that contribute to landslide occurrence are combined using weights. The tool uses Machine learning to determine weights and their uncertainties. The tool is also designed to conduct sensitivity analysis based on weight ranges and spatially compare the outcomes of different weight choices.

Landslide susceptibility and uncertainty analysis can be performed in PyLandslide either through high-level commands or using Python code. Either way, some inputs to different methods and functionalities need to be provided through JSON-based document format. The `Documentation <https://ierrg.github.io/PyLandslide/>`__ page provides further details on how to use the tool and provide the required inputs.

.. image:: https://raw.githubusercontent.com/IERRG/PyLandslide/main/docs/figs/frm.jpg
   :width: 750px

Installation
============

PyLandslide should work on Python 3.6 (or later) on Windows, Linux or OS X.

See the documentation for details on `how to install PyLandslide <https://ierrg.github.io/PyLandslide/installation.html>`__.

PyLandslide can be installed by running:

.. code-block:: console

    pip install PyLandslide

For advanced users, developers, and those who wish to contribute to the development of PyLandslide, make sure to have installed the required `dependencies <https://ierrg.github.io/PyLandslide/installation.html>`__. Then clone the repository:

.. code-block:: console

    git clone https://github.com/IERRG/PyLandslide.git

Once the repository is cloned, navigate to its directory and run:

.. code-block:: console

    python setup.py install

Or the following for development mode:

.. code-block:: console

    python setup.py develop

Citation
========

Please cite the following papers when using PyLandslide:


    1. Basheer, Oommen, Takamatsu & Suzuki. Machine learning and sensitivity analysis approach to quantify uncertainty in landslide susceptibility mapping. https://documents.worldbank.org/en/publication/documents-reports/documentdetail/099356212142224352/idu1aab5df2016d2814a3c1bf5b11897f7cbd136 (2022).


License
=======

Copyright (C) 2023, `Mohammed Basheer <https://scholar.google.com/citations?user=KM_oVpkAAAAJ&hl=en>`__ and `Thomas Oommen <https://scholar.google.com/citations?user=EP89cqIAAAAJ&hl=en>`__.


PyLandslide is released under the GNU General Public License.
