Skip to content

Commit 642cfa7

Browse files
authored
Update download/installation instructions to clarify the dependencies, and encourage the use of conda. Also updated the link to Xavier's QGis plugin repo. (#87)
1 parent 01d87f0 commit 642cfa7

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

INSTALL.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
WARNING: To install python-fmask it is strongly recommended to use the conda forge
33
pre-built binaries. Only install from source if you absolutely must.
44

5+
The code requires RIOS, GDAL, numpy and scipy. These must be installed, preferrably
6+
using a package manager such as conda.
7+
58

69
To install python-fmask from the source code bundle, use the following commands
710

doc/source/index.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,9 @@ corresponds to which wavelength band.
151151

152152
Downloads
153153
---------
154-
Get the source as a bundle from `GitHub <https://github.com/ubarsc/python-fmask/releases>`_.
155-
Release notes for each version can be read in :doc:`releasenotes`. To install from source,
156-
read the INSTALL.txt file included inside the source bundle.
154+
This code relies heavily on GDAL, numpy, scipy and RIOS. These packages must be
155+
installed for anything to work. For this reason, we recommend that you install using
156+
a package manager, which will build a complete environment with everything required.
157157

158158
Pre-built binary `Conda <https://github.com/conda-forge/miniforge>`_ packages are available
159159
under the 'conda-forge' channel. Once you have installed
@@ -170,10 +170,24 @@ python-fmask is also available as::
170170

171171
spack install py-python-fmask
172172

173+
The source can be downloaded directly as a bundle from
174+
`GitHub <https://github.com/ubarsc/python-fmask/releases>`_.
175+
Release notes for each version can be read in :doc:`releasenotes`. To install from source,
176+
read the INSTALL.txt file included inside the source bundle.
177+
178+
Please note that python-fmask is *not* available from the PyPI repository. This is
179+
because it depends on the GDAL library, which is also not available there, and must
180+
be installed by some other means, such as conda. If one is using conda for GDAL, one
181+
may as well use it for python-fmask, too. While it is technically possible to bundle
182+
the GDAL binaries into a PyPI distribution, this carries grave risks of version
183+
conflicts if any other package does the same thing, and is best avoided.
184+
173185
Applications that use python-fmask
174186
----------------------------------
175187

176-
* `Cloud Masking <https://smbyc.bitbucket.io/qgisplugins/cloudmasking/>`_: 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.
188+
* `Cloud Masking <https://github.com/SMByC/CloudMasking>`_: It is a Qgis plugin for cloud masking
189+
the Landsat (4, 5, 7 and 8) products using different process and filters such as Fmask, Blue Band,
190+
Cloud QA, Aerosol and Pixel QA.
177191

178192
Issues
179193
------

0 commit comments

Comments
 (0)