Installation

Required Dependencies

The core dependencies are:

  • Python 3.6 or later

  • dask

  • distributed

  • numpy

  • pandas

  • xarray

  • toolz

  • affine

  • fiona

  • gdal

  • rasterio (>=1.0.14)

  • shapely

  • pyyaml

Optional Dependencies

GeoHash

For the wrappers and other utilities related to encoding and decoding geohashes, you will need the python-geohash library:

  • python-geohash

Command Line Interface

For the command line interface, the following are also required:

  • click

  • click-plugins

  • cligj (>=0.5)

Tests

We use pytest to run the tests in this package, and require:

  • pytest

  • pytest-cov

  • pytest-lazy-fixture

  • coverage

Documentation

Documentation is built using Sphinx and requires:

  • sphinx

  • sphinx_rtd_theme

  • sphinxcontrib-bibtex

  • numpydoc

Instructions

stems is a pure Python package, but it sits on top of a pile of dependencies that may be difficult to install. The easiest way to install all of these dependencies is using the conda tool.

With conda installed and ready to use, you can install all the required dependencies for this library using one of the “environment” files located in the ci/ directory (we use these for our continuous integration tests):

$ conda create -n stems -f ci/requirements-py37.yml

With the conda environment created, you can activate it as follows:

$ conda activate stems

You should now be ready to install stems.

Stable Release

There are no stable releases of stems yet on PyPI.

From Sources

The sources for stems can be downloaded from the Github repo. You can either download the source from Github and install it using pip, or use pip to install the source from Github directly.

You can either clone the public repository:

$ git clone git://github.com/ceholden/stems

Once you have a copy of the source, you can install it with:

$ pip install -e .

The flag, -e, is recommended to tell pip to make the installation “editable”, meaning that changes you make to the files in the repository will be reflected when you import the Python package. Otherwise you would have to re-install the package with pip for changes to affect the installed package.

Alternatively, you can use pip to install it in one step,

$ pip install git+ssh://git@github.com/ceholden/stems.git