Skip to content
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.

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

Add a section to the Developer's Guide to include an HLM-FATES API design document and standards/guidelines #54

Open
glemieux opened this issue Nov 17, 2023 · 0 comments
Labels
API Issue is related primarily FATES interfacing with the Host Land Model developer pertaining to the developer's guide enhancement Feature that improves the function of the guide outside of content

Comments

@glemieux
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
As we work to refactor the API over time, we should incorporate some documentation to define the design principles and guidelines.

Describe the solution you'd like
A single section with a design document should suffice.

Describe alternatives you've considered
We could explain the design outline in interface modules in the various HLMs, but I think it'd be better to have a single location describing the overall goal and any HLM-specific requirements to provide ease of maintenance.

Additional context
None

@glemieux glemieux added enhancement Feature that improves the function of the guide outside of content developer pertaining to the developer's guide API Issue is related primarily FATES interfacing with the Host Land Model labels Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Issue is related primarily FATES interfacing with the Host Land Model developer pertaining to the developer's guide enhancement Feature that improves the function of the guide outside of content
Projects
None yet
Development

No branches or pull requests

1 participant