Installation

Installing the dependencies

Satsense has a few dependencies that cannot be installed from PyPI:

  • the dependencies of the GDAL Python package
  • the dependencies of the netCDF4 Python package

Ubuntu Linux 18.04 and later

To install the above mentioned dependencies, run

sudo apt install libgdal-dev libnetcdf-dev

this probably also works for other Debian-based Linux distributions.

RPM-based Linux distributions

To install the above mentioned dependencies, run

sudo yum install gdal-devel netcdf-devel

Conda

Assuming you have conda installed and have downloaded the satsense environment.yml file to the current working directory, you can install all dependencies by running:

conda env create --file environment.yml --name satsense

or you can install just the minimal dependencies by running

conda create --name satsense libgdal libnetcdf nb_conda

Make sure to activate the environment after installation:

conda activate satsense

Installing Satsense from PyPI

If you did not use conda to install the dependencies, you may still want to create and activate a virtual environment for satsense, e.g. using venv

python3 -m venv ~/venv/satsense
source ~/venv/satsense/bin/activate

Next, install satsense by running

pip install satsense

If you are planning on using the Demonstration Jupyter notebooks, you can install the required extra dependencies with

pip install satsense[notebooks]

Installing Satsense from source for development

Clone the satsense repository, install the dependencies as described above, go to the directory where you have checked out satsense and run

pip install -e .[dev]

or

pip install -e .[dev,notebooks]

if you would also like to use the Demonstration Jupyter notebooks.

Please read our contribution guidelines before starting development.

Known installation issues

If you are experiencing ‘NetCDF: HDF errors’ after installation with pip, this may be resolved by using the following command to install

pip install --no-binary netcdf4 satsense

see this rasterio issue for more information.