Skip to content

Commit

Permalink
Add clarification about the two different options for weights.
Browse files Browse the repository at this point in the history
  • Loading branch information
jatkinson1000 committed Feb 18, 2025
1 parent e29aaee commit c844dfc
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,10 @@ Add the following lines:
If running a comparison to the ZM scheme also add `run_deep_comp = 'on'`.
2. `yog_nn_weights = '<PATH/TO/WEIGHTS.nc>'`\
The path to the NN weights in a NetCDF file.\
The weights are located at [`src/physics/cam/NN_weights_YOG_convection_no_yin_no_rad_dqpsubgrid.nc'](https://github.com/m2lines/CAM-ML/blob/docs-updates/src/physics/cam/NN_weights_YOG_convection_no_yin_no_rad_dqpsubgrid.nc).
Alternatively, they can be generated from the [standalone parametrerisation code](https://github.com/m2lines/convection-parameterization-in-CAM).
The options for weights included with the code are:
* Trained with microphysical conversion tendencies at subgrid scale (recommended) [`src/physics/cam/NN_weights_YOG_convection_no_yin_no_rad_dqpsubgrid.nc`](https://github.com/m2lines/CAM-ML/blob/docs-updates/src/physics/cam/NN_weights_YOG_convection_no_yin_no_rad_dqpsubgrid.nc).
* Trained with total tendency [`src/physics/cam/NN_weights_YOG_convection_no_yin_no_rad.nc`](https://github.com/m2lines/CAM-ML/blob/docs-updates/src/physics/cam/NN_weights_YOG_convection_no_yin_no_rad.nc).
Alternatively, weights can be generated from the [standalone parametrerisation code](https://github.com/m2lines/convection-parameterization-in-CAM).
3. `SAM_sounding = '<PATH/TO/SAM/SOUNDING.nc>'`\
The path to the SAM sounding NetCDF file for the parameterisation.\
This file is located at [src/physics/cam/SAM_sounding.nc](https://github.com/m2lines/CAM-ML/blob/docs-updates/src/physics/cam/SAM_sounding).\
Expand Down

0 comments on commit c844dfc

Please sign in to comment.