Skip to content

Commit 47136ee

Browse files
committed
Template updates, README cleanup, add pixi.lock
1 parent 8e81fd9 commit 47136ee

4 files changed

Lines changed: 8809 additions & 23 deletions

File tree

README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pixi install --all
2323
For testing, simply run:
2424

2525
```shell
26-
pixi run test
26+
pixi run test-integration
2727
```
2828

2929
To view the documentation locally, use:
@@ -37,18 +37,5 @@ To test a minimal example of a workflow using this module:
3737
```shell
3838
pixi shell # activate this project's environment
3939
cd tests/integration/ # navigate to the integration example
40-
snakemake --use-conda # run the workflow!
40+
snakemake --use-conda --cores 2 # run the workflow!
4141
```
42-
43-
## Data sources and licenses
44-
45-
* [GEDTM30](https://github.com/openlandmap/GEDTM30) for slope
46-
* License: Creative Commons Attribution 4.0 International
47-
* [GlobCover land cover data](https://due.esrin.esa.int/page_globcover.php)
48-
* License: "You may use the GlobCover land cover map for educational and/or scientific purposes, without any fee on the condition that you credit ESA and the Université Catholique de Louvain as the source of the GlobCover products."
49-
* [GEBCO (General Bathymetric Chart of the Oceans)](https://www.gebco.net/data-products/gridded-bathymetry-data) 15 arc-second data
50-
* License: "The GEBCO Grid is placed in the public domain and may be used free of charge. [...] Users must: Acknowledge the source of The GEBCO Grid. A suitable form of attribution is given in the documentation that accompanies The GEBCO Grid."
51-
* [GHSL (Global Human Settlement Layer)](https://human-settlement.emergency.copernicus.eu/download.php) built-up surface data (R2023, GHS-BUILT-S, 100m resolution)
52-
* License: "The GHSL has been produced by the EC JRC as open and free data. Reuse is authorised, provided the source is acknowledged."
53-
* [WDPA (World Database on Protected Areas)](https://www.protectedplanet.net/)
54-
* License: Non-commercial allowed. Citation: "UNEP-WCMC and IUCN (2025), Protected Planet: The World Database on Protected Areas (WDPA) and World Database on Other Effective Area-based Conservation Measures (WD-OECM) [Online], June 2025, Cambridge, UK: UNEP-WCMC and IUCN. Available at: www.protectedplanet.net."

docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,17 @@
22

33
Welcome to the documentation of the `module_area_potentials` data module!
44
Please consult the [specification guidelines](./specification.md) and the [`clio` documentation](https://clio.readthedocs.io/) for more information.
5+
6+
7+
## Data sources
8+
9+
* [GEDTM30](https://github.com/openlandmap/GEDTM30) for slope
10+
* License: Creative Commons Attribution 4.0 International
11+
* [GlobCover land cover data](https://due.esrin.esa.int/page_globcover.php)
12+
* License: "You may use the GlobCover land cover map for educational and/or scientific purposes, without any fee on the condition that you credit ESA and the Université Catholique de Louvain as the source of the GlobCover products."
13+
* [GEBCO (General Bathymetric Chart of the Oceans)](https://www.gebco.net/data-products/gridded-bathymetry-data) 15 arc-second data
14+
* License: "The GEBCO Grid is placed in the public domain and may be used free of charge. [...] Users must: Acknowledge the source of The GEBCO Grid. A suitable form of attribution is given in the documentation that accompanies The GEBCO Grid."
15+
* [GHSL (Global Human Settlement Layer)](https://human-settlement.emergency.copernicus.eu/download.php) built-up surface data (R2023, GHS-BUILT-S, 100m resolution)
16+
* License: "The GHSL has been produced by the EC JRC as open and free data. Reuse is authorised, provided the source is acknowledged."
17+
* [WDPA (World Database on Protected Areas)](https://www.protectedplanet.net/)
18+
* License: Non-commercial allowed. Citation: "UNEP-WCMC and IUCN (2025), Protected Planet: The World Database on Protected Areas (WDPA) and World Database on Other Effective Area-based Conservation Measures (WD-OECM) [Online], June 2025, Cambridge, UK: UNEP-WCMC and IUCN. Available at: www.protectedplanet.net."

0 commit comments

Comments
 (0)