Skip to content

Commit b3891e9

Browse files
committed
Refactor CMORiser input parameter and add utility function for ocean file retrieval
- Updated the parameter name from `input_paths` to `input_data` in multiple instances of the ACCESS_ESM_CMORiser initialization within the Tutorial1 notebook. - Introduced a new utility function `get_monthly_ocean_files` in `utilities.py` to facilitate the retrieval of ocean model output files based on CMOR variable mappings, including error handling and warnings for missing files.
1 parent 88a80d8 commit b3891e9

5 files changed

Lines changed: 518 additions & 4931 deletions

File tree

docs/source/getting_started.rst

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,79 @@ After writing the file, we recommend validating it using [PrePARE](https://githu
161161
162162
cmoriser.write()
163163
164+
CMIP7 Support with Full Branded Names
165+
======================================
166+
167+
ACCESS-MOPPy also supports the new CMIP7 compound name format, which uses full branded names instead of the table.variable format used in CMIP6. CMIP7 introduces a more descriptive naming convention that includes detailed information about the data processing and grid specifications.
168+
169+
The CMIP7 format follows the pattern: ``realm.variable.operation.frequency.domain`` (e.g., ``atmos.tas.tavg-h2m-hxy-u.mon.glb``)
170+
171+
This provides more explicit information about:
172+
173+
- **Realm**: Model component (atmos, ocean, land, etc.)
174+
- **Variable**: The physical quantity
175+
- **Operation**: Temporal and spatial processing applied
176+
- **Frequency**: Data output frequency
177+
- **Domain**: Spatial domain specification
178+
179+
Using CMIP7 Compound Names
180+
---------------------------
181+
182+
Here's how to use CMIP7 compound names with ACCESS-MOPPy:
183+
184+
.. code-block:: python
185+
186+
# Example: CMIP7 compound name for atmospheric temperature
187+
cmip7_cmoriser = ACCESS_ESM_CMORiser(
188+
input_data=files, # Can reuse the same atmospheric files
189+
compound_name="atmos.tas.tavg-h2m-hxy-u.mon.glb", # CMIP7 full branded name
190+
experiment_id="piControl-spinup",
191+
source_id="pcmdi-test-1-0", # CMIP7 test source identifier
192+
variant_label="r1i1p1f1",
193+
grid_label="gn",
194+
activity_id="CMIP",
195+
parent_info=parent_experiment_config,
196+
cmip_version="CMIP7" # Explicit CMIP7 support
197+
)
198+
199+
# Display the CMIP7 variable mapping
200+
cmip7_cmoriser.variable_mapping
201+
202+
CMIP6 vs CMIP7 Compound Name Comparison
203+
----------------------------------------
204+
205+
The table below shows the key differences between CMIP6 and CMIP7 compound name formats:
206+
207+
.. list-table:: CMIP6 vs CMIP7 Compound Names
208+
:widths: 25 35 40
209+
:header-rows: 1
210+
211+
* - Aspect
212+
- CMIP6 Format
213+
- CMIP7 Format
214+
* - **Structure**
215+
- ``table.variable``
216+
- ``realm.variable.operation.frequency.domain``
217+
* - **Example**
218+
- ``Amon.tas``
219+
- ``atmos.tas.tavg-h2m-hxy-u.mon.glb``
220+
* - **Information**
221+
- Table and variable only
222+
- Detailed processing and grid info
223+
* - **Length**
224+
- Compact
225+
- More descriptive
226+
227+
**CMIP7 Compound Name Breakdown:**
228+
229+
- ``atmos``: Atmospheric realm
230+
- ``tas``: Near-surface air temperature
231+
- ``tavg-h2m-hxy-u``: Time-averaged, 2-meter height, horizontal grid, unstructured
232+
- ``mon``: Monthly frequency
233+
- ``glb``: Global domain
234+
235+
ACCESS-MOPPy automatically handles the mapping between these formats and the underlying model variables.
236+
164237
----
165238

166239
Batch Processing with PBS

0 commit comments

Comments
 (0)