Merge branch 'develop' into feature_caliper_modifier

.flake8

@@ -0,0 +1,23 @@
+# -*- conf -*-
+# flake8 settings for thicket
+#
+# These are the flake8 settings recommended by Black
+# See https://github.com/psf/black
+#
+[flake8]
+max-line-length = 88
+select = C,E,F,W,B,B950
+ignore = E501,W503,E203
+builtins = IPython
+exclude =
+  .eggs,
+  .git,
+  .hg,
+  .mypy_cache,
+  .tox,
+  .venv,
+  _build,
+  buck-out,
+  build,
+  dist,
+  repo

.github/dependabot.yml

@@ -0,0 +1,6 @@
+versions: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/docs.yml

@@ -0,0 +1,62 @@
+name: Build & Deploy docs site to GitHub Pages
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+
+    - name: Setup Python
+      uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236
+      with:
+        python-version: '3.11'
+        cache: 'pip'
+        cache-dependency-path: '.github/workflows/requirements/docs.txt'
+
+    - name: Setup GitHub Pages
+      id: pages
+      uses: actions/configure-pages@f156874f8191504dae5b037505266ed5dda6c382
+
+    - name: Install Sphinx and Theme via Pip
+      run: |
+        pip install -r .github/workflows/requirements/docs.txt
+
+    - name: Build with sphinx
+      run: |
+        sphinx-build docs/ _build
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c
+      if: github.ref == 'refs/heads/develop'
+      with:
+        path: ./_build
+
+  deploy:
+    needs: build
+    if: github.ref == 'refs/heads/develop'
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@9dbe3824824f8a1377b8e298bafde1a50ede43e5

.github/workflows/format.yml

@@ -0,0 +1,30 @@
+name: Lint
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install black
+          pip install flake8
+
+      - name: Lint and Format Check with Flake8 and Black
+        run: |
+          black --diff --check .
+          flake8

.github/workflows/requirements/docs.txt

@@ -0,0 +1,3 @@
+# docs
+sphinx==7.2.6
+sphinx-rtd-theme==1.3.0

.gitignore

@@ -2,3 +2,6 @@
 *~
 \#*\#
 __pycache__
+_build
+spack.lock
+.spack-env

README.rst

@@ -1,6 +1,8 @@
-=========
-benchpark
-=========
+==================================================
+Benchpark 
+==================================================
+
+You can find detailed documentation in `ReadTheDocs <https://software.llnl.gov/benchpark>`_
 
 Benchpark is an open collaborative repository for reproducible specifications of HPC benchmarks.
 Benchpark enables cross-site collaboration on benchmarking by providing a mechanism for sharing
@@ -26,29 +28,20 @@ Dependencies
 ------------
 Benchpark uses the following open source projects for specifying configurations:
 
-* `Ramble <https://github.com/GoogleCloudPlatform/ramble>`_ ro specify run configurations
+* `Ramble <https://github.com/GoogleCloudPlatform/ramble>`_ to specify run configurations
 * `Spack <https://github.com/spack/spack>`_ to specify build configurations
 
-Documentation
--------------
-1. `About Benchpark <docs/about-benchpark.rst>`_
-2. `Getting started <docs/getting-started.rst>`_
-3. `Navigating Benchpark <docs/navigating-benchpark.rst>`_
-4. `Running a Benchmark <docs/running-a-benchmark.rst>`_
-5. `Adding a new System Config <docs/adding-a-system-config.rst>`_
-6. `Adding a new Benchmark <docs/adding-a-benchmark.rst>`_
-
 Community
 ---------
 Benchpark is an open source project.  Questions, discussion, and contributions 
-of new benchmarks and system specifications are welcome.
+of new benchmarks, experiments, and system specifications are welcome.
 We use `github discussions <https://github.com/llnl/benchpark/discussions>`_ for Q&A and discussion.
 
 Contributing
 ------------
 To contribute to Benchpark, please open a `pull request 
 <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_ 
-to the `main` branch.  Your PR must pass Benchpark's unit tests, and must be `PEP 8 <https://peps.python.org/pep-0008/>`_ compliant.
+to the `develop` branch.  Your PR must pass Benchpark's unit tests, and must be `PEP 8 <https://peps.python.org/pep-0008/>`_ compliant.
 
 Authors and citations
 ---------------------
@@ -68,6 +61,7 @@ ACM, New York, NY, USA, 9 pages.
 
 License
 -------
-Benchpark is released under the Apache 2.0 w/ LLVM Exception license. For more details see the [LICENSE](/LICENSE) file.
+Benchpark is released under the Apache 2.0 w/ LLVM Exception license. For more
+details see the [LICENSE](./LICENSE) file.
 
 LLNL-CODE-850629