Skip to content

Commit 605c7bd

Browse files
committed
Prepare for publication
1 parent d41e772 commit 605c7bd

File tree

17 files changed

+94
-25
lines changed

17 files changed

+94
-25
lines changed

README.md

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@ EMODnet-Biology-Benthos-Interpolated-Maps/
3636
* **product** - Output product files: `netCDF` containing the gridded, probability fields and the corresponding figures in `PNG` or `JPG` format.
3737
* **scripts** - Reusable code: functions employed in the Jupyter notebooks.
3838

39-
## Data
39+
## Data series
4040

41-
The main data file is `spe.csv`, it contains all sampling events as rows, and the most frequent species (occurrence >200) as columns. The first columns specify sampling event and location. All columns are coded as __‘pa’__ (for presence/absence) followed by the `AphiaID` of the species. In the separate file `specieslist.csv` you find the names of the species corresponding to their `AphiaID`. You also find the total number of events where the species has been found.
41+
The input data was provided by [Herman et al (2020)](https://www.emodnet-biology.eu/data-catalog?module=dataset&dasid=6617). The main data file is `spe.csv`, it contains all sampling events as rows, and the most frequent species (occurrence >200) as columns. The first columns specify sampling event and location. All columns are coded as __‘pa’__ (for presence/absence) followed by the `AphiaID` of the species. In the separate file `specieslist.csv` you find the names of the species corresponding to their `AphiaID`. You also find the total number of events where the species has been found.
4242

4343
A species can have value __1__ (present), __0__ (looked for but absent) and __NA__ (not looked for). The NA values must be disregarded when making maps. They do not contain information about either presence or absence. There are NAs in the file because some datasets only look for a subset of species.
4444

4545
The information about the occurrence of a species is obtained with the function
4646
`read_coords_species` defined in the script [`BenthosInterp.jl`](scripts/BenthosInterp.jl). The species are selected by using the _AphiaID_.
4747

48-
## Analysis
48+
## Data product
4949

5050
This directory contains the notebooks for the preparation and analysis of the data, as well as the generation of the figures.
5151

@@ -67,43 +67,28 @@ If we have only presence data, the 2nd term of the denominator is zero and
6767
the probability reduces to the presence heatmap.
6868
The absence data decrease the ratio and hence the probability.
6969

70-
### Products
71-
72-
Two types of analysis are performed:
73-
1. Using a uniform correlation length all over the domain (0.1°) (directory `1-UniformL`)
74-
2. Using a spatially variable correlation length (see figure below), derives from the substrates (directory `2-VariableL`).
75-
76-
For both analysis, 2 types of products are created (described in the next section):
77-
1. Figures (`jpg` format).
78-
2. NetCDF files.
79-
80-
![variableL](product/figures/variableL.jpg)
81-
8270
### Jupyter notebooks
8371

8472
* [`interp_presence_absence_benthos`](analysis/interp_presence_absence_benthos.ipynb):
73+
8574
1. prepare the domain and the bathymetry,
8675
2. read the coordinates of presence and absence for each species,
8776
3. compute the probability map and the associated error field and
8877
4. write the results in a netCDF file (one per species and one global for all
89-
the species), in the directory `product/netCDF`
78+
the species), in the directory `product/netCDF`
9079

9180
* [`plot_results_map.ipynb`](analysis/plot_results_map.ipynb): notebook in `Python` to create the figures using the _ETRS89 Lambert Azimuthal Equal Area_ coordinate reference system of 2001 (`EPGS 3035`).
92-
The figures are stored in `product/figures` and consist of
81+
The figures are stored in `product/figures` and consist of
82+
9383
1. The interpolated probability map
9484
2. The relative error field
9585
3. The interpolated probability masked by the error field: for some species the
96-
computed probability displays high and non-realistic values, due to the ratio of very small (but different) values in regions without observations.
86+
computed probability displays high and non-realistic values, due to the ratio of very small (but different) values in regions without observations.
9787

9888
![Gridded field](product/figures/1-UniformL/Aequipecten_opercularis_density.jpg)
9989
![Error field](product/figures/1-UniformL/Aequipecten_opercularis_error.jpg)
10090

101-
### Code
102-
103-
The code, written in `Julia`, is distributed through GitHub:
104-
https://github.com/EMODnet/EMODnet-Biology-Benthos-Interpolated-Maps
105-
106-
#### Installation
91+
### Installation
10792

