Skip to content

System install docs PR - #16

Open
cosmosquark wants to merge 5 commits into
masterfrom
docs2
Open

cosmosquark wants to merge 5 commits into
masterfrom
docs2

Conversation

@cosmosquark

@cosmosquark cosmosquark commented Mar 21, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Documents the Linux install paths and makes those installs match the program.

  • A local install copies AlphaGSM to ~/.local/lib/alphagsm, links ~/.local/bin/alphagsm, and reads alphagsm.conf in that install root.
  • A system install copies AlphaGSM to /usr/local/lib/alphagsm. Code under /usr reads /etc/alphagsm.conf. A new config sets the shared download account to alphagsm and stores the cache under /home/alphagsm/downloads.
  • Each operator's servers stay in that operator's home. The shared part is the program and the download cache.
  • Members of the alphagsm group can run alphagsm-downloads as the download account without a password. The sudoers file is checked with visudo.
  • The alphagsm command is a link to the copied program. The launcher follows that link so src imports succeed.
  • gitalphagsm runs git in the installed tree. /home/alphagsm/gitlive is only an empty directory for a separate checkout.
  • Running either installer again refreshes the copy and keeps an existing config file.
  • system-install-test runs the system installer in Ubuntu 24.04 and checks the layout, the second-run config, and alphagsm --help.

Guides:

Validation

  • bash -n on the install scripts and the container runner.
  • Workflow YAML parses.
  • Local installer in a temporary directory, then alphagsm --help through the new link.
  • bash ./system_install_tests/run_system_install_in_container.sh completed successfully on this machine. It does not change the host.

Dependabot was rejecting .github/dependabot.yml because package-ecosystem was blank. The file now schedules weekly updates for pip, GitHub Actions, and the Dockerfiles under docker/. Each ecosystem is grouped into one pull request. pyproject.toml is excluded because it only holds tool settings.

Keep the current guides and workflow, and retain the install scripts and pages from this branch.
A system install writes the shared downloader settings AlphaGSM reads and leaves each operator's servers in that operator's home. The alphagsm link now resolves to the real program so Python can find src.
The checked-in config left package-ecosystem blank, so GitHub rejected
.github/dependabot.yml. Weekly updates now cover pip, GitHub Actions,
and the runtime Dockerfiles, with one grouped pull request per ecosystem.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant