feat: renamed to focalpy

Author: martibosch

CONTRIBUTING.md

@@ -28,4 +28,4 @@ Before you submit a pull request, check that it meets these guidelines:
 
 1. The pull request should include tests.
 1. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
-1. The pull request should work for Python 3.8, 3.9, 3.10 and 3.11. Check https://github.com/martibosch/multilandpy/actions and make sure that the tests pass for all supported Python versions.
+1. The pull request should work for Python 3.8, 3.9, 3.10 and 3.11. Check https://github.com/martibosch/focalpy/actions and make sure that the tests pass for all supported Python versions.

README.md

@@ -1,18 +1,16 @@
-[![PyPI version fury.io](https://badge.fury.io/py/multilandpy.svg)](https://pypi.python.org/pypi/multilandpy/)
-[![Documentation Status](https://readthedocs.org/projects/multilandpy/badge/?version=latest)](https://multilandpy.readthedocs.io/en/latest/?badge=latest)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/martibosch/multilandpy/main.svg)](https://results.pre-commit.ci/latest/github/martibosch/multilandpy/main)
-[![codecov](https://codecov.io/gh/martibosch/multilandpy/branch/main/graph/badge.svg?token=hKoSSRn58a)](https://codecov.io/gh/martibosch/multilandpy)
-[![GitHub license](https://img.shields.io/github/license/martibosch/multilandpy.svg)](https://github.com/martibosch/multilandpy/blob/main/LICENSE)
+[![PyPI version fury.io](https://badge.fury.io/py/focalpy.svg)](https://pypi.python.org/pypi/focalpy/)
+[![Documentation Status](https://readthedocs.org/projects/focalpy/badge/?version=latest)](https://focalpy.readthedocs.io/en/latest/?badge=latest)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/martibosch/focalpy/main.svg)](https://results.pre-commit.ci/latest/github/martibosch/focalpy/main)
+[![codecov](https://codecov.io/gh/martibosch/focalpy/branch/main/graph/badge.svg?token=hKoSSRn58a)](https://codecov.io/gh/martibosch/focalpy)
+[![GitHub license](https://img.shields.io/github/license/martibosch/focalpy.svg)](https://github.com/martibosch/focalpy/blob/main/LICENSE)
 
-# multilandpy
+# focalpy
 
-Computing multi-scale landscape features for vector and raster layers (terrain/topographic indices, vegetation, building areas and volumes...) in Python.
-
-> *multilandpy* is an analogy to the [multilandr](https://github.com/phuais/multilandR) package [1] to compute multi-scale landscape metrics in R. However, instead of lansdcape metrics<sup>[1](#pylandstats)</sup>, multilandpy computes generic mutli-scale landscape features for vector and raster layers, such as topographic features, tree canopy cover as well as building areas and volumes.
+Toolkit for focal site multi-scale studies in Python
 
 Example application to compute the proportion of tree canopy around (with multiple buffer radii) weather stations in Zurich, Switzerland:
 
-![stations-tree-canopy](https://github.com/martibosch/multilandpy/raw/main/figures/stations-tree-canopy.png)
+![stations-tree-canopy](https://github.com/martibosch/focalpy/raw/main/figures/stations-tree-canopy.png)
 
 *(C) OpenStreetMap contributors, tiles style by Humanitarian OpenStreetMap Team hosted by OpenStreetMap France*
 
@@ -23,7 +21,7 @@ Start by instantiating a `MultiScaleFeatureComputer` for [a given region of inte
 ```python
 import swisstopopy
 
-import multilandpy
+import focalpy
 
 # parameters
 region = "EPFL"
@@ -32,7 +30,7 @@ buffer_dists = [10, 25, 50, 100]
 grid_res = 200
 
 # instantiate the multi-scale feature computer
-msfc = multilandpy.MultiScaleFeatureComputer(region=region, crs=crs)
+msfc = focalpy.MultiScaleFeatureComputer(region=region, crs=crs)
 
 # generate a regular grid of points/sites within the region
 site_gser = msfc.generate_regular_grid_gser(grid_res, geometry_type="point")
@@ -74,21 +72,21 @@ features_df.head()
 |              |         100 | 250923.879244 |    0.043386 | 0.073637 |  0.006363 | -0.716217 |
 |            1 |          10 |    627.309698 |    0.000000 | 0.095521 |  0.228504 |  0.080963 |
 
-See the [overview notebook](https://multilandpy.readthedocs.io/en/latest/overview.html) and the [API documentation](https://multilandpy.readthedocs.io/en/latest/api.html) for more details on the features of multilandpy.
+See the [overview notebook](https://focalpy.readthedocs.io/en/latest/overview.html) and the [API documentation](https://focalpy.readthedocs.io/en/latest/api.html) for more details on the features of focalpy.
 
 ## Installation
 
-Like many other geospatial Python packages, multilandpy requires many base C libraries that cannot be installed with pip. Accordingly, the best way to install multilandpy is to use conda/mamba, i.e., in a given conda environment, run:
+Like many other geospatial Python packages, focalpy requires many base C libraries that cannot be installed with pip. Accordingly, the best way to install focalpy is to use conda/mamba, i.e., in a given conda environment, run:
 
 ```bash
 # or mamba install -c conda-forge geopandas
 conda install -c conda-forge geopandas
 ```
 
-Within the same conda environment, you can then install multilandpy using pip:
+Within the same conda environment, you can then install focalpy using pip:
 
 ```bash
-pip install https://github.com/martibosch/multilandpy/archive/main.zip
+pip install https://github.com/martibosch/focalpy/archive/main.zip
 ```
 
 ## Acknowledgements

docs/api.md

@@ -3,18 +3,18 @@
 ## Computing features
 
 ```{eval-rst}
-.. autoclass:: multilandpy.MultiScaleFeatureComputer
+.. autoclass:: focalpy.MultiScaleFeatureComputer
    :members:
 ```
 
 ## Standalone topographic functions
 
 ```{eval-rst}
-.. autofunction:: multilandpy.topo.compute_terrain_attribute
+.. autofunction:: focalpy.topo.compute_terrain_attribute
 
-.. autofunction:: multilandpy.topo.northness
+.. autofunction:: focalpy.topo.northness
 
-.. autofunction:: multilandpy.topo.comparative_height_at_center
+.. autofunction:: focalpy.topo.comparative_height_at_center
 
-.. autofunction:: multilandpy.topo.flow_accumulation_at_center
+.. autofunction:: focalpy.topo.flow_accumulation_at_center
 ```

docs/conf.py

@@ -5,10 +5,10 @@
 
 import pkg_resources
 
-project = "multilandpy"
+project = "focalpy"
 author = "Martí Bosch"
 
-release = pkg_resources.get_distribution("multilandpy").version
+release = pkg_resources.get_distribution("focalpy").version
 version = ".".join(release.split(".")[:2])
 
 extensions = [
@@ -21,7 +21,7 @@
 autodoc_typehints = "description"
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
-    "github_url": "https://github.com/martibosch/multilandpy",
+    "github_url": "https://github.com/martibosch/focalpy",
 }
 
 # add module to path

docs/environment.yml

@@ -1,4 +1,4 @@
-name: multilandpy
+name: focalpy
 channels:
   - conda-forge
 dependencies:

docs/usage.md

@@ -1,7 +1,7 @@
 # Usage
 
-To use multilandpy in a project
+To use focalpy in a project
 
 ```python
-import multilandpy
+import focalpy
 ```

focalpy/__init__.py

@@ -0,0 +1,9 @@
+"""focalpy."""
+
+from focalpy.features import MultiScaleFeatureComputer
+from focalpy.scale import (
+    fully_connected_threshold,
+    no_island_threshold,
+    scale_eval_df,
+    scale_of_effect_dict,
+)

multilandpy/features.py renamed to focalpy/features.py

@@ -13,13 +13,12 @@
 import pandas as pd
 import rasterio as rio
 import rasterstats
+from multilandpy import topo, utils
 from osgeo import gdal
 from pyregeon import CRSType, RegionMixin, RegionType
 from rasterio import mask, transform
 from tqdm import tqdm
 
-from multilandpy import topo, utils
-
 # to use `progress_apply`
 tqdm.pandas()