Skip to content

Commit 62f140a

Browse files
committed
re-label copernicus product information as documentation, move away from user guide & tutorials
1 parent cf75a9e commit 62f140a

4 files changed

Lines changed: 12 additions & 9 deletions

File tree

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 & Documation <user-guide/index>
99
api/index
1010
contributing/index
1111
VirtualShip Website <https://virtualship.oceanparcels.org/>

docs/user-guide/additional_information.md renamed to docs/user-guide/documentation/copernicus_products.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
# Additional information
2-
3-
This file contains additional technical information and guidance not covered in the [Quickstart](https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html) guide or in the [Tutorials](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/index.html).
4-
5-
### Copernicus Marine products
1+
# Copernicus Marine products
62

73
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).
84

@@ -23,7 +19,7 @@ The ethos for automated dataset selection in `virtualship fetch` is to prioritis
2319
```
2420

2521
```{warning}
26-
In the rare situation where the start and end times of an expedition schedule span different products, 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.
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.
2723
```
2824

2925
### Data availability

docs/user-guide/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,12 @@
66
quickstart
77
tutorials/index
88
assignments/index
9-
additional_information
9+
```
10+
11+
# Documentation
12+
13+
```{toctree}
14+
:maxdepth: 1
15+
16+
documentation/copernicus_products.md
1017
```

docs/user-guide/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ For the underway ADCP, there is a choice of using the 38 kHz OceanObserver or th
8181
### Waypoint datetimes
8282

8383
```{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 [Additional information](additional_information.md)).
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)).
8585
```
8686

8787
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.

0 commit comments

Comments
 (0)