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

Automatic Code Generator Docymentation(0-diff) #2413

Merged
merged 8 commits into from
Oct 26, 2023

Conversation

JulesKouatchou
Copy link
Contributor

Description

Documentation for the Automatic Code Generation

We included in the MAPL User's Guide a section on Automatic Code Generation.
It describes the steps users need to follow to take advantage of the tool MAPL_GridCompSpecs_ACG.py to automatically generate code segments for the registration and access of member variables of ESMF states of any gridded component.

Related Issue

Motivation and Context

The created document will allow users to simplify the code and avoid missing registration or declarations of fields.

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Trivial change (affects only documentation or cleanup)

Checklist:

  • I have tested this change with a run of GEOSgcm (if non-trivial)
  • I have added one of the required labels (0 diff, 0 diff trivial, 0 diff structural, non 0-diff)
  • I have updated the CHANGELOG.md accordingly following the style of Keep a Changelog

@JulesKouatchou JulesKouatchou requested review from a team as code owners October 23, 2023 16:35
@tclune
Copy link
Collaborator

tclune commented Oct 23, 2023

@JulesKouatchou I think this should be a merge to develop. That or you started from some non-main branch. Too many deltas in source code.

1. Corrected GEOS_MoistGRidComp.F90 to  GEOS_MoistGridComp.F90, and 2. Correct 'aet' to 'a set'.
@mathomp4
Copy link
Member

mathomp4 commented Oct 24, 2023

Indeed, I think this should have been onto develop. I'll try changing the base, though that might go...weird.

ETA: Nope. Changing the base was good. Looks much cleaner now

@mathomp4 mathomp4 changed the base branch from main to develop October 24, 2023 12:01
@mathomp4 mathomp4 added the 0 Diff Trivial The changes in this pull request are trivially zero-diff (documentation, build failure, &c.) label Oct 24, 2023
@mathomp4 mathomp4 merged commit 71e375a into develop Oct 26, 2023
@mathomp4 mathomp4 deleted the feature/jk/doc/code_generator branch October 26, 2023 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 Diff Trivial The changes in this pull request are trivially zero-diff (documentation, build failure, &c.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants