Skip to content

Commit 7e63404

Browse files
committed
Update parcels._datasets docstring
1 parent 1a6a5f3 commit 7e63404

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

parcels/_datasets/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
This subpackage uses xarray to generate *idealised* structured and unstructured hydrodynamical datasets that are compatible with Parcels. The goals are three-fold:
55
6-
1. To provide users with documentation for the types of datasets they can expect Parcels to work with.
6+
1. To provide users with documentation for the types of datasets they can expect Parcels to work with. When reporting bugs, users can use these datasets to reproduce the bug they're experiencing (allowing developers to quickly troubleshoot the problem).
77
2. To supply our tutorials with hydrodynamical datasets.
88
3. To offer developers datasets for use in test cases.
99
@@ -36,8 +36,10 @@
3636
3737
This subpackage is broken down into structured and unstructured parts. Each of these have common submodules:
3838
39-
* ``circulation_model`` -> hardcoded datasets with the intention of mimicking datasets from a certain (ocean) circulation model
39+
* ``circulation_model`` -> hardcoded datasets with the intention of mimicking dataset structure from a certain (ocean) circulation model. If you'd like to see Parcel support a new model, please open an issue in our issue tracker.
40+
* exposes a dict ``datasets`` mapping dataset names to xarray datasets
4041
* ``generic`` -> hardcoded datasets that are generic, and not tied to a certain (ocean) circulation model. Instead these focus on the fundamental properties of the dataset
42+
* exposes a dict ``datasets`` mapping dataset names to xarray datasets
4143
* ``generated`` -> functions to generate datasets with varying properties
4244
* ``utils`` -> any utility functions necessary related to either generating or validating datasets
4345

0 commit comments

Comments
 (0)