8000 Transitioning to an XML, Namelist, JSON, or other format for parameter file · Issue #1401 · NGEET/fates · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Transitioning to an XML, Namelist, JSON, or other format for parameter file #1401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
rgknox opened this issue May 2, 2025 · 3 comments
Open

Transitioning to an XML, Namelist, JSON, or other format for parameter file #1401

rgknox opened this issue May 2, 2025 · 3 comments
Labels
inputs: parameter file Pertaining to changes to the FATES parameter file software: API Pertaining to specific API updates with any host land model

Comments

@rgknox
Copy link
Contributor
rgknox commented May 2, 2025

While netcdf has its benefits, there are also benefits to storing parameter constants in other formats, such as XML, fortran namelist, json, or others. Use this space to plan this change.

Format Pros Cons
Netcdf fast binary/parallel IO requires compilation step
error checking conda has weak support
strong fortran support
XML high conda/python support too verbose (lots of tags)
simple python interpretation not strong fortran support
slower IO (text)
Namelist easy fortran implementation requires new python scripting
simple visual format units/dimensions/etc would be comment only
JSON like XML but less verbose less ubiquitous than xml, maybe less python support

Here is a design document that I started wtih @glemieux :

https://docs.google.com/document/d/1ufKlQzQAtBQLFwICfnv59Kp7QslgdUT2CIfuh0D5mIM/edit?usp=sharing
@rgknox
Copy link
Contributor Author
rgknox commented May 2, 2025

Note this is not part of the CLM6 milestone set, this is a longer term design plan (if implemented at all).

@glemieux
Copy link
Contributor
glemieux commented May 5, 2025 •
edited
Loading

All: Please use this as a "parent" issue to create sub-issues that work to address this larger task.

@glemieux glemieux added inputs: parameter file Pertaining to changes to the FATES parameter file software: API Pertaining to specific API updates with any host land model labels May 5, 2025
@rosiealice
Copy link
Contributor

Are there any examples, e.g. from other components, of what naelist and xml parameter files might look like? I feel like that might help us figure out whether our use case suits one or the other better. The most pressing thing is that our parameters can have multiple dimensions, and the format needs to be able to support that in a non-riduculous way :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
inputs: parameter file Pertaining to changes to the FATES parameter file software: API Pertaining to specific API updates with any host land model
Projects
FATES issue board
Status: ❕Todo
39D5
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rgknox @glemieux @rosiealice
0