Skip to content

Proposed format change for pcd.yaml#16

Open
rljacob wants to merge 12 commits intomasterfrom
rljacob/update-yaml-format
Open

Proposed format change for pcd.yaml#16
rljacob wants to merge 12 commits intomasterfrom
rljacob/update-yaml-format

Conversation

@rljacob
Copy link
Copy Markdown
Collaborator

@rljacob rljacob commented Jul 2, 2025

Instead of grouping constants by reference, define broader groups: mathematical, universal_physical, earth_physical, solar, water. This allows constants in each group to possibly be from different references. It also provides a more
physically intuitive high-level grouping.

Move all references to a section at top and then add as key in each constant.

Update CPCD parser to work with new format. Also change requests argument to be optional. Update Autoconf build to GNU Autoconf 2.72.

Add Python-based parser as another tool.

Update documentation to reflect changes to yaml file and CPCD parser and new python parser.

@rljacob
Copy link
Copy Markdown
Collaborator Author

rljacob commented Jul 2, 2025

This format was agreed on by E3SM developers interested in using pcd.yaml.

@rljacob
Copy link
Copy Markdown
Collaborator Author

rljacob commented Jul 9, 2025

After phone discussion with @rmontuoro : change "citation" to "reference" in entry for constant. Also make sure CPCD parser still works. Add python parser.

Instead of grouping contstants by reference, define
broader groups: mathematical, universal_physical, earth_physical,
solar, water.  This allows constants in each group to be from different references.

Move all references to a section at top and then add as key in each
constant.
Update build system to autoconf 2.72, aclocal 1.18.1
Update test req.yaml to refer to new format of pcd.yaml
Change citation to reference in the entries of pcd.yaml
@rljacob rljacob force-pushed the rljacob/update-yaml-format branch from 631d76a to f8534d8 Compare August 27, 2025 03:36
Add version and institution to output fortran file
Change URL for repo output as part of help
Update documentaiton to match changes
in yaml file
Make request file argument optional.  If not provided,
parser will convert all the constants in the pcd.yaml file
Add .gitnore files for cpcd to ignore build artifacts
Update docs to match changes in cpcd parser
@rljacob rljacob requested a review from rmontuoro September 19, 2025 05:47
@rljacob rljacob assigned rljacob and unassigned rmontuoro Sep 19, 2025
bartgol and others added 2 commits March 7, 2026 22:49
Add a python tool to generate a f90/cxx file from the pcd.yaml database
Add documentation for python parser
@rljacob
Copy link
Copy Markdown
Collaborator Author

rljacob commented Mar 8, 2026

@rmontuoro I finally added the python parser and updated the documentation. This is ready for final review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants