Merge pull request #421 from GoogleCloudPlatform/develop

Merge develop into main for v0.4.0 release

CLAs were all met at commit time.

Author: douglasjacobsen

.flake8

@@ -33,6 +33,7 @@ max-line-length = 99
 
 per-file-ignores =
   var/ramble/repos/*/application.py:F405,F821
+  var/ramble/repos/*/modifier.py:F405,F821
 
 # exclude things we usually do not want linting for.
 # These still get linted when passed explicitly, as when spack flake8 passes

.github/workflows/spelling.yaml

@@ -0,0 +1,19 @@
+name: ramble spelling
+
+on:
+  pull_request: []
+  push:
+    branches-ignore:
+    - main
+    - gh-pages
+
+jobs:
+  formatting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Check Spelling
+      uses: crate-ci/typos@548ac37a5de9ce84871bf4db3c9b8c462896d480 # v1.16.24
+      with:
+        files: ./lib/ramble/ramble ./lib/ramble/docs ./examples ./share ./bin ./etc ./var ./README.md
+        config: ./.typos.toml

.gitignore

@@ -2,3 +2,4 @@ __pycache__/
 *.x
 *.txt
 var/ramble/cache
+var/ramble/workspaces

.typos.toml

@@ -0,0 +1,25 @@
+[files]
+extend-exclude = [
+    ".git/",
+    # Copy of https://github.com/spack/spack/tree/develop/lib/spack
+    "lib/ramble/external/",
+    "lib/ramble/llnl/",
+    "lib/ramble/spack/",
+]
+ignore-hidden = false
+
+[default]
+extend-ignore-re = [
+    "\\bFOMs",
+]
+
+[default.extend-words]
+"fom" = "fom"
+"namd" = "namd"
+"reord" = "reord"
+
+[default.extend-identifiers]
+"ATPase" = "ATPase"
+"cachable" = "cachable"
+"clen" = "clen"
+"enable_deck_based_FOMs" = "enable_deck_based_FOMs"

LICENSE-APACHE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022-2023 Google LLC.
+   Copyright 2022-2024 Google LLC.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -27,13 +27,21 @@ e.g.
 
     $ pip install -r requirements.txt
 
+We recommend Python >= 3.7 for Ramble, but a best effort attempt is made to
+support Python 3.6 as it is used by older operating systems such as Centos7.
+Specifically, you might need to update `pip` and downgrade `protobuf` when
+using Python 3.6.
+
 Outside of these requirements, ramble requires an existing installation of
 spack for some application definition. See
 [Spack’s documentation](https://github.com/spack/spack#-spack) to install Spack.
 
 Documentation
 ----------------
 
+Ramble’s documentation can be viewed at
+[https://googlecloudplatform.github.io/ramble/](https://googlecloudplatform.github.io/ramble/).
+
 For help with Ramble’s commands, run `ramble help` or `ramble help --all`.
 
 For more information on concepts in Ramble, see Ramble’s

bin/ramble

@@ -1,5 +1,5 @@
 #!/bin/sh
-# Copyright 2022-2023 Google LLC
+# Copyright 2022-2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 # https://www.apache.org/licenses/LICENSE-2.0> or the MIT license

bin/ramble-python

@@ -1,4 +1,4 @@
-# Copyright 2022-2023 Google LLC
+# Copyright 2022-2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 # https://www.apache.org/licenses/LICENSE-2.0> or the MIT license

etc/ramble/defaults/config.yaml

@@ -14,14 +14,21 @@
 #   ~/.ramble/config.yaml
 # -------------------------------------------------------------------------
 config:
-    test_stage: ~/.ramble/test
-    locks: true
-    verify_ssl: true
-    connect_timeout: 10
-    checksum: true
-    shell: 'sh'
-    spack_flags:
-      install: '--reuse'
-      concretize: '--reuse'
-    input_cache: $ramble/var/ramble/cache
-    workspace_dirs: $ramble/var/ramble/workspaces
+  test_stage: ~/.ramble/test
+  locks: true
+  verify_ssl: true
+  connect_timeout: 10
+  checksum: true
+  shell: sh
+  input_cache: $ramble/var/ramble/cache
+  workspace_dirs: $ramble/var/ramble/workspaces
+  include_phase_dependencies: false
+  spack:
+    install:
+      flags: --reuse
+    concretize:
+      flags: --reuse
+    buildcache:
+      flags: ''
+    env_create:
+      flags: ''

etc/ramble/defaults/formatted_executables.yaml

@@ -0,0 +1,3 @@
+formatted_executables:
+  command:
+    join_separator: '\n'