From cdd40d4f8bf2585c95e49b26d0367e57fb37c5cc Mon Sep 17 00:00:00 2001 From: Sergio Souza Costa Date: Thu, 8 Oct 2026 13:27:36 -0300 Subject: [PATCH] docs: install from PyPI (pip install disslucc); PyPI and DOI badges --- README.md | 7 ++++++- docs/index.md | 5 ++++- docs/quickstart.md | 5 ++++- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9307f0a..da49f4f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # disslucc [![Tests](https://github.com/DisSModel/disslucc/actions/workflows/tests.yml/badge.svg)](https://github.com/DisSModel/disslucc/actions/workflows/tests.yml) +[![PyPI](https://img.shields.io/pypi/v/disslucc.svg)](https://pypi.org/project/disslucc/) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23219338.svg)](https://doi.org/10.5281/zenodo.23219338) Land use and land cover change (LUCC) modeling, raster-only, script-first, on top of [`dissmodel`](https://github.com/DisSModel/dissmodel). @@ -46,9 +48,12 @@ status, and what's still pending (this does not happen before disrupted mid-review). ```bash -pip install -e ".[examples]" +pip install disslucc # from PyPI +pip install "disslucc[examples]" # + matplotlib, for the examples ``` +From a clone, for development: `pip install -e ".[dev]"`. + ```python from dissmodel.core import Environment from disslucc import DemandInline, PotentialLinearRegression, AllocationClueLike diff --git a/docs/index.md b/docs/index.md index 67b2290..6401a00 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,9 +9,12 @@ saturation. Agreement with the original TerraME/LuccME is checked in see [Validation](validation.md). ```bash -pip install -e ".[examples]" +pip install disslucc # from PyPI +pip install "disslucc[examples]" # + matplotlib, for the examples ``` +From a clone, for development: `pip install -e ".[dev]"`. + ```python from dissmodel.core import Environment from disslucc import DemandInline, PotentialLinearRegression, AllocationClueLike diff --git a/docs/quickstart.md b/docs/quickstart.md index ae63c2c..eb242a1 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -3,9 +3,12 @@ ## Install ```bash -pip install -e ".[examples]" +pip install disslucc # from PyPI +pip install "disslucc[examples]" # + matplotlib, for the examples ``` +From a clone, for development: `pip install -e ".[dev]"`. + `dissmodel` comes as a dependency (brings `geopandas`/`rasterio` along). `matplotlib` is optional, only for the examples that generate a quicklook.