From 883a42726d8af79beae62b626f71086b09b7346b Mon Sep 17 00:00:00 2001 From: Neil Flood Date: Sat, 15 Mar 2025 11:15:10 +1000 Subject: [PATCH] Update download/installation instructions to clarify the dependencies, and encourage the use of conda. Also updated the link to Xavier's QGis plugin repo. --- INSTALL.txt | 3 +++ doc/source/index.rst | 22 ++++++++++++++++++---- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/INSTALL.txt b/INSTALL.txt index 5aa8130..f3cad9e 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -2,6 +2,9 @@ WARNING: To install python-fmask it is strongly recommended to use the conda forge pre-built binaries. Only install from source if you absolutely must. +The code requires RIOS, GDAL, numpy and scipy. These must be installed, preferrably +using a package manager such as conda. + To install python-fmask from the source code bundle, use the following commands diff --git a/doc/source/index.rst b/doc/source/index.rst index c93239c..564c3be 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -151,9 +151,9 @@ corresponds to which wavelength band. Downloads --------- -Get the source as a bundle from `GitHub `_. -Release notes for each version can be read in :doc:`releasenotes`. To install from source, -read the INSTALL.txt file included inside the source bundle. +This code relies heavily on GDAL, numpy, scipy and RIOS. These packages must be +installed for anything to work. For this reason, we recommend that you install using +a package manager, which will build a complete environment with everything required. Pre-built binary `Conda `_ packages are available under the 'conda-forge' channel. Once you have installed @@ -170,10 +170,24 @@ python-fmask is also available as:: spack install py-python-fmask +The source can be downloaded directly as a bundle from +`GitHub `_. +Release notes for each version can be read in :doc:`releasenotes`. To install from source, +read the INSTALL.txt file included inside the source bundle. + +Please note that python-fmask is *not* available from the PyPI repository. This is +because it depends on the GDAL library, which is also not available there, and must +be installed by some other means, such as conda. If one is using conda for GDAL, one +may as well use it for python-fmask, too. While it is technically possible to bundle +the GDAL binaries into a PyPI distribution, this carries grave risks of version +conflicts if any other package does the same thing, and is best avoided. + Applications that use python-fmask ---------------------------------- -* `Cloud Masking `_: It is a Qgis plugin for cloud masking the Landsat (4, 5, 7 and 8) products using different process and filters such as Fmask, Blue Band, Cloud QA, Aerosol and Pixel QA. +* `Cloud Masking `_: It is a Qgis plugin for cloud masking + the Landsat (4, 5, 7 and 8) products using different process and filters such as Fmask, Blue Band, + Cloud QA, Aerosol and Pixel QA. Issues ------