Installation

Note

The SenSE has been developed against Python 3.10. It cannot be guaranteed to work with previous Python versions.

Installation via Conda

Download and install Anaconda or Miniconda. Anaconda/Miniconda installation instructions can be found here

To install all required modules, use:

git clone https://github.com/McWhity/sense.git
cd sense
conda env create --prefix ./env --file environment.yml
conda activate ./env # activate the environment

To install SenSE into an existing Python environment, use:

python -m pip install .

To install for development, use:

python -m pip install --editable .

Installation via virtualenv and python

Install system requirements:

sudo apt install python3-pip python3-tk python3-virtualenv python3-venv virtualenv

Create a virtual environment:

git clone https://github.com/McWhity/sense.git
cd sense
virtualenv -p /usr/bin/python3 env
source env/bin/activate # activate the environment
pip install --upgrade pip setuptools # update pip and setuptools

To install SenSE into an existing Python environment, use:

python -m pip install .

To install for development, use:

python -m pip install --editable .

Installation via Docker

SenSE can also be run using Docker. To build it locally use

git clone https://github.com/McWhity/sense.git
cd sense
docker build -t sense:latest .

Optional: Installation of further dependencies

For testing, running jupyter notebooks and creating ReadTheDocs documentation please install:

python -m pip install -r docs/docs_requirements.txt

Not needed if docker is used.

Summary of dependencies

Needed for core functionality

matplotlib
scipy
numba
numpy

Needed for testing, jupyter, ReadTheDocs

-r ../requirements.txt
sphinxcontrib-bibtex
pytest>=4.6
jupyter
sphinx_rtd_theme
nbconvert
mistune
ipykernel
myst-nb
docutils
pandoc
geopandas
stackstac
pystac_client
planetary_computer
shapely
odc
odc-stac
rioxarray