Installation

Install from PyPI

vgrid is available on PyPI. To install vgrid, run this command in your terminal:

pip install vgrid

Install from conda-forge

vgrid is also available on conda-forge. If you have Anaconda or Miniconda installed on your computer, you can install vgrid using the following command:

conda install vgrid -c conda-forge

The vgrid package has some optional dependencies (e.g., geopandas and localtileserver), which can be challenging to install on some computers, especially Windows. It is highly recommended that you create a fresh conda environment to install geopandas and vgrid. Follow the commands below to set up a conda env and install geopandas, localtileserver, keplergl, pydeck, and vgrid.

conda install -n base mamba -c conda-forge
mamba create -n geo vgrid geopandas localtileserver python -c conda-forge

Optionally, you can install some Jupyter notebook extensions, which can improve your productivity in the notebook environment. Some useful extensions include Table of Contents, Gist-it, Autopep8, Variable Inspector, etc. See this post for more information.

conda install jupyter_contrib_nbextensions -c conda-forge

Install from GitHub

To install the development version from GitHub using Git, run the following command in your terminal:

pip install git+https://github.com/opengeoshub/vgrid

Upgrade vgrid

If you have installed vgrid before and want to upgrade to the latest version, you can run the following command in your terminal:

pip install -U vgrid

If you use conda, you can update vgrid to the latest version by running the following command in your terminal:

conda update -c conda-forge vgrid

To install the development version from GitHub directly within Jupyter notebook without using Git, run the following code:

import vgrid
vgrid.update_package()