Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #26

Merged
merged 2 commits into from
Sep 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
contact_links:
- name: Ask questions
url: https://github.com/giswqs/pygis/discussions/categories/q-a
about: Please ask and answer questions here.
- name: Ideas
url: https://github.com/giswqs/pygis/discussions/categories/ideas
about: Please share your ideas here.
- name: Ask questions from the GIS community
url: https://gis.stackexchange.com
about: To get answers from questions in the GIS community, please ask and answer questions here.
- name: Ask questions
url: https://github.com/opengeos/pygis/discussions/categories/q-a
about: Please ask and answer questions here.
- name: Ideas
url: https://github.com/opengeos/pygis/discussions/categories/ideas
about: Please share your ideas here.
- name: Ask questions from the GIS community
url: https://gis.stackexchange.com
about: To get answers from questions in the GIS community, please ask and answer questions here.
18 changes: 9 additions & 9 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ You can contribute in many ways:

### Report Bugs

Report bugs at <https://github.com/giswqs/pygis/issues>.
Report bugs at <https://github.com/opengeos/pygis/issues>.

If you are reporting a bug, please include:

- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.

### Fix Bugs

Expand All @@ -36,13 +36,13 @@ in docstrings, or even on the web in blog posts, articles, and such.
### Submit Feedback

The best way to send feedback is to file an issue at
<https://github.com/giswqs/pygis/issues>.
<https://github.com/opengeos/pygis/issues>.

If you are proposing a feature:

- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)

## Get Started!

Expand Down Expand Up @@ -104,5 +104,5 @@ Before you submit a pull request, check that it meets these guidelines:
Put your new functionality into a function with a docstring, and add
the feature to the list in README.rst.
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and
for PyPy. Check <https://github.com/giswqs/pygis/pull_requests> and make sure that the tests pass for all
for PyPy. Check <https://github.com/opengeos/pygis/pull_requests> and make sure that the tests pass for all
supported Python versions.
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
23 changes: 16 additions & 7 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 pygis
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 All @@ -57,22 +66,22 @@ pip install --find-links=https://girder.github.io/large_image_wheels --no-cache
pip install pygis
```

All optional dependencies of pygis are listed in [requirements_dev.txt](https://github.com/giswqs/pygis/blob/master/requirements_dev.txt).
All optional dependencies of pygis are listed in [requirements_dev.txt](https://github.com/opengeos/pygis/blob/master/requirements_dev.txt).

## Installing from source

You may install the latest development version by cloning the GitHub repository with [Git](https://git-scm.com) and using pip to install from the local directory:

```bash
git clone https://github.com/giswqs/pygis.git
git clone https://github.com/opengeos/pygis.git
cd pygis
pip install .
```

It is also possible to install the latest development version directly from the GitHub repository with:

```bash
pip install git+https://github.com/giswqs/pygis.git
pip install git+https://github.com/opengeos/pygis.git
```

## Upgrading pygis
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
Loading