Skip to content

Pin a reproducible Python environment for Mac and HPC #15

Description

@esaran1

Why

Bare asla on at least one Mac resolved to an unrelated PlatformIO executable. HPC jobs that pick a different numpy/scipy than CI can change fits. Collaborators need one documented environment.

README already requires .venv and command -v asla. This issue is the lockfile / HPC pin, not rewriting that warning.

What to do

  1. Add a lockfile or requirements-lock.txt generated from pip freeze in CI, or document uv/conda env files.
  2. Confirm README still requires .venv and command -v asla pointing inside that venv.
  3. HPC checklist should use the same dependency versions as CI (Python 3.10/3.12).
  4. Optional: add a make env or scripts/bootstrap_env.sh.

Acceptance

  • Fresh clone + documented install produces asla --help from the venv script
  • CI versions are listed in the repo
  • HPC docs say how to avoid a colliding asla on PATH

Files

  • README.md
  • pyproject.toml
  • .github/workflows/ci.yml
  • hpc/ADAPTATION_CHECKLIST.md

Do not fabricate

  • Pin versions that were never actually used to generate a result

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions