Skip to content

Commit 35d9e26

Browse files
committed
Update ReadME
1 parent 6fd02a6 commit 35d9e26

4 files changed

Lines changed: 169 additions & 2 deletions

File tree

README.Rmd

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,83 @@ output: github_document
44

55
# Global atlas of mesoscale eddies and impact of forage fauna
66

7+
8+
<!-- badges: start -->
9+
10+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://choosealicense.com/licenses/mit/)
11+
<!-- badges: end -->
12+
13+
14+
![](figures/figure1_Paper.jpg)
15+
16+
717
## Overview
818

919
This project is dedicated to study the impact of mesoscale eddies on forage fauna at global scale. This GitHub repository provides the code of the Receveur et al. (2024) publication in Nature Communication.
1020

11-
## Overview
21+
## Data sources
22+
23+
![](figures/S1figure.jpg)
24+
25+
This project uses the following acoustic databases:
26+
27+
| Creator | Repository | Program | Area | References |
28+
| :-------------- | :------------------------------------------- | :------------------------ | :----: | :----: |
29+
| CSIRO, Australia|AODN| IMOS SOOP-BA| South Indian | Haris, K. et al. Sounding out life in the deep using acoustic data from ships of opportunity. Sci. Data 8, 23 (2021).|
30+
| IRD, France |SEANOE|NANSEM| Mozambique channel | SEANOE. Sea Open Scientific Data Publication. (2021).|
31+
| IRD, France | SEANOE | MICROTON | Mozambique channel| SEANOE. Sea Open Scientific Data Publication. (2021).|
32+
| IRD, France | SEANOE| MESOP |Mozambique channel | SEANOE. Sea Open Scientific Data Publication. (2021). |
33+
| IRD, France | SEANOE | PIRATA | Eastern tropical Atlantic| SEANOE. Sea Open Scientific Data Publication. (2021).|
34+
| BAS, United Kingdom |BODC|AMT, WCB | Atlantic|British Antarctic Survey - Natural Environment Research Council. Water column acoustic data collected in the Atlantic Ocean between 2006 and 2017. (2017). |
35+
| IMARPE, Peru |PANGAEA | Survey 0110-11 |Peruvian Humboldt Current System | IMARPE. Crucero de evaluación hidroacústica de recursos pelágicos BICs Humboldt, Olaya, SNP-2 y LP IMARPE IV 0110-11. (2004). |
36+
| UPMC, France |MESOPP | Themisto |South Indian | MESOPP. Mesopelagic Southern Ocean Prey and Predators.|
37+
| CSIC, Spain | PANGAEA | Malaspina | Circumnavigation 40°N-40°S | Irigoien, X. et al. The Simrad EK60 echosounder dataset from the Malaspina circumnavigation. Sci. Data 8, 259 (2021).|
38+
| Institute of Marine Research | IMR | One Ocean Expedition | Global | [link](https://ftp.nmdc.no/nmdc/IMR/OneOcean) |
39+
40+
41+
The global atlas of eddy trajectories is available here [link](https://www.aviso.altimetry.fr/en/data/products/value-added-products/global-mesoscale-eddy-trajectory-product/meta3-2-dt.html).
42+
43+
## Workflow
44+
45+
The analysis pipeline follows these steps:
46+
47+
1. Download eddy data
48+
2. Download acoustic data
49+
3. Overlap the two data sources to only keep acoustic data inside and around eddies
50+
4. Make and Export the Figures 1 and 2
51+
5. Compare inside acoustic values to outside acoustic values in each eddy
52+
6. Make and Export the Figures 3 and 4
53+
7. Compare the spatial distribution of the results with the previously published results
54+
55+
## Content
56+
57+
This repository is structured as follow:
58+
59+
- [`data/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/data): contains a sampled of data used in the article. The folder is split in two folders: [`data/raw/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/data/raw) to find a sample of all raw data (acoustic, eddy trajectories, chloro and sst) ; and [`data/intermediate/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/data/intermediate) with some intermediate .Rdata files, to make easily the Figures.
60+
61+
62+
- [`figures/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/figures): contains the figures used to validate et visualize the outputs.
63+
64+
65+
- [`scripts/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/scripts): contains R scripts to run the workflow. The order to run these scripts is explained in each name of files and follow the Workflow description.
66+
67+
68+
## Citation
69+
70+
Please use the following citation:
71+
72+
> Receveur A, Menkes C, Lengaigne M, Ariza A, Bertrand A, Dutheil C, Cravatte S, Allain A, Barbin L, Lebourges-Dhaussy A, Lehodey P, Nicol S. (2024) Code for "A rare oasis effect for forage fauna in oceanic eddies at the global scale." URL: <https://github.com/auroreRECE/eddy_micronecton/tree/main/>.
73+
74+
75+
76+
77+
## Contributing
78+
79+
All types of contributions are encouraged and valued.
80+
81+
## Acknowledgments
82+
83+
We acknowledge the Australian Integrated Marine Observing System (IMOS), the French National Research Institute for Sustainable Development (IRD), the British Antarctic Survey (BAS), the Peruvian Marine Institute (IMARPE), the Pierre and Marie Curie University (UPMC) and the Spanish National Research Council (CSIC) for their generous and invaluable contributions to the public acoustic databases used in the present study. We acknowledge Geir Pedersen for his help, and the cruise member of the One Ocean Expedition.
84+
85+
Aurore Receveur is part of the MAESTRO group co-funded by the Centre for the Synthesis and Analysis of Biodiversity (CESAB) of the Foundation for Research on Biodiversity (FRB), and by France Filière Pêche.
1286

README.md

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,103 @@
11

22
# Global atlas of mesoscale eddies and impact of forage fauna
33

4+
<!-- badges: start -->
5+
6+
[![License:
7+
MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://choosealicense.com/licenses/mit/)
8+
<!-- badges: end -->
9+
10+
![](figures/figure1_Paper.jpg)
11+
412
## Overview
513

614
This project is dedicated to study the impact of mesoscale eddies on
715
forage fauna at global scale. This GitHub repository provides the code
816
of the Receveur et al. (2024) publication in Nature Communication.
917

10-
## Overview
18+
## Data sources
19+
20+
![](figures/S1figure.jpg)
21+
22+
This project uses the following acoustic databases:
23+
24+
| Creator | Repository | Program | Area | References |
25+
|:-----------------------------|:-----------|:---------------------|:--------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------:|
26+
| CSIRO, Australia | AODN | IMOS SOOP-BA | South Indian | Haris, K. et al. Sounding out life in the deep using acoustic data from ships of opportunity. Sci. Data 8, 23 (2021). |
27+
| IRD, France | SEANOE | NANSEM | Mozambique channel | SEANOE. Sea Open Scientific Data Publication. (2021). |
28+
| IRD, France | SEANOE | MICROTON | Mozambique channel | SEANOE. Sea Open Scientific Data Publication. (2021). |
29+
| IRD, France | SEANOE | MESOP | Mozambique channel | SEANOE. Sea Open Scientific Data Publication. (2021). |
30+
| IRD, France | SEANOE | PIRATA | Eastern tropical Atlantic | SEANOE. Sea Open Scientific Data Publication. (2021). |
31+
| BAS, United Kingdom | BODC | AMT, WCB | Atlantic | British Antarctic Survey - Natural Environment Research Council. Water column acoustic data collected in the Atlantic Ocean between 2006 and 2017. (2017). |
32+
| IMARPE, Peru | PANGAEA | Survey 0110-11 | Peruvian Humboldt Current System | IMARPE. Crucero de evaluación hidroacústica de recursos pelágicos BICs Humboldt, Olaya, SNP-2 y LP IMARPE IV 0110-11. (2004). |
33+
| UPMC, France | MESOPP | Themisto | South Indian | MESOPP. Mesopelagic Southern Ocean Prey and Predators. |
34+
| CSIC, Spain | PANGAEA | Malaspina | Circumnavigation 40°N-40°S | Irigoien, X. et al. The Simrad EK60 echosounder dataset from the Malaspina circumnavigation. Sci. Data 8, 259 (2021). |
35+
| Institute of Marine Research | IMR | One Ocean Expedition | Global | [link](https://ftp.nmdc.no/nmdc/IMR/OneOcean) |
36+
37+
The global atlas of eddy trajectories is available here
38+
[link](https://www.aviso.altimetry.fr/en/data/products/value-added-products/global-mesoscale-eddy-trajectory-product/meta3-2-dt.html).
39+
40+
## Workflow
41+
42+
The analysis pipeline follows these steps:
43+
44+
1. Download eddy data
45+
2. Download acoustic data
46+
3. Overlap the two data sources to only keep acoustic data inside and
47+
around eddies
48+
4. Make and Export the Figures 1 and 2
49+
5. Compare inside acoustic values to outside acoustic values in each
50+
eddy
51+
6. Make and Export the Figures 3 and 4
52+
7. Compare the spatial distribution of the results with the previously
53+
published results
54+
55+
## Content
56+
57+
This repository is structured as follow:
58+
59+
- [`data/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/data):
60+
contains a sampled of data used in the article. The folder is split in
61+
two folders:
62+
[`data/raw/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/data/raw)
63+
to find a sample of all raw data (acoustic, eddy trajectories, chloro
64+
and sst) ; and
65+
[`data/intermediate/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/data/intermediate)
66+
with some intermediate .Rdata files, to make easily the Figures.
67+
68+
- [`figures/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/figures):
69+
contains the figures used to validate et visualize the outputs.
70+
71+
- [`scripts/`](https://github.com/auroreRECE/eddy_micronecton/tree/main/scripts):
72+
contains R scripts to run the workflow. The order to run these scripts
73+
is explained in each name of files and follow the Workflow
74+
description.
75+
76+
## Citation
77+
78+
Please use the following citation:
79+
80+
> Receveur A, Menkes C, Lengaigne M, Ariza A, Bertrand A, Dutheil C,
81+
> Cravatte S, Allain A, Barbin L, Lebourges-Dhaussy A, Lehodey P, Nicol
82+
> S. (2024) Code for “A rare oasis effect for forage fauna in oceanic
83+
> eddies at the global scale.” URL:
84+
> <https://github.com/auroreRECE/eddy_micronecton/tree/main/>.
85+
86+
## Contributing
87+
88+
All types of contributions are encouraged and valued.
89+
90+
## Acknowledgments
91+
92+
We acknowledge the Australian Integrated Marine Observing System (IMOS),
93+
the French National Research Institute for Sustainable Development
94+
(IRD), the British Antarctic Survey (BAS), the Peruvian Marine Institute
95+
(IMARPE), the Pierre and Marie Curie University (UPMC) and the Spanish
96+
National Research Council (CSIC) for their generous and invaluable
97+
contributions to the public acoustic databases used in the present
98+
study. We acknowledge Geir Pedersen for his help, and the cruise member
99+
of the One Ocean Expedition.
100+
101+
Aurore Receveur is part of the MAESTRO group co-funded by the Centre for
102+
the Synthesis and Analysis of Biodiversity (CESAB) of the Foundation for
103+
Research on Biodiversity (FRB), and by France Filière Pêche.

figures/S1figure.jpg

629 KB
Loading

figures/figure1_Paper.jpg

178 KB
Loading

0 commit comments

Comments
 (0)