Adding example with New Caledonia

ghislainv · Dec 8, 2024 · d7f41cd · d7f41cd
1 parent 9f63724
commit d7f41cd
Show file tree

Hide file tree

Showing 15 changed files with 952 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 tmp_outputs
 docs
 docsrc/notebooks/*/out*
+docsrc/notebooks/*/data*
 test/out*
 
 # Byte-compiled / optimized / DLL files

diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?= -E
-SPHINXBUILD   ?= ~/venvs/gee/bin/sphinx-build
+SPHINXBUILD   ?= ~/venvs/geefcc/bin/sphinx-build
 SOURCEDIR     = docsrc
 BUILDDIR      = build
 

diff --git a/README.rst b/README.rst
@@ -32,7 +32,7 @@ The ``geefcc`` Python package can be used to make forest cover change (fcc) maps
 The ``geefcc`` package depends on the `xee <https://github.com/google/Xee>`_ Python package, which allows opening GEE datasets locally without exporting data to GEE assets or Google Drive. The user only has to specify an area of interest (aoi), either with an extent, a polygon vector file, or a country iso code (e.g. PER for Peru), and the years defining the time periods considered for the forest cover change (e.g. 2000, 2010, 2020). For the Global Forest Change product, the users also has to specify a tree cover threshold to define the forest (e.g. 75%).
 
 .. note::
-   The current version of the package uses GFC data up to year 2023 (`GFC v1.11 2023 <https://developers.google.com/earth-engine/datasets/catalog/UMD_hansen_global_forest_change_2023_v1_11>`_) and TMF data up to year 2022 (`TMF v1 2022 <https://forobs.jrc.ec.europa.eu/TMF/data>`_) so that years for computing forest cover change can be in the interval 2001--2024 for GFC (GFC does not provide loss for the year 2000) and 2000--2023 for TMF. Forest cover is given on the 1\ :sup:`st` of January for each year. The current version of the package only considers **deforestation as change** and **not forest gain or regrowth**.
+   The current version of the package uses GFC data up to year 2023 (`GFC v1.11 2023 <https://developers.google.com/earth-engine/datasets/catalog/UMD_hansen_global_forest_change_2023_v1_11>`_) and TMF data up to year 2023 (`TMF v1 2023 <https://forobs.jrc.ec.europa.eu/TMF/data>`_) so that years for computing forest cover change can be in the interval 2001--2024 for GFC (GFC does not provide loss for the year 2000) and 2000--2024 for TMF. Forest cover is given on the 1\ :sup:`st` of January for each year. The current version of the package only considers **deforestation as change** and **not forest gain or regrowth**.
 
 Prerequisites
 =============
@@ -97,7 +97,7 @@ Install Python dependencies and ``geefcc`` in the *OSGeo4W Shell* or in the newl
    # Upgrade pip, setuptools, and wheel
    python3 -m pip install --upgrade pip setuptools wheel
    # Install numpy
-   python3 -m numpy
+   python3 -m pip install numpy
    # Install gdal Python bindings (the correct version)
    python3 -m pip install gdal==$(gdal-config --version)
    # Install geefcc. This will install all other dependencies

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 745d79c7f853df9a0f37e693132a6a65
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: d14088b81a15f2c5bb83fed7dd665d70
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docsrc/articles.rst b/docsrc/articles.rst
@@ -4,6 +4,6 @@ Articles
 .. toctree::
    :maxdepth: 1
 
-   notebooks/get_started/get_started.ipynb
+   notebooks/get_started/get_started
    notebooks/large_countries/large_countries
-
+   notebooks/newcal/newcal
diff --git a/docsrc/conf.py b/docsrc/conf.py
@@ -41,7 +41,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode",
-              "sphinx.ext.mathjax", "nbsphinx"]
+              "sphinx.ext.mathjax"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docsrc/notebooks/newcal/comparison_geefcc_nc.csv b/docsrc/notebooks/newcal/comparison_geefcc_nc.csv
@@ -0,0 +1,4 @@
+product,version,perc,fc2001,fc2010,fc2020,d1,d2
+tmf,v1_2023,,893964,869352,846182,2735,2317
+gfc,v1_11(2023),80,661138,657391,654898,416,249
+gfc,v1_11(2023),60,899544,892894,887472,739,542
diff --git a/docsrc/notebooks/newcal/fcc_gfc60.png b/docsrc/notebooks/newcal/fcc_gfc60.png
diff --git a/docsrc/notebooks/newcal/fcc_gfc80.png b/docsrc/notebooks/newcal/fcc_gfc80.png
diff --git a/docsrc/notebooks/newcal/fcc_tmf.png b/docsrc/notebooks/newcal/fcc_tmf.png