Skip to content

Commit

Permalink
Reorganize credits into subsections
Browse files Browse the repository at this point in the history
  • Loading branch information
rhugonnet committed Dec 6, 2024
1 parent aedb3ae commit 33385e9
Show file tree
Hide file tree
Showing 9 changed files with 162 additions and 172 deletions.
27 changes: 6 additions & 21 deletions doc/source/authors.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,27 @@
---
file_format: mystnb
jupytext:
formats: md:myst
text_representation:
extension: .md
format_name: myst
kernelspec:
display_name: xdem-env
language: python
name: xdem
---
(authors)=

# Credits
## Authors

© 2024 **xDEM developers**.

**xDEM** is licensed under permissive Apache 2 license (See [LICENSE file](license.md)).
**xDEM** is licensed under permissive Apache 2 license (See [LICENSE file](license.md) or below).

All contributors listed in this document are part of the **xDEM developers**, and their
contributions are subject to the project's copyright under the terms of the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

This file keeps track of authors contributions.
This section keeps track of authors contributions.

---

## Development Lead
### Development lead

- **Romain Hugonnet** [@rhugonnet](https://github.com/rhugonnet) <romain.hugonnet@gmail.com>
- **Amaury Dehecq** [@adehecq](https://github/adehecq) <amaury.dehecq@univ-grenoble-alpes.fr>
- **Erik Schytt Mannerfelt** [@erikmannerfelt](https://github/erikmannerfelt)

---

## Contributors
### Contributors


- **Friedrich Knuth** [@friedrichknuth](https://github/friedrichknuth)
Expand All @@ -52,11 +39,9 @@ This file keeps track of authors contributions.
- **Amelie Froessl** [@ameliefroessl](https://github.com/ameliefroessl)
- **Simon Gascoin** [@sgascoin](https://github.com/sgascoin)

Update here with new contributors.

---

## Original Developers/Designers/Supporters
### Original developers

- **Romain Hugonnet** [@rhugonnet](https://github.com/rhugonnet) <romain.hugonnet@gmail.com>
- **Amaury Dehecq** [@adehecq](https://github/adehecq) <amaury.dehecq@univ-grenoble-alpes.fr>
Expand Down
133 changes: 0 additions & 133 deletions doc/source/background.md

This file was deleted.

4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

project = "xDEM"
copyright = "2024, xDEM developers"
author = "Erik Mannerfelt, Romain Hugonnet, Amaury Dehecq and others"
author = "Romain Hugonnet, Erik Mannerfelt, Amaury Dehecq and others"

# The full version, including alpha/beta/rc tags
release = xdem.__version__
Expand Down Expand Up @@ -178,7 +178,7 @@ def setup(app):
},
"announcement": (
"⚠️ Our 0.1 release refactored several early-development functions for long-term stability, "
'to update your code see <a href="https://github.com/GlacioHack/xdem/releases/tag/v0.1.0">here</a>. ⚠️'
'to update your code see the release notes. ⚠️'
),
}

Expand Down
12 changes: 12 additions & 0 deletions doc/source/credits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
(credits)=
# Credits and background

```{toctree}
:maxdepth: 2
history
mission
authors
funding
license
```
58 changes: 58 additions & 0 deletions doc/source/funding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
(funding)=
## Funding acknowledgments

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) award on merging [demcompare](https://github.com/CNES/demcompare) and xDEM while further developing related 3D tools.


::::{grid}
:reverse:

:::{grid-item}
:columns: 4
:child-align: center

```{image} ./_static/nasa_logo.svg
:width: 200px
:class: dark-light
```

:::

:::{grid-item}
:columns: 4
:child-align: center

```{image} ./_static/snsf_logo.svg
:width: 220px
:class: only-light
```

```{image} ./_static/snsf_logo_dark.svg
:width: 220px
:class: only-dark
```

:::

:::{grid-item}
:columns: 4
:child-align: center

```{image} ./_static/cnes_logo.svg
:width: 200px
:class: only-light
```

```{image} ./_static/cnes_logo_dark.svg
:width: 200px
:class: only-dark
```

:::


::::
44 changes: 44 additions & 0 deletions doc/source/history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
(history)=
# History

Below, some more information on the history behind the package.

## Creation

```{margin}
<sup>1</sup>More 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 Dehecq<sup>1</sup> and took place online on November 8, 2020.

```{margin}
<sup>2</sup>Check-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ürich<sup>2</sup>, with contributions by members of the University of Oslo, the University of Washington, and University
Grenoble Alpes.

## Joining effort with **demcompare**

In 2024, xDEM and [demcompare](https://github.com/CNES/demcompare) joined efforts in the perspective of
merging the best of both packages into one, and to jointly continue the development of new features for
analyzing elevation data with a larger expertise pool.

[demcompare](https://github.com/CNES/demcompare) is a tool developed by the CNES (French Space Agency) to
support its 3D satellite missions in analyzing elevation data, for instance from stereophotogrammetric DEMs
that can be generated with [CARS](https://github.com/CNES/cars).

## Current team

```{margin}
<sup>3</sup>More 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
[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 missions<sup>3</sup>.

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).
4 changes: 1 addition & 3 deletions doc/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,7 @@ release_notes
:maxdepth: 2
publis
background
authors
license
credits
```

# Indices and tables
Expand Down
14 changes: 1 addition & 13 deletions doc/source/license.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
---
file_format: mystnb
jupytext:
formats: md:myst
text_representation:
extension: .md
format_name: myst
kernelspec:
display_name: xdem-env
language: python
name: xdem
---
(license)=

# Apache License
# License

_Version 2.0, January 2004_
_&lt;<http://www.apache.org/licenses/>&gt;_
Expand Down
38 changes: 38 additions & 0 deletions doc/source/mission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
(mission)=
## Mission

```{epigraph}
The core mission of xDEM is to be **easy-of-use**, **modular** and **robust**.
It also attempts to be as **efficient**, **scalable** and **state-of-the-art** as possible.
Finally, as an open source package, it aspires to foster **reproducibility** and **open science**.
```

In details, those mean:

- **Ease-of-use:** all basic operations or methods from published works should only require a few lines of code to be performed;

- **Modularity:** all methods should be fully customizable, to allow both flexibility and inter-comparison;

- **Robustness:** all methods should be tested within our continuous integration test-suite, to enforce that they always perform as expected;

```{note}
:class: margin
**Scalability** is currently being improved towards a first major release ``v1.0``.
```

And, additionally:

- **Efficiency**: all methods should be optimized at the lower-level, to function with the highest performance offered by Python packages;

- **Scalability**: all methods should support both lazy processing and distributed parallelized processing, to work with high-resolution data on local machines as well as on HPCs;

- **State-of-the-art**: all methods should be at the cutting edge of remote sensing science, to provide users with the most reliable and up-to-date tools.

And finally:

- **Reproducibility:** all code should be version-controlled and release-based, to ensure consistency of dependent
packages and works;

- **Open-source:** all code should be accessible and reusable to anyone in the community, for transparency and open governance.

0 comments on commit 33385e9

Please sign in to comment.