EAMxx: Update Dev Docs #7163
EAMxx: Update Dev Docs #7163
Conversation
mjschmidt271
added
Documentation
BFB
mjschmidt271
requested review from
bartgol,
AaronDonahue,
jaelynlitz and
mahf708
|
| ############################################################################### | ||
| ``` | ||
|
|
||
| #### Selected Useful Testing Options |
There was a problem hiding this comment.
I feel like I want this to be a bigger header so it doesn't get lost, my reaction was to ignore it since I wasn't running locally... Maybe that means adjusting the wording in L57 as well
There was a problem hiding this comment.
Good call--moved it upward and like it better!
| by modifying: environment variables, `PATH` or `[LD_]LIBRARY_PATH` | ||
| entries, configuration arguments, and compiler arguments as required. | ||
| As long as you do ***all of that*** perfectly, you should be just fine. | ||
| :sunglasses: |
There was a problem hiding this comment.
Need to add the emoji specs to the mkdocs.yaml in root
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svgThere was a problem hiding this comment.
Not only in components/eamxx/mkdocs.yml
(Also note the yaml vs yml 🤷)
There was a problem hiding this comment.
Good catch, and thanks for the tip! I hadn't noticed since I'd only been building from the EAMxx-root mkdocs.yml 🙄
| - Hence, the final `configure [...]` command (calling autoconf) is run | ||
| one directory above the directory in which it resides. |
There was a problem hiding this comment.
is that ${TPL_ROOT}/<lib-name>/ then? or are you saying from the library's build dir, run ../configure?
There was a problem hiding this comment.
Ah, yes. I reworded in an attempt to clarify--let me know if it reads more clearly!
| (mostly) more information is better than less. | ||
|
|
||
| ```{.shell .copy title="${eamxx_root}/scripts/machine_specs.py:[L58-L88]"} | ||
| from machines_specs import Machine |
There was a problem hiding this comment.
The import line belongs only in scream_mach_specs.py, not in the machine_specs.py file.
| concrete = True | ||
| @classmethod | ||
| def setup(cls): | ||
| super().setup_base("local") |
There was a problem hiding this comment.
It may be useful to remind that the name HAS to be "local", since test-all-eamxx -l looks for a machine called local.
|
Got the changes in--let me know if you'd like to see any further changes. Otherwise, I'll squash that final "PR comments" commit and then should be good to go! |
address linter error respond to PR comments
mjschmidt271
force-pushed
the
mjs/eamxx/docs-dev-guide-update
branch
from
a14f563 to
af658cf
Compare
|
@mjschmidt271 are you planning more work or should I integrate? |
|
@bartgol I'm all set--go right ahead! |
Adds TPLs page to Developer Guide and reorganizes Dev Quick-start. [BFB]
Adds TPLs page to Developer Guide and reorganizes Dev Quick-start.
[BFB]
This PR adds a page to the Developer Guide that describes the TPLs that are required for building and running EAMxx on a non-supported machine. It also provides some high-level instructions for what may be required to configure and install/build these TPLs.
Additionally, this PR reorganizes the Developer Quick-start Guide to first present information about target machines, before describing the build and test process.