10893
You need Julia 1.5 (or later) available from https://julialang.org/downloads/.
10994
The following Julia packages required to run this code can be installed with:
@@ -118,20 +103,55 @@ Pkg.add("GridInterpolations")
118103
Pkg.add("Interpolations")
119104
Pkg.add("Missings")
120105
```
106+
121107
if plots are to be created with Julia, those packages are also required:
108+
122109
```julia
123110
Pkg.add("PyCall")
124111
Pkg.add("PyPlot")
125112
Pkg.add("Proj4")
126113
```
127114

128-
## Citation
115+
### Products
116+
117+
Two types of analysis are performed:
118+
1. Using a uniform correlation length all over the domain (0.1°) (directory `1-UniformL`)
119+
2. Using a spatially variable correlation length (see figure below), derives from the substrates (directory `2-VariableL`).
120+
121+
For both analysis, 2 types of products are created (described in the next section):
122+
1. Figures (`jpg` format).
123+
2. NetCDF files.
124+
125+
![variableL](product/figures/variableL.jpg)
126+
127+
## More information
128+
129+
### References
130+
131+
Barth, A., Beckers, J.-M., Troupin, C., Alvera-Azcárate, A., and Vandenbulcke, L.(2014): divand-1.0: *n*-dimensional variational data analysis for ocean observations, Geosci. Model Dev., 7, 225–241, https://doi.org/10.5194/gmd-7-225-2014.
132+
133+
Herman, P.M.J., Stolte, W., van der Heijden, L. 2020. Summary presence/absence maps of macro-endobenthos in the greater North Sea, based on nearly 100,000 samples from 65 assembled monitoring data sets. Integrated data products created under the European Marine Observation Data Network (EMODnet) Biology project (EASME/EMFF/2017/1.3.1.2/02/SI2.789013), funded by the European Union under Regulation (EU) No 508/2014 of the European Parliament and of the Council of 15 May 2014 on the European Maritime and Fisheries Fund. Available at: https://www.emodnet-biology.eu/data-catalog?module=dataset&dasid=6617
134+
135+
### Code and methodology
136+
137+
#### Code
138+
139+
The code, written in `Julia`, is distributed through GitHub:
140+
https://github.com/EMODnet/EMODnet-Biology-Benthos-Interpolated-Maps
141+
142+
### Citation and download link
129143

130144
Please cite this product as:
131145
*A. Barth, P. Hermann and C. Troupin (2020). Probability maps
132146
for different benthos species in the North Sea. Integrated data products created under the European Marine Observation Data Network (EMODnet) Biology project (EASME/EMFF/2017/1.3.1.2/02/SI2.789013), funded by the European Union under Regulation (EU) No 508/2014 of the European Parliament and of the Council of 15 May 2014 on the European Maritime and Fisheries Fund.*
133147

134148
The code is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
135149

150+
The product is available to download at: https://www.emodnet-biology.eu/data-catalog?module=dataset&dasid=6640
151+
152+
### Authors
153+
154+
[A. Barth](https://www.emodnet-biology.eu/data-catalog?module=person&persid=5344), [P. Hermann](https://www.emodnet-biology.eu/data-catalog?module=person&persid=79) and [C. Troupin](https://www.emodnet-biology.eu/data-catalog?module=person&persid=19092)
155+
136156
### Acknowledgement
137157
Computational resources have been provided by the *Consortium des Équipements de Calcul Intensif* (CÉCI), funded by the Fonds de la Recherche Scientifique de Belgique (F.R.S.-FNRS) under Grant No. 2.5020.11 and by the Walloon Region"

data/.gitkeep

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+

data/raw_data/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.pdf
2+
*.csv
File renamed without changes.

product/.gitkeep

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+

product/Heatmap/.gitkeep

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+

product/Heatmap/figures/.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Ignore images
2+
*.jpg
3+
*.png
4+
*.jpeg
5+
6+
7+
8+

product/Heatmap/figures/.gitkeep

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Ignore everything in this directory
2+
*
3+
# Except this file and gitkeep
4+
!.gitignore
5+
!.gitkeep
6+

product/Heatmap/figures/data/.gitkeep

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+

0 commit comments

Comments
 (0)