Skip to content

LSAPy Submission #261

@baptistehamon

Description

@baptistehamon

Submitting Author: @baptistehamon
All current maintainers: @baptistehamon
Package Name: LSAPy
One-Line Description of Package: Package to help and ease Land Suitability Analysis (LSA) workflow.
Repository Link: https://github.com/baptistehamon/lsapy/
Version submitted: v0.2.0
EiC: TBD
Editor: TBD
Reviewer 1: TBD
Reviewer 2: TBD
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD


Code of Conduct & Commitment to Maintain Package

Description

LSAPy is a highly customizable Python library designed to streamline and enhance Land Suitability Analysis (LSA) workflows. The package implements a fuzzy-logic approach and provides three core objects - SuitabilityFunction, SuitabilityCriteria, and LandSuitabilityAnalysis that work together to deliver a flexible and user-defined LSA framework.

Scope

  • Please indicate which category or categories.
    Check out our package scope page to learn more about our
    scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):

    • Data retrieval
    • Data extraction
    • Data processing/munging
    • Data deposition
    • Data validation and testing
    • Data visualization1
    • Workflow automation
    • Citation management and bibliometrics
    • Scientific software wrappers
    • Database interoperability

Domain Specific

  • Geospatial
  • Education

Community Partnerships

If your package is associated with an
existing community please check below:

  • For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):

    • Who is the target audience and what are scientific applications of this package?

LSA have been widely used by the scientific community to assess the suitability of agricultural products. In this context, LSAPy contributes to the reproducibility of such studies. Although initially intended for research purposes, LSAPy can be used by land managers/planners or for educational purposes, while being applicable to any type of land use (e.g., urban planning), thus extending its use beyond agricultural applications.

  • Are there other Python packages that accomplish the same thing? If so, how does yours differ?

To my knowledge, the only Python package similar to LSAPy is PyLUSAT (Python Land-Use Suitability Analysis Toolkit) but the two packages work in completely different ways. PyLUSAT provides a vector-based GIS routines and determines suitability evaluating the spatial relationship between objects, while LSAPy assesses suitability by aggregating gridded criteria indicators. Morevover, PyLUSAT workflow can easely be integrating into LSAPy providing the relevant spatial relationship between cells and objects as suitablility criteria. Finally, agricultural application of LSA often rely on gridded temporal climate data that PyLUSAT don't support, limiting its potential use for such studies.

  • If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted:

LSAPy was pre-submitted in the issue #249.

Technical checks

For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:

  • does not violate the Terms of Service of any service it interacts with.
  • uses an OSI approved license.
  • contains a README with instructions for installing the development version.
  • includes documentation with examples for all functions.
  • contains a tutorial with examples of its essential functions and uses.
  • has a test suite.
  • has continuous integration setup, such as GitHub Actions CircleCI, and/or others.

Publication Options

JOSS Checks
  • The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
  • The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
  • The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/.
  • The package is deposited in a long-term repository with the DOI: https://zenodo.org/records/15015111

Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

  • Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Confirm each of the following by checking the box.

  • I have read the author guide.
  • I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.

Please fill out our survey

P.S. Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

The editor template can be found here.

The review template can be found here.

Footnotes

  1. Please fill out a pre-submission inquiry before submitting a data visualization package.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    pre-review-checks

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions