From 6d17dde72d44d6054ebf2808fe94d0f37eaa34d5 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Wed, 23 Oct 2024 16:29:44 -0800 Subject: [PATCH 01/14] Unpin Rasterio --- dev-environment.yml | 2 +- environment.yml | 2 +- requirements.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/dev-environment.yml b/dev-environment.yml index e17b7561..848ee9e3 100644 --- a/dev-environment.yml +++ b/dev-environment.yml @@ -8,7 +8,7 @@ dependencies: - numpy=1.* - matplotlib=3.* - pyproj>=3.4,<4 - - rasterio>=1.3,<1.4 + - rasterio>=1.3,<2 - scipy=1.* - tqdm - scikit-image=0.* diff --git a/environment.yml b/environment.yml index cd855041..8f5279c5 100644 --- a/environment.yml +++ b/environment.yml @@ -8,7 +8,7 @@ dependencies: - numpy=1.* - matplotlib=3.* - pyproj>=3.4,<4 - - rasterio>=1.3,<1.4 + - rasterio>=1.3,<2 - scipy=1.* - tqdm - scikit-image=0.* diff --git a/requirements.txt b/requirements.txt index 6fced653..98df6ee8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,7 +6,7 @@ numba==0.* numpy==1.* matplotlib==3.* pyproj>=3.4,<4 -rasterio>=1.3,<1.4 +rasterio>=1.3,<2 scipy==1.* tqdm scikit-image==0.* From f8968dd39e855c1ca5770cf686f4b37dfa066aad Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Thu, 7 Nov 2024 14:58:20 -0900 Subject: [PATCH 02/14] First draft to introduce demcompare --- doc/source/_static/cnes_logo.svg | 225 +++++++++++++++++++++++++++++++ doc/source/_static/nasa_logo.svg | 1 + doc/source/about_xdem.md | 45 ++++++- doc/source/background.md | 30 +++-- doc/source/index.md | 13 +- doc/source/release_notes.md | 3 +- 6 files changed, 303 insertions(+), 14 deletions(-) create mode 100644 doc/source/_static/cnes_logo.svg create mode 100644 doc/source/_static/nasa_logo.svg diff --git a/doc/source/_static/cnes_logo.svg b/doc/source/_static/cnes_logo.svg new file mode 100644 index 00000000..9e3c6178 --- /dev/null +++ b/doc/source/_static/cnes_logo.svg @@ -0,0 +1,225 @@ + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/source/_static/nasa_logo.svg b/doc/source/_static/nasa_logo.svg new file mode 100644 index 00000000..58e9ce8c --- /dev/null +++ b/doc/source/_static/nasa_logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/source/about_xdem.md b/doc/source/about_xdem.md index 78b92163..1d9bc808 100644 --- a/doc/source/about_xdem.md +++ b/doc/source/about_xdem.md @@ -22,12 +22,55 @@ It has three main focus points: Although modularity can sometimes hamper performance, we also aim to **preserve scalibility** as much as possible[^sn2]. -[^sn2]: Out-of-memory, parallelizable computations relying on Dask are planned for late 2024! +[^sn2]: Out-of-memory, parallelizable computations relying on Dask are planned for 2025! We particularly take to heart to verify the accuracy of our methods. For instance, our terrain attributes which have their own modular Python-based implementation, are tested to match exactly [gdaldem](https://gdal.org/programs/gdaldem.html) (slope, aspect, hillshade, roughness) and [RichDEM](https://richdem.readthedocs.io/en/latest/) (curvatures). +## Who uses xDEM? + +xDEM was created by a group of glaciologists with expertise in elevation data analysis for change detection. + +Nowadays, it is developed and used by scientists across various fields of Earth observation science, and in projects of +space agencies such as CNES and NASA. + +```{note} +:class: tip +:class: margin + +xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demcompare)** to combine the best of both tools into one! +``` + +::::{grid} +:reverse: +:gutter: 1 1 +:margin: 1 1 + +:::{grid-item} +:columns: 5 +:child-align: center + +```{image} ./_static/nasa_logo.svg + :width: 200px +``` + +::: + + +:::{grid-item} +:columns: 5 +:child-align: center + +```{image} ./_static/cnes_logo.svg + :width: 200px +``` + +::: + + +:::: + More details about the people behind xDEM and the package's objectives can be found on the **{ref}`background` reference page**. diff --git a/doc/source/background.md b/doc/source/background.md index ba7e3081..777747c9 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -6,25 +6,39 @@ Below, some more information on the people behind the package, and its mission. ## The people behind xDEM +### Creation + ```{margin} -2More on our GlacioHack founder at [adehecq.github.io](https://adehecq.github.io/)! +1More on our GlacioHack founder at [adehecq.github.io](https://adehecq.github.io/)! ``` xDEM was created during the **[GlacioHack](https://github.com/GlacioHack) hackathon**, that was initiated by -Amaury Dehecq2 and took place online on November 8, 2020. +Amaury Dehecq1 and took place online on November 8, 2020. ```{margin} -3Check-out [glaciology.ch](https://glaciology.ch) on our founding group of VAW glaciology! +2Check-out [glaciology.ch](https://glaciology.ch) on our founding group of VAW glaciology! ``` The initial core development of xDEM was performed by members of the Glaciology group of the Laboratory of Hydraulics, Hydrology and -Glaciology (VAW) at ETH Zürich3, with contributions by members of the University of Oslo, the University of Washington, and University +Glaciology (VAW) at ETH Zürich2, with contributions by members of the University of Oslo, the University of Washington, and University Grenoble Alpes. -We are not software developers but geoscientists, and we try our best to offer tools that can be useful to a larger group, -documented, reliable and maintained. All development and maintenance is made on a voluntary basis and we welcome -any new contributors! See some information on how to contribute in the dedicated page of our -[GitHub repository](https://github.com/GlacioHack/xdem/blob/main/CONTRIBUTING.md). +### Current team + +The current lead development team includes **researchers in Earth observation and engineers from +[CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data, for analysis in Earth science or +for operational use for 3D satellite missions. + +Volunteers contributors span various backgrounds, in industry or research. We welcome +any new contributors! See how to contribute on [the dedicated page of our repository](https://github.com/GlacioHack/xdem/blob/main/CONTRIBUTING.md). + +### Funding acknowledgments + +Members of the lead development team acknowledge funding from: +- SNF (Swiss National Science Foundation), grant no. 184634, project by MeteoSwiss in the framework of the Global Climate Observing System Switzerland, +- NASA, grant no. xxx, Surface Topography and Vegetation project on the fusion of elevation data, +- NASA, grant no. xxx, ICESat-2 project on the efficient processing of elevation data in the cloud, +- CNES (French Space Agency): ?. ## Mission diff --git a/doc/source/index.md b/doc/source/index.md index 87b7c4f5..25bdb552 100644 --- a/doc/source/index.md +++ b/doc/source/index.md @@ -30,11 +30,16 @@ xDEM aims at making the analysis of digital elevation models **easy**, **modular :::: -```{important} +:::{admonition} Announcement +:class: tip :class: margin -xDEM ``v0.1`` is released, with nearly all features planned 4 years ago 🎉! We are now adding an **Xarray accessor**, and re-structuring the "Uncertainty" features for 2025. Note the version you are -working on for reproducibility! -``` + +xDEM `v0.1` is released, with all core features envisioned at creation 4 years ago 🎉! + +We are **merging efforts with [demcompare](https://github.com/CNES/demcompare)** to combine the best of both tools into one! + +We are working on **adding a ``dem`` Xarray accessor** with native Dask support for 2025. +::: xDEM is **tailored to perform quantitative analysis that implicitly understands the intricacies of elevation data**, both from a **georeferencing viewpoint** (vertical referencing, nodata values, projection, pixel interpretation) and diff --git a/doc/source/release_notes.md b/doc/source/release_notes.md index 5aab8d04..2fcb41c7 100644 --- a/doc/source/release_notes.md +++ b/doc/source/release_notes.md @@ -4,7 +4,7 @@ Below, the release notes for all minor versions and our roadmap to a first major ## 0.1.0 -xDEM 0.1.0 is the **first minor release** since the creation of the project in 2020. It is the result of years of work +xDEM version 0.1 is the **first minor release** since the creation of the project in 2020. It is the result of years of work to consolidate and re-structure features into a mature and stable API to minimize future breaking changes. **All the core features drafted at the start of the project are now supported**, and there is a **clear roadmap @@ -44,6 +44,7 @@ We have added warnings throughout the documentation and API related to planned d Changes related to **gap-filling** and **uncertainty analysis** will have deprecation warnings, while the function remain available during a few more releases. +(migrate-early)= ### Migrate from early versions The following changes **might be required to solve breaking changes**, depending on your early-development version: From b047294b210322c12f471a14bb63c43acd5ce085 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Thu, 7 Nov 2024 15:23:14 -0900 Subject: [PATCH 03/14] Add SNSF logo and streamline statements --- doc/source/_static/snsf_logo.svg | 132 +++++++++++++++++++++++++++++++ doc/source/about_xdem.md | 26 ++++-- doc/source/background.md | 49 +++++++++++- 3 files changed, 196 insertions(+), 11 deletions(-) create mode 100644 doc/source/_static/snsf_logo.svg diff --git a/doc/source/_static/snsf_logo.svg b/doc/source/_static/snsf_logo.svg new file mode 100644 index 00000000..68cc9738 --- /dev/null +++ b/doc/source/_static/snsf_logo.svg @@ -0,0 +1,132 @@ + + + +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/source/about_xdem.md b/doc/source/about_xdem.md index 1d9bc808..13114603 100644 --- a/doc/source/about_xdem.md +++ b/doc/source/about_xdem.md @@ -31,10 +31,11 @@ which have their own modular Python-based implementation, are tested to match ex ## Who uses xDEM? -xDEM was created by a group of glaciologists with expertise in elevation data analysis for change detection. +xDEM was created by a group of researchers with expertise in elevation data analysis for change detection **applied to glaciology**. -Nowadays, it is developed and used by scientists across various fields of Earth observation science, and in projects of -space agencies such as CNES and NASA. +Nowadays, its development is **jointly led by researchers in elevation data analysis** (including funding from NASA and SNSF) **and +engineers from CNES** (French Space Agency). +It is used by scientists or industrials across various fields of Earth observation. ```{note} :class: tip @@ -45,11 +46,11 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco ::::{grid} :reverse: -:gutter: 1 1 -:margin: 1 1 +:gutter: 1 1 1 +:margin: 1 1 1 :::{grid-item} -:columns: 5 +:columns: 4 :child-align: center ```{image} ./_static/nasa_logo.svg @@ -58,9 +59,18 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco ::: +:::{grid-item} +:columns: 4 +:child-align: center + +```{image} ./_static/snsf_logo.svg + :width: 200px +``` + +::: :::{grid-item} -:columns: 5 +:columns: 4 :child-align: center ```{image} ./_static/cnes_logo.svg @@ -72,5 +82,5 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco :::: -More details about the people behind xDEM and the package's objectives can be found on the **{ref}`background` reference +More details about the people behind xDEM, funding sources, and the package's objectives can be found on the **{ref}`background` reference page**. diff --git a/doc/source/background.md b/doc/source/background.md index 777747c9..06f2590f 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -9,7 +9,7 @@ Below, some more information on the people behind the package, and its mission. ### Creation ```{margin} -1More on our GlacioHack founder at [adehecq.github.io](https://adehecq.github.io/)! +1More on our GlacioHack founder at [adehecq.github.io](https://adehecq.github.io/). ``` xDEM was created during the **[GlacioHack](https://github.com/GlacioHack) hackathon**, that was initiated by @@ -25,9 +25,13 @@ Grenoble Alpes. ### Current team +```{margin} +3More on CNES's 3D missions on the [C03D constellation page](https://cnes.fr/en/projects/co3d). +``` + The current lead development team includes **researchers in Earth observation and engineers from [CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data, for analysis in Earth science or -for operational use for 3D satellite missions. +for operational use for 3D satellite missions3. Volunteers contributors span various backgrounds, in industry or research. We welcome any new contributors! See how to contribute on [the dedicated page of our repository](https://github.com/GlacioHack/xdem/blob/main/CONTRIBUTING.md). @@ -35,11 +39,50 @@ any new contributors! See how to contribute on [the dedicated page of our reposi ### Funding acknowledgments Members of the lead development team acknowledge funding from: -- SNF (Swiss National Science Foundation), grant no. 184634, project by MeteoSwiss in the framework of the Global Climate Observing System Switzerland, +- SNSF (Swiss National Science Foundation), grant no. 184634, project by MeteoSwiss in the framework of the Global Climate Observing System Switzerland, - NASA, grant no. xxx, Surface Topography and Vegetation project on the fusion of elevation data, - NASA, grant no. xxx, ICESat-2 project on the efficient processing of elevation data in the cloud, - CNES (French Space Agency): ?. + +::::{grid} +:reverse: +:gutter: 1 1 1 +:margin: 1 1 1 + +:::{grid-item} +:columns: 4 +:child-align: center + +```{image} ./_static/nasa_logo.svg + :width: 200px +``` + +::: + +:::{grid-item} +:columns: 4 +:child-align: center + +```{image} ./_static/snsf_logo.svg + :width: 200px +``` + +::: + +:::{grid-item} +:columns: 4 +:child-align: center + +```{image} ./_static/cnes_logo.svg + :width: 200px +``` + +::: + + +:::: + ## Mission ```{epigraph} From cc938e64283da012ea219b1cb50279785a9ab9a9 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Thu, 7 Nov 2024 15:40:16 -0900 Subject: [PATCH 04/14] Streamline funding acknowledgments --- doc/source/background.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/background.md b/doc/source/background.md index 06f2590f..b5d89ed9 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -2,7 +2,7 @@ # Background -Below, some more information on the people behind the package, and its mission. +Below, some more information on the people behind the package, its funding sources, and its mission. ## The people behind xDEM @@ -26,7 +26,7 @@ Grenoble Alpes. ### Current team ```{margin} -3More on CNES's 3D missions on the [C03D constellation page](https://cnes.fr/en/projects/co3d). +3More on CNES's 3D missions on the [CO3D constellation page](https://cnes.fr/en/projects/co3d). ``` The current lead development team includes **researchers in Earth observation and engineers from @@ -36,12 +36,12 @@ for operational use for 3D satellite missions3. Volunteers contributors span various backgrounds, in industry or research. We welcome any new contributors! See how to contribute on [the dedicated page of our repository](https://github.com/GlacioHack/xdem/blob/main/CONTRIBUTING.md). -### Funding acknowledgments +## Funding acknowledgments Members of the lead development team acknowledge funding from: -- SNSF (Swiss National Science Foundation), grant no. 184634, project by MeteoSwiss in the framework of the Global Climate Observing System Switzerland, -- NASA, grant no. xxx, Surface Topography and Vegetation project on the fusion of elevation data, -- NASA, grant no. xxx, ICESat-2 project on the efficient processing of elevation data in the cloud, +- SNSF (Swiss National Science Foundation), grant no. 184634, a MeteoSwiss [GCOS](https://gcos.wmo.int/en/home) project, +- NASA, grant no. xxx, a [Surface Topography and Vegetation](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, +- NASA, grant no. xxx, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, - CNES (French Space Agency): ?. From 5848ace6874103235b138fe7006441299540af54 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Thu, 7 Nov 2024 15:41:24 -0900 Subject: [PATCH 05/14] Linting --- doc/source/_static/cnes_logo.svg | 74 ++++++++++++++++---------------- doc/source/_static/nasa_logo.svg | 2 +- doc/source/about_xdem.md | 4 +- doc/source/background.md | 2 +- 4 files changed, 41 insertions(+), 41 deletions(-) diff --git a/doc/source/_static/cnes_logo.svg b/doc/source/_static/cnes_logo.svg index 9e3c6178..027d4ba0 100644 --- a/doc/source/_static/cnes_logo.svg +++ b/doc/source/_static/cnes_logo.svg @@ -21,43 +21,43 @@ rdf:about="">image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file + diff --git a/doc/source/about_xdem.md b/doc/source/about_xdem.md index 13114603..20ecaae2 100644 --- a/doc/source/about_xdem.md +++ b/doc/source/about_xdem.md @@ -33,8 +33,8 @@ which have their own modular Python-based implementation, are tested to match ex xDEM was created by a group of researchers with expertise in elevation data analysis for change detection **applied to glaciology**. -Nowadays, its development is **jointly led by researchers in elevation data analysis** (including funding from NASA and SNSF) **and -engineers from CNES** (French Space Agency). +Nowadays, its development is **jointly led by researchers in elevation data analysis** (including funding from NASA and SNSF) **and +engineers from CNES** (French Space Agency). It is used by scientists or industrials across various fields of Earth observation. ```{note} diff --git a/doc/source/background.md b/doc/source/background.md index b5d89ed9..7f7e857e 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -30,7 +30,7 @@ Grenoble Alpes. ``` The current lead development team includes **researchers in Earth observation and engineers from -[CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data, for analysis in Earth science or +[CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data, for analysis in Earth science or for operational use for 3D satellite missions3. Volunteers contributors span various backgrounds, in industry or research. We welcome From 1b0da9a9c615f06254b5b91871197d9a8bd2ad35 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Thu, 7 Nov 2024 15:42:15 -0900 Subject: [PATCH 06/14] Revert changed copied when branching... --- dev-environment.yml | 2 +- environment.yml | 2 +- requirements.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/dev-environment.yml b/dev-environment.yml index fb682146..12e54a93 100644 --- a/dev-environment.yml +++ b/dev-environment.yml @@ -8,7 +8,7 @@ dependencies: - numpy=1.* - matplotlib=3.* - pyproj>=3.4,<4 - - rasterio>=1.3,<2 + - rasterio>=1.3,<1.4 - scipy=1.* - tqdm - scikit-image=0.* diff --git a/environment.yml b/environment.yml index 70613281..fc6901de 100644 --- a/environment.yml +++ b/environment.yml @@ -8,7 +8,7 @@ dependencies: - numpy=1.* - matplotlib=3.* - pyproj>=3.4,<4 - - rasterio>=1.3,<2 + - rasterio>=1.3,<1.4 - scipy=1.* - tqdm - scikit-image=0.* diff --git a/requirements.txt b/requirements.txt index 0d5001f8..cbdd66cb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,7 +6,7 @@ numba==0.* numpy==1.* matplotlib==3.* pyproj>=3.4,<4 -rasterio>=1.3,<2 +rasterio>=1.3,<1.4 scipy==1.* tqdm scikit-image==0.* From 0bee015854b5c1695e59964ca93eea7420ad04c2 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Thu, 7 Nov 2024 16:23:04 -0900 Subject: [PATCH 07/14] Add dark-light theme support for all logos --- doc/source/_static/cnes_logo_dark.svg | 230 ++++++++++++++++++++++++++ doc/source/_static/nasa_logo.svg | 53 +++++- doc/source/_static/snsf_logo_dark.svg | 132 +++++++++++++++ doc/source/about_xdem.md | 15 +- doc/source/background.md | 15 +- 5 files changed, 440 insertions(+), 5 deletions(-) create mode 100644 doc/source/_static/cnes_logo_dark.svg create mode 100644 doc/source/_static/snsf_logo_dark.svg diff --git a/doc/source/_static/cnes_logo_dark.svg b/doc/source/_static/cnes_logo_dark.svg new file mode 100644 index 00000000..103c8bb2 --- /dev/null +++ b/doc/source/_static/cnes_logo_dark.svg @@ -0,0 +1,230 @@ + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/source/_static/nasa_logo.svg b/doc/source/_static/nasa_logo.svg index 1d9c1caa..867b2a31 100644 --- a/doc/source/_static/nasa_logo.svg +++ b/doc/source/_static/nasa_logo.svg @@ -1 +1,52 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/source/_static/snsf_logo_dark.svg b/doc/source/_static/snsf_logo_dark.svg new file mode 100644 index 00000000..34ac8ca6 --- /dev/null +++ b/doc/source/_static/snsf_logo_dark.svg @@ -0,0 +1,132 @@ + + + +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/source/about_xdem.md b/doc/source/about_xdem.md index 20ecaae2..72896b30 100644 --- a/doc/source/about_xdem.md +++ b/doc/source/about_xdem.md @@ -46,8 +46,6 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco ::::{grid} :reverse: -:gutter: 1 1 1 -:margin: 1 1 1 :::{grid-item} :columns: 4 @@ -55,6 +53,7 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco ```{image} ./_static/nasa_logo.svg :width: 200px + :class: dark-light ``` ::: @@ -65,6 +64,12 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco ```{image} ./_static/snsf_logo.svg :width: 200px + :class: only-light +``` + +```{image} ./_static/snsf_logo_dark.svg + :width: 200px + :class: only-dark ``` ::: @@ -75,6 +80,12 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco ```{image} ./_static/cnes_logo.svg :width: 200px + :class: only-light +``` + +```{image} ./_static/cnes_logo_dark.svg + :width: 200px + :class: only-dark ``` ::: diff --git a/doc/source/background.md b/doc/source/background.md index 7f7e857e..47270f64 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -47,8 +47,6 @@ Members of the lead development team acknowledge funding from: ::::{grid} :reverse: -:gutter: 1 1 1 -:margin: 1 1 1 :::{grid-item} :columns: 4 @@ -56,6 +54,7 @@ Members of the lead development team acknowledge funding from: ```{image} ./_static/nasa_logo.svg :width: 200px + :class: dark-light ``` ::: @@ -66,6 +65,12 @@ Members of the lead development team acknowledge funding from: ```{image} ./_static/snsf_logo.svg :width: 200px + :class: only-light +``` + +```{image} ./_static/snsf_logo_dark.svg + :width: 200px + :class: only-dark ``` ::: @@ -76,6 +81,12 @@ Members of the lead development team acknowledge funding from: ```{image} ./_static/cnes_logo.svg :width: 200px + :class: only-light +``` + +```{image} ./_static/cnes_logo_dark.svg + :width: 200px + :class: only-dark ``` ::: From 9cec0d9d308482e6cbc6bef11ed3a19b873d9a94 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Thu, 7 Nov 2024 16:42:50 -0900 Subject: [PATCH 08/14] Enlarge slightly SNF logo and re-run RTD --- doc/source/about_xdem.md | 4 ++-- doc/source/background.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/about_xdem.md b/doc/source/about_xdem.md index 72896b30..1527b705 100644 --- a/doc/source/about_xdem.md +++ b/doc/source/about_xdem.md @@ -63,12 +63,12 @@ xDEM is **merging efforts with CNES's [demcompare](https://github.com/CNES/demco :child-align: center ```{image} ./_static/snsf_logo.svg - :width: 200px + :width: 220px :class: only-light ``` ```{image} ./_static/snsf_logo_dark.svg - :width: 200px + :width: 220px :class: only-dark ``` diff --git a/doc/source/background.md b/doc/source/background.md index 47270f64..fd4f5539 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -64,12 +64,12 @@ Members of the lead development team acknowledge funding from: :child-align: center ```{image} ./_static/snsf_logo.svg - :width: 200px + :width: 220px :class: only-light ``` ```{image} ./_static/snsf_logo_dark.svg - :width: 200px + :width: 220px :class: only-dark ``` From 5f3b5f0f9f32dd02685113bc8ccd20fe9a13a387 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Fri, 8 Nov 2024 10:48:10 -0900 Subject: [PATCH 09/14] Add ICESat-2 award --- doc/source/background.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/background.md b/doc/source/background.md index fd4f5539..a6f0bc33 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -40,8 +40,8 @@ any new contributors! See how to contribute on [the dedicated page of our reposi Members of the lead development team acknowledge funding from: - SNSF (Swiss National Science Foundation), grant no. 184634, a MeteoSwiss [GCOS](https://gcos.wmo.int/en/home) project, -- NASA, grant no. xxx, a [Surface Topography and Vegetation](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, -- NASA, grant no. xxx, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, +- NASA award , a [Surface Topography and Vegetation](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, +- NASA award 80NSSC20K0995, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, - CNES (French Space Agency): ?. From 31c75b5efab5d19dd089f781394c8be025a3c157 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Fri, 8 Nov 2024 13:47:45 -0900 Subject: [PATCH 10/14] Add NASA awards numbers --- doc/source/background.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/background.md b/doc/source/background.md index a6f0bc33..799c7029 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -40,7 +40,7 @@ any new contributors! See how to contribute on [the dedicated page of our reposi Members of the lead development team acknowledge funding from: - SNSF (Swiss National Science Foundation), grant no. 184634, a MeteoSwiss [GCOS](https://gcos.wmo.int/en/home) project, -- NASA award , a [Surface Topography and Vegetation](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, +- NASA award 80NSSC22K1094, a [Surface Topography and Vegetation](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, - NASA award 80NSSC20K0995, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, - CNES (French Space Agency): ?. From 11a3ca18a3639e3c4441e97f109ae046e3d1aae3 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Mon, 11 Nov 2024 13:23:21 -0900 Subject: [PATCH 11/14] Small adjustments --- doc/source/about_xdem.md | 4 ++-- doc/source/background.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/about_xdem.md b/doc/source/about_xdem.md index 1527b705..cc3555e3 100644 --- a/doc/source/about_xdem.md +++ b/doc/source/about_xdem.md @@ -31,11 +31,11 @@ which have their own modular Python-based implementation, are tested to match ex ## Who uses xDEM? -xDEM was created by a group of researchers with expertise in elevation data analysis for change detection **applied to glaciology**. +xDEM was created by a group of researchers with expertise in elevation data analysis for change detection applied to glaciology. Nowadays, its development is **jointly led by researchers in elevation data analysis** (including funding from NASA and SNSF) **and engineers from CNES** (French Space Agency). -It is used by scientists or industrials across various fields of Earth observation. +It is used by scientists or industrials **across various fields of Earth observation**. ```{note} :class: tip diff --git a/doc/source/background.md b/doc/source/background.md index 799c7029..15cfe063 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -30,17 +30,17 @@ Grenoble Alpes. ``` The current lead development team includes **researchers in Earth observation and engineers from -[CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data, for analysis in Earth science or -for operational use for 3D satellite missions3. +[CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data analysis, for application in Earth +science or for operational use for 3D satellite missions3. -Volunteers contributors span various backgrounds, in industry or research. We welcome +Other volunteer contributors span diverse scientific backgrounds in industry or research. We welcome any new contributors! See how to contribute on [the dedicated page of our repository](https://github.com/GlacioHack/xdem/blob/main/CONTRIBUTING.md). ## Funding acknowledgments Members of the lead development team acknowledge funding from: -- SNSF (Swiss National Science Foundation), grant no. 184634, a MeteoSwiss [GCOS](https://gcos.wmo.int/en/home) project, -- NASA award 80NSSC22K1094, a [Surface Topography and Vegetation](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, +- SNSF grant no. 184634, a MeteoSwiss [GCOS](https://gcos.wmo.int/en/home) project on elevation data analysis for glaciology, +- NASA award 80NSSC22K1094, an [STV](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, - NASA award 80NSSC20K0995, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, - CNES (French Space Agency): ?. From d643a451db3493b3030e2cd7951b7f148b24e1f6 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Mon, 11 Nov 2024 13:23:36 -0900 Subject: [PATCH 12/14] Linting --- doc/source/background.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/background.md b/doc/source/background.md index 15cfe063..97226142 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -30,7 +30,7 @@ Grenoble Alpes. ``` The current lead development team includes **researchers in Earth observation and engineers from -[CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data analysis, for application in Earth +[CNES](https://cnes.fr/en)** (French Space Agency). We specialize in elevation data analysis, for application in Earth science or for operational use for 3D satellite missions3. Other volunteer contributors span diverse scientific backgrounds in industry or research. We welcome From eec5a2c372bd700adb2e6d53913a99a8c87e5334 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Tue, 12 Nov 2024 17:40:42 -0900 Subject: [PATCH 13/14] Update award number IS2 --- doc/source/background.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/background.md b/doc/source/background.md index 97226142..1da2dcec 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -41,7 +41,7 @@ any new contributors! See how to contribute on [the dedicated page of our reposi Members of the lead development team acknowledge funding from: - SNSF grant no. 184634, a MeteoSwiss [GCOS](https://gcos.wmo.int/en/home) project on elevation data analysis for glaciology, - NASA award 80NSSC22K1094, an [STV](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, -- NASA award 80NSSC20K0995, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, +- NASA award 80NSSC23K0192, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, - CNES (French Space Agency): ?. From c673714c4b463d03a7c403268f741b46671e52e7 Mon Sep 17 00:00:00 2001 From: Romain Hugonnet Date: Fri, 15 Nov 2024 13:40:56 -0900 Subject: [PATCH 14/14] Account for Manu's comments --- doc/source/about_xdem.md | 7 ++++--- doc/source/background.md | 2 +- doc/source/release_notes.md | 5 +++-- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/source/about_xdem.md b/doc/source/about_xdem.md index cc3555e3..64b5334b 100644 --- a/doc/source/about_xdem.md +++ b/doc/source/about_xdem.md @@ -29,13 +29,14 @@ which have their own modular Python-based implementation, are tested to match ex [gdaldem](https://gdal.org/programs/gdaldem.html) (slope, aspect, hillshade, roughness) and [RichDEM](https://richdem.readthedocs.io/en/latest/) (curvatures). -## Who uses xDEM? +## Who is behind xDEM? xDEM was created by a group of researchers with expertise in elevation data analysis for change detection applied to glaciology. - Nowadays, its development is **jointly led by researchers in elevation data analysis** (including funding from NASA and SNSF) **and engineers from CNES** (French Space Agency). -It is used by scientists or industrials **across various fields of Earth observation**. + +Most contributors and users are scientists or industrials working in **various fields of Earth observation**. + ```{note} :class: tip diff --git a/doc/source/background.md b/doc/source/background.md index 1da2dcec..4e3d95e2 100644 --- a/doc/source/background.md +++ b/doc/source/background.md @@ -42,7 +42,7 @@ Members of the lead development team acknowledge funding from: - SNSF grant no. 184634, a MeteoSwiss [GCOS](https://gcos.wmo.int/en/home) project on elevation data analysis for glaciology, - NASA award 80NSSC22K1094, an [STV](https://science.nasa.gov/earth-science/decadal-surveys/decadal-stv/) project on the fusion of elevation data, - NASA award 80NSSC23K0192, an [ICESat-2](https://icesat-2.gsfc.nasa.gov/) project on the processing of elevation data in the cloud, -- CNES (French Space Agency): ?. +- CNES (French Space Agency) award on merging [demcompare](https://github.com/CNES/demcompare) and xDEM while further developing related 3D tools. ::::{grid} diff --git a/doc/source/release_notes.md b/doc/source/release_notes.md index 2fcb41c7..93151b87 100644 --- a/doc/source/release_notes.md +++ b/doc/source/release_notes.md @@ -65,9 +65,10 @@ Additionally, **some important yet non-breaking changes**: Based on recent and ongoing progress, we envision the following roadmap. **Releases of 0.2, 0.3, 0.4, etc**, for the following planned (ongoing) additions: +- The **addition of a command-line interface for features such as coregistration**, in the frame of the merging effort with [demcompare](https://github.com/CNES/demcompare), - The **addition of an elevation point cloud `EPC` data object**, inherited from the ongoing `PointCloud` object of GeoUtils alongside many features at the interface of point and raster, -- The **addition of an Xarray accessor `dem`** mirroring the `DEM` object, to work natively with Xarray objects and add support on out-of-memory Dask operations for most of xDEM's features, -- The **addition of an GeoPandas accessor `epc`** mirroring the `EPC` object, to work natively with GeoPandas objects, +- The **addition of a Xarray accessor `dem`** mirroring the `DEM` object, to work natively with Xarray objects and add support on out-of-memory Dask operations for most of xDEM's features, +- The **addition of a GeoPandas accessor `epc`** mirroring the `EPC` object, to work natively with GeoPandas objects, - The **re-structuration of uncertainty analysis features** to rely directly on SciKit-GStat's `Variogram` object. **Release of 1.0** once all these additions are fully implemented, and after feedback from the community.