Adding reanalysis data #211
Conversation
|
|
||
| ```{warning} | ||
| 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. | ||
| ``` |
There was a problem hiding this comment.
I'd think this can also occur between Reanalysis_interim and Analysis & Forecast. Maybe just drop the example: "which is possible..."?
There was a problem hiding this comment.
This doesn't occur in the case of between Reanalysis_interim and Analysis & Forecast because the product selection is determined by the end time in the schedule, and the Analysis & Forecast product spans back enough in time. To my understanding, it's only between the Reanalysis and Reanalysis_interim products where there is a discontinuity.
That being said, I agree the sentence leaves a bit of ambiguity. I'll update it - thank you! 👍
| # Additional information | ||
|
|
||
| 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). | ||
|
|
There was a problem hiding this comment.
I'd consider calling this Documentation. The quick start guide and tutorials should not be the main source of information in my opinion.
There was a problem hiding this comment.
Good point, thanks!
docs/user-guide/index.md
Outdated
| quickstart | ||
| tutorials/index | ||
| assignments/index | ||
| additional_information |
docs/user-guide/quickstart.md
Outdated
| ### Waypoint datetimes | ||
|
|
||
| ```{note} | ||
| 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)). |
| ctd_bgc_download_dict = { | ||
| "o2data": { | ||
| "dataset_id": "cmems_mod_glo_bgc-bio_anfc_0.25deg_P1D-m", | ||
| "dataset_id": select_product_id(**{**bgc_args, "variable": "o2"}), |
There was a problem hiding this comment.
Maybe use bgc here instead of select
There was a problem hiding this comment.
The select_product_id function is also used elsewhere to determine the physical product ID, so I'll leave it as it is. Unless I misunderstand what you're referring to here?
| ) | ||
|
|
||
| # handle the rare situation where start time and end time span different products, which is possible for reanalysis and reanalysis_interim | ||
| # in this case, return the analysis product which spans far back enough |
There was a problem hiding this comment.
Also an option for interim and analysis? Does it make sense to do this check first?
There was a problem hiding this comment.
From my view, running this check at the end minimises the number of copernicusmarine.open_dataset() calls required because it requires just one call to a specific predetermined product ID. Running the check before any product filtering would require multiple calls to different products to check their time limits, no?
j-atkins
requested review from
VeckoTheGecko and
ammedd
and removed request for
VeckoTheGecko
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.
This PR expands the range of Copernicus products available to
virtualship fetch. Reanalysis (and Reanalysis Interim) data are now available for both physical and biogeochemical data, in addition to the existing Analysis & Forecast products.fetchwill now automate the dataset selection based on the times in the expedition schedule (now available from 1993 through to two weeks into the future). Following on from #210, all data is now at daily resolution*.Following on from the Copernicus Marine documentation, I have incorporated the Reanalysis Interim products to maintain consistency between the Reanalysis and Analysis & Forecast products. In summary the three products cover the following periods:
*Note also, certain BGC variables (pH, phytoplankton) are only available as monthly products in hindcast and hindcast interim periods.
Given there are now quite a few different combinations of variables, time periods, temporal resolutions etc. I thought it would be helpful to explain this in the documentation, which I have now done (Additional information.md), for transparency on which products are employed when, in case this is ever important to users. There is now a reference to this in the quickstart guide as well.
To avoid complicating things further, the
CTD_BGCzooplankton variable is now dropped given its limited temporal range (~2024 onwards). If it's useful to keep this though I can add it back in and add warnings, documentation etc. to be clear that it's limited to this range.Tests for the new functionality also added, plus existing tests for the CLI and
fetchare updated.Closes #210