1. Install the released version#

conda install -c conda-forge mintpy

mamba install -c conda-forge mintpy

docker pull ghcr.io/insarlab/mintpy:latest

apt install mintpy

2. Install the development version#

Note: The installation note below is tested on Linux and macOS, and is still experimental on Windows (may have bugs).

MintPy is written in Python 3 and relies on several Python modules, check the requirements.txt file for details. We recommend using conda to install the python environment and the prerequisite packages, because of the convenient management and default performance setting with numpy/scipy and pyresample.

2.1 Install on Linux#

cd ~/tools
git clone https://github.com/insarlab/MintPy.git

# use wget or curl to download in the command line or click from the web browser
# for macOS, use Miniforge3-MacOSX-x86_64.sh instead.
wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
bash Miniforge3-Linux-x86_64.sh -b -p ~/tools/miniforge
~/tools/miniforge/bin/mamba init bash

# Add "isce2"      below to install extra dependencies if you use ISCE-2
# Add "gdal"       below to install extra dependencies if you use ARIA, FRInGE or HyP3
# Add "gdal'<3.9'" below to install extra dependencies if you use GMTSAR
mamba create --name insar --file ~/tools/MintPy/requirements.txt

# Add "isce2"      below to install extra dependencies if you use ISCE-2
# Add "gdal"       below to install extra dependencies if you use ARIA, FRInGE or HyP3
# Add "gdal'<3.9'" below to install extra dependencies if you use GMTSAR
mamba activate my-existing-env
mamba install --file ~/tools/MintPy/requirements.txt

python -m pip install -e ~/tools/MintPy

if [ -z ${PYTHONPATH+x} ]; then export PYTHONPATH=""; fi
export MINTPY_HOME=~/tools/MintPy
export PATH=${PATH}:${MINTPY_HOME}/src/mintpy/cli
export PYTHONPATH=${PYTHONPATH}:${MINTPY_HOME}/src

2.2 Install on macOS#

# MacPorts Installer addition on 2017-09-02_at_01:27:12: adding an appropriate PATH variable for use with MacPorts.
export PATH=/opt/local/bin:/opt/local/sbin:${PATH}
export MANPATH=/opt/local/share/man:${MANPATH}
# Finished adapting your PATH environment variable for use with MacPorts.

sudo port selfupdate

# install dependencies with macports
# use "port -N install" to use the safe default for prompt questions
sudo port install $(cat MintPy/docs/ports.txt)

# install dependencies not available on macports: pysolid, pykml, pykdtree, pyresample, cdsapi
sudo -H /opt/local/bin/pip install git+https://github.com/insarlab/PySolid.git
sudo -H /opt/local/bin/pip install git+https://github.com/insarlab/PyAPS.git
sudo -H /opt/local/bin/pip install git+https://github.com/tylere/pykml.git
sudo -H /opt/local/bin/pip install git+https://github.com/storpipfugl/pykdtree.git
sudo -H /opt/local/bin/pip install git+https://github.com/pytroll/pyresample.git
sudo -H /opt/local/bin/pip install git+https://github.com/ecmwf/cdsapi.git

2.3 Install on Windows#

3. Post-Installation Setup#

a. ERA5 for tropospheric correction#

Set up an account for ERA5 to download weather re-analysis datasets for tropospheric delay correction as described in insarlab/PyAPS.

WEATHER_DIR: Optionally, if you defined an environment variable named WEATHER_DIR to contain the path to a directory, MintPy will download the GAM files into the indicated directory. Also, MintPy will look for the GAM files in the directory before downloading a new one to prevent downloading multiple copies if you work with different datasets that cover the same date/time.

b. Dask for parallel processing#

We recommend setting the temporary-directory in your Dask configuration file, e.g. ~/.config/dask/dask.yaml, by adding the following line, to avoid the potential workspace lock issue. Check the dask.md file for more details on parallel processing.

temporary-directory: /tmp  # Directory for local disk like /tmp, /scratch, or /local

# If you share the same machine with others, use the following instead to avoid permission issues.
# temporary-directory: /tmp/{replace_this_with_your_user_name}

c. Extra environment variables setup#

We recommend setting the following environment variables, e.g. in your ~/.bash_profile file, to avoid occasional errors with GDAL VRT and HDF5 files I/O.

export VRT_SHARED_SOURCE=0             # do not share dataset while using GDAL VRT in a multi-threading environment
export HDF5_DISABLE_VERSION_CHECK=2    # suppress the HDF5 version warning message (0 for abort; 1/2 for printout/suppress warning message)
export HDF5_USE_FILE_LOCKING=FALSE     # request that HDF5 file locks should NOT be used

d. Tab complete sub-commands#

We recommend activating the tab completion as below if you:

1. Use bash or zsh shells
2. On Linux or macOS
3. Run MintPy in sub-commands style, e.g. mintpy view instead of view.py

activate-global-python-argcomplete --user

On macOS, there is a bash version compatibility issue, which can be fixed as below. If you use the default zsh shell, no fix is needed.

brew install bash

echo "/usr/local/bin/bash" | sudo tee -a /etc/shells
chsh -s "/usr/local/bin/bash"

# bash completion
if [ -f ~/.bash_completion ]; then
    . ~/.bash_completion
fi