Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
giswqs committed Sep 22, 2024
1 parent 7b351e6 commit ca05aa9
Show file tree
Hide file tree
Showing 4 changed files with 3,342 additions and 13 deletions.
8 changes: 0 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,6 @@

Currently, the `pygis` package only helps you install optional dependencies for [geemap](https://geemap.org/) and [leafmap](https://leafmap.org/), making it easier to set up a conda environment for geospatial analysis and avoid dependency conflicts during installation. The `pygis` package itself does not have any meaningful functions yet. After installation, you can continue to the commonly used geospatial packages as usual.

## Installation

Installing optional dependencies for [geemap](https://geemap.org/) and [leafmap](https://leafmap.org/) with only one command.

```bash
mamba install -c conda-forge pygis
```

## Video Tutorial

[![Introducing pygis](images/thumbnail.png)](https://youtu.be/4eY4cmnOGVI "Introducing pygis")
Expand Down
17 changes: 13 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,18 @@

The pygis package has many dependencies, such as [GeoPandas](https://geopandas.org), [rasterio](https://rasterio.readthedocs.io/), and [localtileserver](https://github.com/banesullivan/localtileserver). These optional dependencies can sometimes be a challenge to install, especially on Windows. Therefore, we advise you to closely follow the recommendations below to avoid installation problems.

<!-- ## Video Tutorial
## Video Tutorial

[![Introducing pygis](images/thumbnail.png)](https://youtu.be/Y1xB7d2VbFY "Introducing pygis") -->
[![Introducing pygis](images/thumbnail.png)](https://youtu.be/Y1xB7d2VbFY "Introducing pygis")

## Installing with uv

[uv](https://docs.astral.sh/uv/) us an extremely fast Python package and project manager, written in Rust. It is designed to be a drop-in replacement for pip. You can install `pygis` using `uv` as follows:

```bash
uv pip install ppygis
uv pip install gdal pyproj --find-links https://girder.github.io/large_image_wheels
```

## Installing with Anaconda/Miniconda

Expand All @@ -25,7 +34,7 @@ Creating a new environment is not strictly necessary, but given that some pygis
The following commands create a new conda environment with the name `geo` and install pygis and its dependencies (e.g., GeoPandas, localtileserver) in it:

```bash
conda create -n geo python=3.9
conda create -n geo python=3.12
conda activate geo
conda install pygis -c conda-forge
```
Expand All @@ -41,7 +50,7 @@ conda install -c conda-forge pygis
When installing packages using the conda package manager, sometimes it can take a while for conda to resolve dependencies. If it takes too long or fails to resolve dependencies, you can try using the [Mamba](https://mamba.readthedocs.io/en/latest) package manager to install pygis and its dependencies. Mamba is a fast, robust, and cross-platform package manager. It runs on Windows, macOS, and Linux, and is fully compatible with conda packages and supports most of conda’s commands. Once Mamba is installed in a conda environment, you can then simply replace any `conda` command with `mamba`. For example, to install pygis and its dependencies with Mamba, you can use the following commands:

```bash
conda create -n geo python=3.9
conda create -n geo python=3.12
conda activate geo
conda install -c conda-forge mamba
mamba install -c conda-forge gdal
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dynamic = [
]
description = "A Python package for installing optional dependencies for geemap and leafmap."
readme = "README.md"
requires-python = ">=3.8"
requires-python = ">=3.9"
license = {text = "MIT license"}
keywords = ["pygis"]
classifiers = [
Expand Down
Loading

0 comments on commit ca05aa9

Please sign in to comment.