Skip to content

Commit 75f13f1

Browse files
j-atkinsj-atkins
authored
Adding reanalysis data (#211)
Expands the range of Copernicus Marine Data products available to the fetch command. Reanalysis (and Reanalysis Interim) data are now available for both physical and biogeochemical data, in addition to the existing Analysis & Forecast products.
1 parent e4af072 commit 75f13f1

File tree

14 files changed

+351
-68
lines changed

14 files changed

+351
-68
lines changed

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:hidden:
66
77
Home <self>
8-
user-guide/index
8+
User Guide & Documentation <user-guide/index>
99
api/index
1010
contributing/index
1111
VirtualShip Website <https://virtualship.parcels-code.org/>

‎docs/user-guide/documentation/copernicus_products.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Copernicus Marine products
2+
3+
VirtualShip supports running experiments anywhere in the global ocean from 1993 through to the present day (and approximately two weeks into the future), using the suite of products available from the [Copernicus Marine Data Store](https://data.marine.copernicus.eu/products).
4+
5+
The data sourcing task is handled by the `virtualship fetch` command. The three products relied on by `fetch` to source data for all [VirtualShip instruments](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#Measurement-Options) (both physical and biogeochemical) are:
6+
7+
1. **Reanalysis** (or "hindcast" for biogeochemistry).
8+
2. **Renalysis interim** (or "hindcast interim" for biogeochemistry).
9+
3. **Analysis & Forecast**.
10+
11+
```{tip}
12+
The Copernicus Marine Service describe the differences between the three products in greater detail [here](https://help.marine.copernicus.eu/en/articles/4872705-what-are-the-main-differences-between-nearrealtime-and-multiyear-products).
13+
```
14+
15+
As a general rule of thumb the three different products span different periods across the historical period to present and are intended to allow for continuity across the previous ~ 30 years.
16+
17+
```{note}
18+
The ethos for automated dataset selection in `virtualship fetch` is to prioritise the Reanalysis/Hindcast products where possible (the 'work horse'), then _interim products where possible for continuity, and finally filling the very near-present (and near-future) temporal range with the Analysis & Forecast products.
19+
```
20+
21+
```{warning}
22+
In the rare situation where the start and end times of an expedition schedule span different products *and* there is no overlap in the respective dataset timeseries, which is possible in the case of the end time being in the **Reanalysis_interim** period and the start time in the **Reanalysis** period, the **Analysis & Forecast** product will be automatically selected, as this spans back enough in time for this niche case.
23+
```
24+
25+
### Data availability
26+
27+
The following tables summarise which Copernicus product is selected by `virtualship fetch` per combination of time period and variable (see legend below).
28+
29+
For biogeochemical variables `ph` and `phyc`, monthly products are required for hindcast and hindcast interim periods. For all other variables, daily products are available.
30+
31+
#### Physical products
32+
33+
| Period | Product ID | Temporal Resolution | Typical Years Covered | Variables |
34+
| :------------------ | :--------------------------------------- | :------------------ | :---------------------------------- | :------------------------- |
35+
| Reanalysis | `cmems_mod_glo_phy_my_0.083deg_P1D-m` | Daily | ~30 years ago to ~5 years ago | `uo`, `vo`, `so`, `thetao` |
36+
| Reanalysis Interim | `cmems_mod_glo_phy_myint_0.083deg_P1D-m` | Daily | ~5 years ago to ~2 months ago | `uo`, `vo`, `so`, `thetao` |
37+
| Analysis & Forecast | `cmems_mod_glo_phy_anfc_0.083deg_P1D-m` | Daily | ~2 months ago to ~2 weeks in future | `uo`, `vo`, `so`, `thetao` |
38+
39+
---
40+
41+
#### Biogeochemical products
42+
43+
| Period | Product ID | Temporal Resolution | Typical Years Covered | Variables | Notes |
44+
| :---------------------------- | :----------------------------------------- | :------------------ | :---------------------------------- | :-------------------------------- | :------------------------------------- |
45+
| Hindcast | `cmems_mod_glo_bgc_my_0.25deg_P1D-m` | Daily | ~30 years ago to ~5 years ago | `o2`, `chl`, `no3`, `po4`, `nppv` | Most BGC variables except `ph`, `phyc` |
46+
| Hindcast (monthly) | `cmems_mod_glo_bgc_my_0.25deg_P1M-m` | Monthly | ~30 years ago to ~5 years ago | `ph`, `phyc` | Only `ph`, `phyc` (monthly only) |
47+
| Hindcast Interim | `cmems_mod_glo_bgc_myint_0.25deg_P1D-m` | Daily | ~5 years ago to ~2 months ago | `o2`, `chl`, `no3`, `po4`, `nppv` | Most BGC variables except `ph`, `phyc` |
48+
| Hindcast Interim (monthly) | `cmems_mod_glo_bgc_myint_0.25deg_P1M-m` | Monthly | ~5 years ago to ~2 months ago | `ph`, `phyc` | Only `ph`, `phyc` (monthly only) |
49+
| Analysis & Forecast (O2) | `cmems_mod_glo_bgc-bio_anfc_0.25deg_P1D-m` | Daily | ~2 months ago to ~2 weeks in future | `o2` | |
50+
| Analysis & Forecast (Chl) | `cmems_mod_glo_bgc-pft_anfc_0.25deg_P1D-m` | Daily | ~2 months ago to ~2 weeks in future | `chl`, `phyc` | |
51+
| Analysis & Forecast (NO3/PO4) | `cmems_mod_glo_bgc-nut_anfc_0.25deg_P1D-m` | Daily | ~2 months ago to ~2 weeks in future | `no3`, `po4` | |
52+
| Analysis & Forecast (PH) | `cmems_mod_glo_bgc-car_anfc_0.25deg_P1D-m` | Daily | ~2 months ago to ~2 weeks in future | `ph` | |
53+
| Analysis & Forecast (NPPV) | `cmems_mod_glo_bgc-bio_anfc_0.25deg_P1D-m` | Daily | ~2 months ago to ~2 weeks in future | `nppv` | |
54+
55+
---
56+
57+
```{note}
58+
* "Typical Years Covered" are approximate and subject to change with new Copernicus data releases.
59+
* For the most up-to-date information, always consult the Copernicus Marine product documentation.
60+
* Certain BGC variables (`ph`, `phyc`) are only available as monthly products in hindcast and hindcast interim periods.
61+
```
62+
63+
##### CMEMS variables legend
64+
65+
| Variable Code | Full Variable Name | Category |
66+
| :------------ | :------------------------------------------------------------ | :------------- |
67+
| **uo** | Eastward Sea Water Velocity | Physical |
68+
| **vo** | Northward Sea Water Velocity | Physical |
69+
| **so** | Sea Water Salinity | Physical |
70+
| **thetao** | Sea Water Potential Temperature | Physical |
71+
| **o2** | Mole Concentration of Dissolved Molecular Oxygen in Sea Water | Biogeochemical |
72+
| **chl** | Mass Concentration of Chlorophyll a in Sea Water | Biogeochemical |
73+
| **no3** | Mole Concentration of Nitrate in Sea Water | Biogeochemical |
74+
| **po4** | Mole Concentration of Phosphate in Sea Water | Biogeochemical |
75+
| **nppv** | Net Primary Production of Biomass | Biogeochemical |
76+
| **ph** | Sea Water pH | Biogeochemical |
77+
| **phyc** | Mole Concentration of Phytoplankton | Biogeochemical |

‎docs/user-guide/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,11 @@ quickstart
77
tutorials/index
88
assignments/index
99
```
10+
11+
# Documentation
12+
13+
```{toctree}
14+
:maxdepth: 1
15+
16+
documentation/copernicus_products.md
17+
```

‎docs/user-guide/quickstart.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ For the underway ADCP, there is a choice of using the 38 kHz OceanObserver or th
8080

8181
### Waypoint datetimes
8282

83+
```{note}
84+
VirtualShip supports simulating experiments in the years 1993 through to the present day (and up to two weeks in the future) by leveraging the suite of products available Copernicus Marine Data Store (see [Fetch the data](#fetch-the-data)). The data download is automated based on the time period selected in the schedule. Different periods will rely on different products from the Copernicus Marine catalogue (see [Documentation](documentation/copernicus_products.md)).
85+
```
86+
8387
You will need to enter dates and times for each of the sampling stations/waypoints selected in the MFP route planning stage. This can be done under _Schedule Editor_ > _Waypoints & Instrument Selection_ in the planning tool.
8488

8589
Each waypoint has its own sub-panel for parameter inputs (click on it to expand the selection options). Here, the time for each waypoint can be inputted. There is also an option to adjust the latitude/longitude coordinates and you can add or remove waypoints.

‎docs/user-guide/tutorials/CTD_transects.ipynb‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"\n",
1010
"This notebook demonstrates a simple plotting exercise for CTD data across a transect, using the output of a VirtualShip expedition. There are example plots embedded at the end, but these will ultimately be replaced by your own versions as you work through the notebook.\n",
1111
"\n",
12-
"We can plot physical (temperature, salinity) or biogeochemical data (oxygen, chlorophyll, primary production, phyto/zoo-plankton, nutrients, pH) as measured by the VirtualShip `CTD` and `CTD_BGC` instruments, respectively.\n",
12+
"We can plot physical (temperature, salinity) or biogeochemical data (oxygen, chlorophyll, primary production, phytoplankton, nutrients, pH) as measured by the VirtualShip `CTD` and `CTD_BGC` instruments, respectively.\n",
1313
"\n",
1414
"The plot(s) we will produce are simple plots which follow the trajectory of the expedition as a function of distance from the first waypoint, and are intended to be a starting point for your analysis. \n",
1515
"\n",
@@ -93,7 +93,6 @@
9393
"- \"nitrate\"\n",
9494
"- \"phosphate\"\n",
9595
"- \"ph\"\n",
96-
"- \"zooplankton\"\n",
9796
"- \"phytoplankton\"\n",
9897
"- \"primary_production\"\n",
9998
"- \"chlorophyll\"\n",
@@ -126,7 +125,7 @@
126125
},
127126
{
128127
"cell_type": "code",
129-
"execution_count": 75,
128+
"execution_count": null,
130129
"id": "b32d2730",
131130
"metadata": {},
132131
"outputs": [],
@@ -162,11 +161,6 @@
162161
" \"label\": \"pH\",\n",
163162
" \"ds_name\": \"ph\",\n",
164163
" },\n",
165-
" \"zooplankton\": {\n",
166-
" \"cmap\": cmo.algae,\n",
167-
" \"label\": r\"Total zooplankton (mmol m$^{-3}$)\",\n",
168-
" \"ds_name\": \"zooc\",\n",
169-
" },\n",
170164
" \"phytoplankton\": {\n",
171165
" \"cmap\": cmo.algae,\n",
172166
" \"label\": r\"Total phytoplankton (mmol m$^{-3}$)\",\n",

0 commit comments

Comments
 (0)