lsapy 0.1.0.dev0__tar.gz → 0.1.0.dev2__tar.gz

lsapy-0.1.0.dev2/CHANGELOG.rst

@@ -0,0 +1,47 @@
+=========
+Changelog
+=========
+
+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 accross *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.0.dev2/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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.0.dev2/CONTRIBUTING.rst

@@ -0,0 +1,157 @@
+=====================
+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 you to format your code using `ruff`:
+
+    .. code-block:: shell
+
+        ruff check --fix 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 the
+    development stage of `LSAPy`.
+
+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:
+
+Tagging and releasing on GitHub still have to made `via` the GitHub interface. The tag name should be the same as the version number (e.g., ``v1.2.3``).
+
+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.dev2/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: lsapy
+Version: 0.1.0.dev2
+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: 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: pytest >=8.3.0 ; extra == "dev"
+Requires-Dist: ruff >=0.10.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
+
+LSAPy: Land Suitability Analysis in Python
+===========================================
+
+|pypi| |zenodo| |ruff|
+
+`LSAPy` stand 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 SuitabilityFunction, SuitabilityCriteria, LandSuitability
+
+    # define your criteria
+    criteria = {
+        'crit1': SuitabilityCriteria(
+            name='criteria1',
+            indicator= indicator1, # xarray object
+            suitability_function= SuitabilityFunction("relevant-function")
+        ),
+        'crit2': SuitabilityCriteria(
+            name='criteria2',
+            indicator= indicator2, # xarray object
+            suitability_function= SuitabilityFunction("relevant-function")
+        )
+        # add all necessary criteria
+    }
+
+    # define your land suitability
+    ls = LandSuitability(
+        name= 'name_of_your_lsa',
+        criteria= criteria,
+    )
+
+    # run your analysis
+    ls.compute_suitability(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 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/
+
+.. |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
+
+.. |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

lsapy-0.1.0.dev2/README.rst

@@ -0,0 +1,107 @@
+LSAPy: Land Suitability Analysis in Python
+===========================================
+
+|pypi| |zenodo| |ruff|
+
+`LSAPy` stand 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 SuitabilityFunction, SuitabilityCriteria, LandSuitability
+
+    # define your criteria
+    criteria = {
+        'crit1': SuitabilityCriteria(
+            name='criteria1',
+            indicator= indicator1, # xarray object
+            suitability_function= SuitabilityFunction("relevant-function")
+        ),
+        'crit2': SuitabilityCriteria(
+            name='criteria2',
+            indicator= indicator2, # xarray object
+            suitability_function= SuitabilityFunction("relevant-function")
+        )
+        # add all necessary criteria
+    }
+
+    # define your land suitability
+    ls = LandSuitability(
+        name= 'name_of_your_lsa',
+        criteria= criteria,
+    )
+
+    # run your analysis
+    ls.compute_suitability(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 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/
+
+.. |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
+
+.. |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

lsapy-0.1.0.dev2/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     = .
+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)

lsapy-0.1.0.dev2/docs/api/index.rst

@@ -0,0 +1,39 @@
+=========
+LSAPy API
+=========
+
+This page provides an overview of all implemented public objects, functions and methods of the `LSAPy` package.
+
+.. warning::
+
+   The package is still in development and only pre-release versions have been published,
+   meaning the package should not be considered stable yet. Breaking changes are likely to
+   occur before the first official release.
+
+.. currentmodule:: lsapy
+
+Constructors
+------------
+
+.. autosummary:: 
+   :toctree: generated
+   :nosignatures:
+
+   SuitabilityFunction
+   SuitabilityCriteria
+   LandSuitability
+
+Membership Functions
+--------------------
+
+.. autosummary:: 
+   :toctree: generated
+   :nosignatures:
+
+   functions.logistic
+   functions.sigmoid
+   functions.vetharaniam2022_eq3
+   functions.vetharaniam2022_eq5
+   functions.vetharaniam2024_eq8
+   functions.vetharaniam2024_eq10
+

lsapy-0.1.0.dev2/docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

lsapy-0.1.0.dev2/docs/community/code_of_conduct.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../CODE_OF_CONDUCT.md

lsapy-0.1.0.dev2/docs/community/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../../CONTRIBUTING.rst

lsapy-0.1.0.dev2/docs/community/index.rst

@@ -0,0 +1,19 @@
+:html_theme.sidebar_secondary.remove:
+
+=========
+Community
+=========
+
+The project is only at the beginning of its journey but help is always welcome! We are working hard to make it better,
+and in that sense, we appreciate any feedback and contributions. As a project's contributor, you should adhere to the
+:doc:`Code of Conduct </community/code_of_conduct>`. 
+
+If you are interested in contributing to the project, please read the :doc:`Contributing Guidelines </community/contributing>`.
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Community
+    :hidden:
+
+    Contributing <contributing>
+    Code of Conduct <code_of_conduct>