Update deployment docs for mache.deploy - #987
Merged
Merged
Conversation
The docs were only partly updated when deployment moved to `./deploy.py`. Several places still described the old `conda/configure_compass_env.py` workflow or made claims that are no longer true: - The load script no longer reinstalls `compass` when sourced. It only checks the version and activates the pixi environment. The branch-switching guidance in the developer's quick start and the note on `building_docs.rst` were based on the old behavior, so rewrite them around the editable install that `./deploy.py` does. - `--prefix` is deprecated in favor of `--pixi-path`. - The troubleshooting page described conda solver errors and `spec-file*.txt`, neither of which pixi produces. - `[discovery]` uses `hostname_re` (through mache), not `hostname_contains`, and `[spack] modules_before/after` is no longer read by anything. Update the new-machine example and add `software_compiler`. - Anvil was removed from `compass/machines` and from mache but still had pages and rows in the supported-machines table. Remove them and add the missing `pm-gpu` row and a section on the developer's Perlmutter page. - The user's guide machine pages pointed to shared `load_latest_compass_*.sh` release scripts, which only the removed release-conda workflow produced. Point to the developer's guide instead, as the user's quick start already does. - The `utils/matrix` and `utils/e3sm_update` READMEs still called `configure_compass_env.py`. `setup_matrix.py` itself has not been ported (it reads `conda/logs/matrix.log`), so its README now says so. - The pasted load-script output in the RRM tutorial was from the old scripts. Also reword the "conda environment" comments in the machine config files that the docs quote, so the two stay in sync. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Collaborator
Author
TestingBuilt the docs locally with Posted by Claude Code on @xylar's behalf. The testing, analysis and wording above are AI-authored; please check them accordingly. |
xylar
added
bug
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes deployment docs that still described the old
./conda/configure_compass_env.pyworkflow or made claims that stopped being true with./deploy.py. The main one: the load script no longer reinstallscompasswhen sourced, so the branch-switching guidance in the developer's quick start was wrong and is rewritten around the editable install. Anvil (no longer in Compass or mache) is removed,pm-gpuis added to the supported-machines table, and the user's guide machine pages point to the developer's guide instead of sharedload_latest_compass_*.shscripts.For the reviewer:
compass/machines/*.cfgso the docs that quote them match.utils/matrix/setup_matrix.pystill readsconda/logs/matrix.log, which./deploy.pydoes not write. Its README now says so; porting the script is a follow-up.Checklist
Testingin this PR) any testing that was used to verify the changes🤖 Generated with Claude Code