File tree Expand file tree Collapse file tree
docs/user/environment/3-further Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -96,6 +96,39 @@ Instead of a custom dictionary, you can pass a built-in mapping name in the
9696- ``"MERRA2" ``
9797- ``"CMC" `` (for compatible datasets loaded explicitly)
9898
99+ What a mapping name means
100+ ^^^^^^^^^^^^^^^^^^^^^^^^^
101+
102+ - Base mapping names (for example ``"GFS" ``, ``"NAM" `` and ``"RAP" ``) map
103+ RocketPy weather keys to the current default variable naming used by the
104+ corresponding provider datasets.
105+ - These defaults are aligned with current shortcut workflows (for example,
106+ THREDDS-backed latest model sources) and may use projected coordinates
107+ (``x ``/``y `` plus ``projection ``) depending on the model.
108+
109+ Legacy mapping names
110+ ^^^^^^^^^^^^^^^^^^^^
111+
112+ If you are loading archived or older NOMADS-style datasets, use the explicit
113+ legacy aliases:
114+
115+ - ``"GFS_LEGACY" ``
116+ - ``"NAM_LEGACY" ``
117+ - ``"NOAA_LEGACY" ``
118+ - ``"RAP_LEGACY" ``
119+ - ``"CMC_LEGACY" ``
120+ - ``"GEFS_LEGACY" ``
121+ - ``"HIRESW_LEGACY" ``
122+ - ``"MERRA2_LEGACY" ``
123+
124+ Legacy aliases primarily cover older variable naming patterns such as
125+ ``lev ``, ``tmpprs ``, ``hgtprs ``, ``ugrdprs `` and ``vgrdprs ``.
126+
127+ .. note ::
128+
129+ Mapping names are case-insensitive. For example,
130+ ``"gfs_legacy" `` and ``"GFS_LEGACY" `` are equivalent.
131+
99132For custom dictionaries, the canonical structure is:
100133
101134.. code-block :: python
You can’t perform that action at this time.
0 commit comments